DOC: Add more explicit documentation for transform parameters

Add descriptions of the transform parameterizations.
thewtex · Apr 7, 2024 · ee160a9 · ee160a9
1 parent de3974c
commit ee160a9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/Modules/Core/Transform/include/itkEuler3DTransform.h b/Modules/Core/Transform/include/itkEuler3DTransform.h
@@ -38,8 +38,9 @@ namespace itk
  * the X, Y and Z axis. The last 3 parameters defines the translation in each
  * dimension.
  *
- * The serialization of the fixed parameters is an array of 3 elements defining
- * the center of rotation.
+ * The serialization of the fixed parameters is an array of 4 elements.
+ * The first 3 elements define the center of rotation.  The final
+ * element indicates the status of ComputeZYX (i.e. 1.0 if true, 0.0 if false).
  *
  * \ingroup ITKTransform
  */

diff --git a/Modules/Core/Transform/include/itkScaleTransform.h b/Modules/Core/Transform/include/itkScaleTransform.h
@@ -31,6 +31,10 @@ namespace itk
  * but with a large difference in performance since the affine transform will
  * use a matrix multiplication using a diagonal matrix.
  *
+ * The ND Parameters represent the scale in each dimension.
+ * The ND FixedParameters represent the fixed point (i.e. center point) from
+ * which scaling originates.
+ *
  * \ingroup ITKTransform
  *
  * \sphinx