final touches to python examples and test

Author: joeljonsson

README.md

@@ -129,6 +129,8 @@ Example usage of the available functionality:
 | [Example_get_apr_from_file](./examples/python_examples/Example_get_apr_from_file.py) | create an APR from a TIFF and store as hdf5. |
 | [Example_reconstruct_image](./examples/python_examples/Example_reconstruct_image.py) | read in an APR and reconstruct a pixel image |
 
+Note that you may have to manually change the `sys.path.insert()` statements before `import pyApr` in these scripts to insert your build folder.
+
 ## Coming soon
 
 * more examples for APR-based filtering and segmentation

examples/python_examples/Example_get_apr_from_array.py

@@ -1,3 +1,5 @@
+# Joel Jonsson, 2018
+
 import os, sys
 import argparse
 import numpy as np

examples/python_examples/Example_get_apr_from_file.py

@@ -1,7 +1,8 @@
+# Joel Jonsson, 2018
+
 import os, sys
 import argparse
 
-
 sys.path.insert(0, "../../cmake-build-release")  #change this to your build folder
 import pyApr
 

examples/python_examples/Example_reconstruct_image.py

@@ -1,3 +1,5 @@
+# Joel Jonsson, 2018
+
 import os, sys
 import argparse
 import numpy as np

examples/python_examples/TIFFreadwrite.py

@@ -28,8 +28,8 @@ def writeTiff(fileName, array, compression=None):
 
 def readTiff(fileName):
     """
-    Read a tiff file into a ndarray
-    Usage: zstack = readTiff(inFileName)
+    Read a tiff file into a numpy array
+    Usage: img = readTiff(fileName)
     """
     tiff = TIFFfile(fileName)
     samples, sample_names = tiff.get_samples()

test/pythonTest.py

@@ -1,8 +1,11 @@
+# Joel Jonsson, 2018
+# Basic test of python functionality
+
 # Find path to script - all test files are kept there
 import os, sys
 myPath = os.path.dirname(os.path.abspath(__file__))
 
-# The test is run from the build folder, which is where the pyApr module is located
+# The script has to be run from the build folder, which is where the pyApr module is located
 sys.path.insert(0, os.getcwd())
 import pyApr
 
@@ -142,6 +145,7 @@ def main():
         print("**** failed ****")
 
     print('PASSED {}/8 TESTS'.format(successes))
+    assert successes == 8
 
 
 if __name__ == '__main__':