Added comments and removed print commands used for debugging

Author: lmalenfant

forward-solvers/fluence-of-rho-and-z-two-layer.py

@@ -58,27 +58,20 @@
 arrayOP = Array[Array[IOpticalPropertyRegion]]([opRegions])
 # predict the tissue's fluence(rho, z) for the given optical properties 
 fluenceOfRhoAndZ = solver.FluenceOfRhoAndZ(arrayOP, rhos, zs );
-#print("*********************************** FLUENCE *****************************************")
-#print(list(fluenceOfRhoAndZ))
 
 allRhos = np.concatenate((-rhos[::-1], rhos))
-print("*********************************** RHOS *****************************************")
-print(allRhos.tolist())
 
 # log transform
 log_fluence = [Math.Log(f) for f in fluenceOfRhoAndZ]
 
 size = len(zs)
 # split into rows
 fluenceRowsToPlot = np.array([log_fluence[i:i+size] for i in range(0, len(log_fluence), size)])
-#print("*********************************** FLUENCE ROWS TO PLOT *****************************************")
-#print(fluenceRowsToPlot)
 
 # reverse and concatenate
 allFluenceRowsToPlot = np.concatenate((fluenceRowsToPlot[::-1], fluenceRowsToPlot))
-#print("*********************************** ALL FLUENCE ROWS TO PLOT *****************************************")
-#print(allFluenceRowsToPlot.tolist())
 
+# Heatmap function to convert the data into a heat map
 def heatmap(values, x, y, x_label="", y_label="", title=""):
     """Create a heatmap chart."""
     # values should be a 2D array-like (list of lists or 2D numpy array)

forward-solvers/phd-of-rho-and-z-two-layer-compute-fluence.py

@@ -1,5 +1,7 @@
-# This is an example of python code using VTS to Compute fluence for a two-layer 
-# medium as a function of radial extent and depth at a given set of optical properties 
+# This is an example of python code using VTS to Compute photon hitting density for a two-layer 
+# medium at a given set of optical properties 
+# This sample uses ComputeFluence in place of calling FluenceOfRhoAndZ on the forward solver object
+# and it uses a distributed point source SDA Forward Solver
 #
 # Import PythonNet
 from pythonnet import load
@@ -56,8 +58,6 @@
 print(zs)
 
 allRhos = np.concatenate((-rhos[::-1], rhos))
-print("*********************************** RHOS *****************************************")
-print(allRhos.tolist())
 
 opRegionsArray = Array[Array[IOpticalPropertyRegion]]([opRegions])
 # predict the tissue's fluence(rho, z) for the given optical properties 
@@ -66,6 +66,7 @@
 independentValues = Array.CreateInstance(Array[Double], 2)
 independentValues[0] = Array[Double](allRhos.tolist())
 independentValues[1] = Array[Double](zs.tolist())
+# Call the static method ComputeFluence in ComputationFactory to get the fluence data 
 fluenceOfRhoAndZ = ComputationFactory.ComputeFluence(solver, FluenceSolutionDomainType.FluenceOfRhoAndZ, independentAxes, independentValues, opRegions, Array[Double](allRhos.tolist()))
 
 #PHD
@@ -83,6 +84,7 @@
 # split into rows
 phdRowsToPlot = np.array([log_phd[i:i+size] for i in range(0, len(log_phd), size)])
 
+# Heatmap function to convert the data into a heat map
 def heatmap(values, x, y, x_label="", y_label="", title=""):
     """Create a heatmap chart."""
     # values should be a 2D array-like (list of lists or 2D numpy array)

forward-solvers/phd-of-rho-and-z-two-layer.py

@@ -1,5 +1,5 @@
-# This is an example of python code using VTS to Compute fluence for a two-layer 
-# medium as a function of radial extent and depth at a given set of optical properties 
+# This is an example of python code using VTS to Compute photon hitting density for a two-layer 
+# medium at a given set of optical properties 
 #
 # Import PythonNet
 from pythonnet import load
@@ -59,31 +59,23 @@
 opRegionsArray = Array[Array[IOpticalPropertyRegion]]([opRegions])
 # predict the tissue's fluence(rho, z) for the given optical properties 
 fluenceOfRhoAndZ = solver.FluenceOfRhoAndZ(opRegionsArray, allRhos, zs );
-#print("*********************************** FLUENCE *****************************************")
-#print(list(fluenceOfRhoAndZ))
 
 #PHD
-print("*********************************** Fluence *****************************************")
-print('len(fluenceOfRhoAndZ)=',len(fluenceOfRhoAndZ))
 sourceDetectorSeparation = 10
 opArray = Array.CreateInstance(OpticalProperties, 2)
 opArray[0] = OpticalProperties(0.1, 1, 0.8, 1.4)
 opArray[1] = OpticalProperties(0.01, 1, 0.8, 1.4)
 
 phdOfRhoAndZ = ComputationFactory.GetPHD(solver, fluenceOfRhoAndZ, sourceDetectorSeparation, opArray, Array[Double](allRhos.tolist()), Array[Double](zs.tolist()))
 
-print("*********************************** RHOS *****************************************")
-print(allRhos.tolist())
-
 # log transform
 log_fluence = [Math.Log(f) for f in phdOfRhoAndZ]
 
 size = len(zs)
 # split into rows
 fluenceRowsToPlot = np.array([log_fluence[i:i+size] for i in range(0, len(log_fluence), size)])
-#print("*********************************** FLUENCE ROWS TO PLOT *****************************************")
-#print(fluenceRowsToPlot)
 
+# Heatmap function to convert the data into a heat map
 def heatmap(values, x, y, x_label="", y_label="", title=""):
     """Create a heatmap chart."""
     # values should be a 2D array-like (list of lists or 2D numpy array)