docs: updated readme for C++ file and docstrings for surfPointClouds.py functions

Author: Jon-Ting

src/fbc/README.txt

@@ -26,8 +26,8 @@ Software:
 
 The test.cpp file can be compiled with the following command: > nvcc -O3 -o test bcCUDA4D.cu bcCUDA3D.cu bcCUDA2D.cu bcCPU.cpp test.cpp
 
-
 3. CITATION
+
 If Fast Box-Counting has been useful for your research, please, cite as:
 "Fast Computation of Fractal Dimension for 2D, 3D and 4D Data" 
 Juan Ruiz de Miras, Miguel Ángel Posadas, Antonio José Ibáñez-Molina, María Felipa Soriano and Sergio Iglesias-Parro

src/sphractal/constants.py

@@ -37,4 +37,3 @@
     'Sg': defRad, 'Bh': defRad, 'Hs': defRad, 'Mt': defRad, 'Ds': defRad, 'Rg': defRad, 'Cn': defRad, 'Nh': defRad,
     'Fl': defRad, 'Mc': defRad, 'Lv': defRad, 'Ts': defRad, 'Og': defRad
 }
-NN_RAD_MULT = 1.5  # Radius multiplier to identify nearest neighbour

src/sphractal/surfPointClouds.py

@@ -79,15 +79,15 @@ def pointsToVoxels(pointXYZs, gridSize):
 
 # @annotate('writeSurfVoxelIdxs', color='yellow')
 def writeSurfVoxelIdxs(writeFileDir, voxelIdxs):
-    """Generate *.txt file required for 3D box-counting using C++ code written by Ruiz de Miras and Posadas."""
+    """Generate a txt file required for 3D box-counting using C++ code written by Ruiz de Miras and Posadas."""
     with open(f"{writeFileDir}/surfVoxelIdxs.txt", 'w') as f:
         for idx in voxelIdxs:
             f.write(f"{idx}\n")
 
 
 # @annotate('writePCD', color='yellow')
 def writePCD(writeFileDir, npName, surfPointXYZs):
-    """Generate *.pcd file required for 3D box-counting using MATLAB code written by Kazuaki Iida."""
+    """Generate a pcd file required for 3D box-counting using MATLAB code written by Kazuaki Iida."""
     surfPointsDir = f"{writeFileDir}/surfPoints"
     if not isdir(surfPointsDir):
         mkdir(surfPointsDir)
@@ -101,7 +101,7 @@ def writePCD(writeFileDir, npName, surfPointXYZs):
 
 # @annotate('writeSurfPoints', color='blue')
 def writeSurfPoints(writeFileDir, npName, atomsSurfIdxs, atomsXYZ, surfPointXYZs, nonSurfPointXYZs):
-    """Generate *.xyz file for visualisation of classified point clouds."""
+    """Generate an xyz file for visualisation of classified point clouds."""
     surfPointsDir = f"{writeFileDir}/surfPoints"
     if not isdir(surfPointsDir):
         mkdir(surfPointsDir)
@@ -118,7 +118,7 @@ def writeSurfPoints(writeFileDir, npName, atomsSurfIdxs, atomsXYZ, surfPointXYZs
 
 # @annotate('writeSurfVoxels', color='green')
 def writeSurfVoxels(writeFileDir, npName, surfVoxelXYZs):
-    """Generate *.xyz file useful for visualisation of computed surface voxels."""
+    """Generate an xyz file useful for visualisation of computed surface voxels."""
     surfVoxelsDir = f"{writeFileDir}/surfVoxels"
     if not isdir(surfVoxelsDir):
         mkdir(surfVoxelsDir)