ITK  5.2.0
Insight Toolkit
itkSimilarity3DTransform.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  * http://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 itkSimilarity3DTransform_h
19 #define itkSimilarity3DTransform_h
20 
21 #include <iostream>
23 
24 namespace itk
25 {
46 template <typename TParametersValueType = double>
47 class ITK_TEMPLATE_EXPORT Similarity3DTransform : public VersorRigid3DTransform<TParametersValueType>
48 {
49 public:
50  ITK_DISALLOW_COPY_AND_ASSIGN(Similarity3DTransform);
51 
57 
59  itkNewMacro(Self);
60 
63 
65  static constexpr unsigned int SpaceDimension = 3;
66  static constexpr unsigned int InputSpaceDimension = 3;
67  static constexpr unsigned int OutputSpaceDimension = 3;
68  static constexpr unsigned int ParametersDimension = 7;
69 
71  using ParametersType = typename Superclass::ParametersType;
72  using FixedParametersType = typename Superclass::FixedParametersType;
73  using JacobianType = typename Superclass::JacobianType;
74  using JacobianPositionType = typename Superclass::JacobianPositionType;
75  using InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType;
76  using ScalarType = typename Superclass::ScalarType;
77  using InputPointType = typename Superclass::InputPointType;
78  using OutputPointType = typename Superclass::OutputPointType;
79  using InputVectorType = typename Superclass::InputVectorType;
80  using OutputVectorType = typename Superclass::OutputVectorType;
81  using InputVnlVectorType = typename Superclass::InputVnlVectorType;
82  using OutputVnlVectorType = typename Superclass::OutputVnlVectorType;
83  using InputCovariantVectorType = typename Superclass::InputCovariantVectorType;
84  using OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType;
85  using MatrixType = typename Superclass::MatrixType;
86  using InverseMatrixType = typename Superclass::InverseMatrixType;
87  using CenterType = typename Superclass::CenterType;
88  using OffsetType = typename Superclass::OffsetType;
89  using TranslationType = typename Superclass::TranslationType;
90 
92  using VersorType = typename Superclass::VersorType;
93  using AxisType = typename Superclass::AxisType;
94  using AngleType = typename Superclass::AngleType;
95  using ScaleType = TParametersValueType;
96 
98  void
99  SetIdentity() override;
100 
107  void
108  SetMatrix(const MatrixType & matrix) override;
109 
116  void
117  SetMatrix(const MatrixType & matrix, const TParametersValueType tolerance) override;
118 
123  void
124  SetParameters(const ParametersType & parameters) override;
125 
126  const ParametersType &
127  GetParameters() const override;
128 
130  void
131  SetScale(ScaleType scale);
132 
133  itkGetConstReferenceMacro(Scale, ScaleType);
134 
139  void
140  ComputeJacobianWithRespectToParameters(const InputPointType & p, JacobianType & jacobian) const override;
141 
142 protected:
143  Similarity3DTransform(const MatrixType & matrix, const OutputVectorType & offset);
144  Similarity3DTransform(unsigned int paramDim);
146  ~Similarity3DTransform() override = default;
147 
148  void
149  PrintSelf(std::ostream & os, Indent indent) const override;
150 
153  void
154  ComputeMatrix() override;
155 
157  void
158  ComputeMatrixParameters() override;
159 
160 private:
162 }; // class Similarity3DTransform
163 } // namespace itk
164 
165 #ifndef ITK_MANUAL_INSTANTIATION
166 # include "itkSimilarity3DTransform.hxx"
167 #endif
168 
169 #endif /* itkSimilarity3DTransform_h */
itk::Rigid3DTransform::InputPointType
typename Superclass::InputPointType InputPointType
Definition: itkRigid3DTransform.h:95
itk::Similarity3DTransform::m_Scale
ScaleType m_Scale
Definition: itkSimilarity3DTransform.h:161
itk::Similarity3DTransform::AxisType
typename Superclass::AxisType AxisType
Definition: itkSimilarity3DTransform.h:93
itk::Rigid3DTransform::JacobianType
typename Superclass::JacobianType JacobianType
Definition: itkRigid3DTransform.h:84
itk::Similarity3DTransform::AngleType
typename Superclass::AngleType AngleType
Definition: itkSimilarity3DTransform.h:94
itk::Rigid3DTransform::OffsetType
typename Superclass::OffsetType OffsetType
Definition: itkRigid3DTransform.h:102
itk::VersorRigid3DTransform
VersorRigid3DTransform of a vector space (e.g. space coordinates)
Definition: itkVersorRigid3DTransform.h:46
itk::Rigid3DTransform::InputCovariantVectorType
typename Superclass::InputCovariantVectorType InputCovariantVectorType
Definition: itkRigid3DTransform.h:91
itk::Rigid3DTransform::ParametersType
typename Superclass::ParametersType ParametersType
Definition: itkRigid3DTransform.h:80
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::Rigid3DTransform::OutputVectorType
typename Superclass::OutputVectorType OutputVectorType
Definition: itkRigid3DTransform.h:89
itk::Rigid3DTransform::FixedParametersType
typename Superclass::FixedParametersType FixedParametersType
Definition: itkRigid3DTransform.h:82
itk::Rigid3DTransform::CenterType
typename Superclass::CenterType CenterType
Definition: itkRigid3DTransform.h:100
itk::Rigid3DTransform::JacobianPositionType
typename Superclass::JacobianPositionType JacobianPositionType
Definition: itkRigid3DTransform.h:85
itk::Rigid3DTransform::MatrixType
typename Superclass::MatrixType MatrixType
Definition: itkRigid3DTransform.h:97
itk::Rigid3DTransform::InputVectorType
typename Superclass::InputVectorType InputVectorType
Definition: itkRigid3DTransform.h:88
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itkVersorRigid3DTransform.h
itk::Rigid3DTransform::ScalarType
typename Superclass::ScalarType ScalarType
Definition: itkRigid3DTransform.h:87
itk::Rigid3DTransform::OutputVnlVectorType
typename Superclass::OutputVnlVectorType OutputVnlVectorType
Definition: itkRigid3DTransform.h:94
itk::Rigid3DTransform::OutputCovariantVectorType
typename Superclass::OutputCovariantVectorType OutputCovariantVectorType
Definition: itkRigid3DTransform.h:92
itk::Similarity3DTransform::ScaleType
TParametersValueType ScaleType
Definition: itkSimilarity3DTransform.h:95
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Rigid3DTransform::OutputPointType
typename Superclass::OutputPointType OutputPointType
Definition: itkRigid3DTransform.h:96
itk::Rigid3DTransform::TranslationType
typename Superclass::TranslationType TranslationType
Definition: itkRigid3DTransform.h:101
itk::Rigid3DTransform::InputVnlVectorType
typename Superclass::InputVnlVectorType InputVnlVectorType
Definition: itkRigid3DTransform.h:93
itk::Rigid3DTransform::InverseMatrixType
typename Superclass::InverseMatrixType InverseMatrixType
Definition: itkRigid3DTransform.h:98
itk::Rigid3DTransform::InverseJacobianPositionType
typename Superclass::InverseJacobianPositionType InverseJacobianPositionType
Definition: itkRigid3DTransform.h:86
itk::Similarity3DTransform
Similarity3DTransform of a vector space (e.g. space coordinates)
Definition: itkSimilarity3DTransform.h:47
itk::Similarity3DTransform::VersorType
typename Superclass::VersorType VersorType
Definition: itkSimilarity3DTransform.h:92