Permalink
Browse files

Update README.textile

  • Loading branch information...
1 parent b54b607 commit 92adf8b962cf5d19c51642fd224c638bac59db42 @lantiga committed Jan 22, 2012
Showing with 1 addition and 2 deletions.
  1. +1 −2 README.textile
View
@@ -92,7 +92,6 @@ CMakeLists.txt
cyitk_generate_image_class("float" 2 F2)
cyitk_configure_module(${CYITK_MODULE_NAME} ${CYITK_MODULE_NAME}.pyx)
-
</code></pre>
The lines you should care about are
@@ -110,7 +109,7 @@ generate the Cython glue code based on the //@cytik comment in the GaussianSmoot
<code>
cyitk_generate_image_class("float" 2 F2)
</code>
-since the C++ function was operating on itk::Image<float,2>, we generate cyitk.ImageF2, the corresponding glue class. However, we could add a list of several image types here (limited to scalar images for now, but support for vector, tensor and multi-channel images is in the works).
+generate the cyitk glue Image classes. Since the C++ function was operating on itk::Image<float,2>, we generate cyitk.ImageF2, the corresponding glue class. However, we could add a list of several image types here (limited to scalar images for now, but support for vector, tensor and multi-channel images is in the works).
Note that the third argument is the suffix appended to cyitk.Image to generate the class name that will be made available in the Python module (i.e. cyitk.ImageF2, cyitk.ImageD3, etc). The suffix is free-form, just choose a sensible one.
In addition to the cyitk.ImageF2 class, this line will also generate a cyitk.ReadImageF2 function for I/O, which will rely on ITK I/O mechanisms (you get this one for free).

0 comments on commit 92adf8b

Please sign in to comment.