Merge pull request #133 from thewtex/filter-parameters

doc: Describe how to set filter parameters

Author: thewtex

docs/Quick_start_guide.rst

@@ -78,6 +78,15 @@ Some objects (matrix, vector, RGBPixel, ...) do not require the attribute `.New(
 
 In case of doubt, look at the attributes of the object you are trying to instantiate.
 
+Filter Parameters
+.................
+
+ITK filter parameters can be specified in the following ways:
+
+.. literalinclude:: code/FilterParameters.py
+   :lines: 10-
+
+
 Mixing ITK and NumPy
 --------------------
 

docs/code/FilterParameters.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python
+
+import itk
+import sys
+
+input_filename = sys.argv[1]
+
+image = itk.imread(input_filename, itk.F)
+
+# Pythonic snake case keyword arguments:
+#
+#   number_of_iterations
+#
+smoothed = itk.anti_alias_binary_image_filter(image,
+        number_of_iterations=3)
+
+# CamelCase keyword arguments:
+#
+#   NumberOfIterations
+#
+smoother = itk.AntiAliasBinaryImageFilter.New(image,
+        NumberOfIterations=3)
+smoother.Update()
+smoothed = smoother.GetOutput()
+
+# CamelCase Set method:
+#
+#   SetNumberOfIterations
+#
+smoother = itk.AntiAliasBinaryImageFilter.New(image)
+smoother.SetNumberOfIterations(3)
+smoother.Update()
+smoothed = smoother.GetOutput()

docs/code/testDriver.py

@@ -50,6 +50,9 @@ def cleanup(files):
 # Run test InstantiateITKObjects.py
 add_test(["InstantiateITKObjects.py"])
 
+# Run test FilterParameters.py
+add_test(["FilterParameters.py", baseline_image])
+
 # Run test MixingITKAndNumPy.py
 output_image = os.path.join(temp_folder, "filtered_image.png")
 add_test(["MixingITKAndNumPy.py", baseline_image, output_image])