ITK  5.4.0
Insight Toolkit
itkScaleVersor3DTransform.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * https://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkScaleVersor3DTransform_h
19 #define itkScaleVersor3DTransform_h
20 
22 
23 namespace itk
24 {
47 template <typename TParametersValueType = double>
48 class ITK_TEMPLATE_EXPORT ScaleVersor3DTransform : public VersorRigid3DTransform<TParametersValueType>
49 {
50 public:
51  ITK_DISALLOW_COPY_AND_MOVE(ScaleVersor3DTransform);
52 
58 
60  itkNewMacro(Self);
61 
63  itkOverrideGetNameOfClassMacro(ScaleVersor3DTransform);
64 
66  static constexpr unsigned int InputSpaceDimension = 3;
67  static constexpr unsigned int OutputSpaceDimension = 3;
68  static constexpr unsigned int ParametersDimension = 9;
69 
71  using typename Superclass::ParametersType;
72  using typename Superclass::FixedParametersType;
73  using typename Superclass::JacobianType;
74  using typename Superclass::JacobianPositionType;
75  using typename Superclass::InverseJacobianPositionType;
76  using typename Superclass::ScalarType;
77  using typename Superclass::InputPointType;
78  using typename Superclass::OutputPointType;
79  using typename Superclass::InputVectorType;
80  using typename Superclass::OutputVectorType;
81  using typename Superclass::InputVnlVectorType;
82  using typename Superclass::OutputVnlVectorType;
83  using typename Superclass::InputCovariantVectorType;
84  using typename Superclass::OutputCovariantVectorType;
85  using typename Superclass::MatrixType;
86  using typename Superclass::InverseMatrixType;
87  using typename Superclass::CenterType;
88  using typename Superclass::OffsetType;
89  using typename Superclass::TranslationType;
90 
91  using typename Superclass::VersorType;
92  using typename Superclass::AxisType;
93  using typename Superclass::AngleType;
94 
97 
103  void
104  SetMatrix(const MatrixType & matrix) override;
105  void
106  SetMatrix(const MatrixType & matrix, const TParametersValueType tolerance) override;
116  void
117  SetParameters(const ParametersType & parameters) override;
118 
119  const ParametersType &
120  GetParameters() const override;
121 
124  void
125  SetScale(const ScaleVectorType & scale);
126 
127  itkGetConstReferenceMacro(Scale, ScaleVectorType);
128 
131  void
132  SetIdentity() override;
133 
138  void
139  ComputeJacobianWithRespectToParameters(const InputPointType & p, JacobianType & jacobian) const override;
140 
141 protected:
143  ScaleVersor3DTransform(const MatrixType & matrix, const OutputVectorType & offset);
144  ScaleVersor3DTransform(unsigned int parametersDimension);
145  ~ScaleVersor3DTransform() override = default;
146 
147  void
148  PrintSelf(std::ostream & os, Indent indent) const override;
149 
150  void
152  {
153  m_Scale = scale;
154  }
155 
157  void
158  ComputeMatrix() override;
159 
160  void
161  ComputeMatrixParameters() override;
162 
163 private:
165  ScaleVectorType m_Scale{};
166 }; // class ScaleVersor3DTransform
167 } // namespace itk
168 
169 #ifndef ITK_MANUAL_INSTANTIATION
170 # include "itkScaleVersor3DTransform.hxx"
171 #endif
172 
173 #endif /* __ScaleVersor3DTransform_h */
itk::OptimizerParameters
Class to hold and manage different parameter types used during optimization.
Definition: itkOptimizerParameters.h:36
itk::VersorRigid3DTransform
VersorRigid3DTransform of a vector space (e.g. space coordinates)
Definition: itkVersorRigid3DTransform.h:46
itk::Vector< TParametersValueType, 3 >
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::ScaleVersor3DTransform
This transform applies a Versor rotation, translation and anisotropic scale to the space.
Definition: itkScaleVersor3DTransform.h:48
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:55
itk::ScaleVersor3DTransform::SetVarScale
void SetVarScale(const ScaleVectorType &scale)
Definition: itkScaleVersor3DTransform.h:151
itkVersorRigid3DTransform.h
itk::Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Point
A templated class holding a geometric point in n-Dimensional space.
Definition: itkPoint.h:53
itk::Array2D
Array2D class representing a 2D array.
Definition: itkArray2D.h:42