From ee160a965798f80210c781c268023eed2212adb8 Mon Sep 17 00:00:00 2001 From: Hans Johnson Date: Sat, 6 Apr 2024 10:38:17 -0500 Subject: [PATCH] DOC: Add more explicit documentation for transform parameters Add descriptions of the transform parameterizations. --- Modules/Core/Transform/include/itkEuler3DTransform.h | 5 +++-- Modules/Core/Transform/include/itkScaleTransform.h | 4 ++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/Modules/Core/Transform/include/itkEuler3DTransform.h b/Modules/Core/Transform/include/itkEuler3DTransform.h index 11b235471f1..962f54bc159 100644 --- 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 index c1c0ef3bb0c..05dd1fee7a8 100644 --- 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