1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkScaleVersor3DTransform_h
#define itkScaleVersor3DTransform_h
#include "itkVersorRigid3DTransform.h"
namespace itk
{
/** \class ScaleVersor3DTransform
*
* \brief This transform applies a Versor rotation, translation and
* anisotropic scale to the space.
*
* The transform can be described as:
* \f$ (\textbf{R}_v + \textbf{S})\textbf{x} \f$ where \f$\textbf{R}_v\f$ is the
* rotation matrix given the versor, and
* \f$S=\left( \begin{array}{ccc}s_0-1 & 0 & 0 \\ 0 & s_1-1 & 0 \\ 0 & 0 & s_2-1 \end{array} \right)\ \f$
*
*
* \note This transform's scale parameters are not related to the
* uniform scaling parameter of the Similarity3DTransform.
*
* \author Johnson H.J., Harris G., Williams K. University of Iowa Carver
* College of Medicine, Department of Psychiatry NeuroImaging Center
*
* This implementation was taken from the Insight Journal paper:
* https://www.insight-journal.org/browse/publication/180
*
* \ingroup ITKTransform
*/
template <typename TParametersValueType = double>
class ITK_TEMPLATE_EXPORT ScaleVersor3DTransform : public VersorRigid3DTransform<TParametersValueType>
{
public:
ITK_DISALLOW_COPY_AND_MOVE(ScaleVersor3DTransform);
/** Standard class type aliases. */
using Self = ScaleVersor3DTransform;
using Superclass = VersorRigid3DTransform<TParametersValueType>;
using Pointer = SmartPointer<Self>;
using ConstPointer = SmartPointer<const Self>;
/** New macro for creation of through a Smart Pointer. */
itkNewMacro(Self);
/** \see LightObject::GetNameOfClass() */
itkOverrideGetNameOfClassMacro(ScaleVersor3DTransform);
/** Dimension of parameters. */
static constexpr unsigned int InputSpaceDimension = 3;
static constexpr unsigned int OutputSpaceDimension = 3;
static constexpr unsigned int ParametersDimension = 9;
/** Parameters Type */
using typename Superclass::ParametersType;
using typename Superclass::FixedParametersType;
using typename Superclass::JacobianType;
using typename Superclass::JacobianPositionType;
using typename Superclass::InverseJacobianPositionType;
using typename Superclass::ScalarType;
using typename Superclass::InputPointType;
using typename Superclass::OutputPointType;
using typename Superclass::InputVectorType;
using typename Superclass::OutputVectorType;
using typename Superclass::InputVnlVectorType;
using typename Superclass::OutputVnlVectorType;
using typename Superclass::InputCovariantVectorType;
using typename Superclass::OutputCovariantVectorType;
using typename Superclass::MatrixType;
using typename Superclass::InverseMatrixType;
using typename Superclass::CenterType;
using typename Superclass::OffsetType;
using typename Superclass::TranslationType;
using typename Superclass::VersorType;
using typename Superclass::AxisType;
using typename Superclass::AngleType;
/** Scale Vector Type. */
using ScaleVectorType = Vector<TParametersValueType, 3>;
/** Directly set the matrix of the transform.
*
* Orthogonality testing is bypassed in this case.
*
* \sa MatrixOffsetTransformBase::SetMatrix() */
void
SetMatrix(const MatrixType & matrix) override;
void
SetMatrix(const MatrixType & matrix, const TParametersValueType tolerance) override;
/** Set the transformation from a container of parameters
* This is typically used by optimizers.
* There are 9 parameters:
* 0-2 versor
* 3-5 translation
* 6-8 Scale
** */
void
SetParameters(const ParametersType & parameters) override;
const ParametersType &
GetParameters() const override;
/** Set/Get the scale vector. These scale factors are associated to the axis
* of coordinates. */
void
SetScale(const ScaleVectorType & scale);
itkGetConstReferenceMacro(Scale, ScaleVectorType);
/** Set the internal parameters of the transform in order to represent an
* Identity transform. */
void
SetIdentity() override;
/** This method computes the Jacobian matrix of the transformation.
* given point or vector, returning the transformed point or
* vector. The rank of the Jacobian will also indicate if the
* transform is invertible at this point. */
void
ComputeJacobianWithRespectToParameters(const InputPointType & p, JacobianType & jacobian) const override;
protected:
ScaleVersor3DTransform();
ScaleVersor3DTransform(const MatrixType & matrix, const OutputVectorType & offset);
ScaleVersor3DTransform(unsigned int parametersDimension);
~ScaleVersor3DTransform() override = default;
void
PrintSelf(std::ostream & os, Indent indent) const override;
void
SetVarScale(const ScaleVectorType & scale)
{
m_Scale = scale;
}
/** Compute the components of the rotation matrix in the superclass. */
void
ComputeMatrix() override;
void
ComputeMatrixParameters() override;
private:
/** Vector containing the scale. */
ScaleVectorType m_Scale{};
}; // class ScaleVersor3DTransform
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkScaleVersor3DTransform.hxx"
#endif
#endif /* __ScaleVersor3DTransform_h */
|