Skip to content

Commit 9cc0321

Browse files
zivydzenanz
authored andcommitted
DOC: Improve/correct TransformGeometryFilter documentation.
1 parent 4467236 commit 9cc0321

File tree

1 file changed

+21
-20
lines changed

1 file changed

+21
-20
lines changed

Modules/Core/Transform/include/itkTransformGeometryImageFilter.h

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -26,28 +26,29 @@
2626
namespace itk
2727
{
2828
/** \class TransformGeometryImageFilter
29-
* \brief Pseudo-Resample an image by modifying the geometric meta-data and not the pixels.
30-
*
31-
* The TransformGeometryImageFilter will generate a physical memory-modified version of
32-
* the input image if the input transform is not identity. Its neglectful use
33-
* can be a source of problems: e.g. it can exhaust the memory if the image is
34-
* very large, and it WILL reduce the image quality when there are lots of
35-
* transforms to be superimposed for the input image. Often times, we are not
36-
* interested in the intermediate transformed images.
37-
*
38-
* If all the transforms are rigid, there is a far superior way to achieve a similar result.
39-
* Updating image metadata in-place removes the accumulated resampling errors
40-
* as well as eliminating the expense of accessing the physical memory of the image.
41-
* We need to compose all the transforms beforehand to make use of this filter.
42-
*
43-
* \param \c RigidTransform Currently must be a VersorRigid3DTransform.
29+
* \brief Modify an image's geometric meta-data, changing its "physical" extent.
30+
*
31+
* The TransformGeometryImageFilter "physically" changes the image in
32+
* space using the given transformation. The
33+
* specific transformation type can be any type derived from the
34+
* MatrixOffsetTransformBase and the TranslationTransform.
35+
* The modification of the geometric meta-data is an alternative to
36+
* resampling the moving image onto the fixed image grid, after registration. The advantages of using
37+
* this approach over resampling are two-fold, it does not introduce artifacts
38+
* into the result because the original intensity information is not
39+
* modified, and it is computationally more efficient.
40+
*
41+
* When the filter is used with a rigid or translation transformation
42+
* the resulting image can be saved in any desired format. When the
43+
* filter is used with an affine transformation the resulting image
44+
* should be saved in a format that supports a non ortho-normal
45+
* direction cosine matrix (e.g. nrrd).
46+
*
47+
* \param \c Transform Any transform derived from MatrixOffsetTransformBase or TranslationTransform.
4448
* \param \c InputImage The image to be duplicated and modified to incorporate the
45-
* rigid transform.
49+
* transform.
4650
* \return An image with the same voxel values as the input, but with different
47-
* physical space representation affected by the rigid transform.
48-
*
49-
* The purpose of this class is to generate the new origin and direction
50-
* that will remove the need for using the transform.
51+
* physical space representation affected by the transform.
5152
*
5253
* Let us call the transform operation from the fixed image to moving image <tt>TfmF2M</tt>.
5354
* Given a set of points from the fixed image in physical space (i.e. <tt>physicalFixedImagePoints</tt>),

0 commit comments

Comments
 (0)