ITK  5.2.0
Insight Toolkit
itkCenteredSimilarity2DTransform.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 itkCenteredSimilarity2DTransform_h
19 #define itkCenteredSimilarity2DTransform_h
20 
22 
23 namespace itk
24 {
54 template <typename TParametersValueType = double>
55 class ITK_TEMPLATE_EXPORT CenteredSimilarity2DTransform : public Similarity2DTransform<TParametersValueType>
56 {
57 public:
58  ITK_DISALLOW_COPY_AND_MOVE(CenteredSimilarity2DTransform);
59 
65 
67  itkNewMacro(Self);
68 
71 
73  static constexpr unsigned int SpaceDimension = 2;
74  static constexpr unsigned int InputSpaceDimension = 2;
75  static constexpr unsigned int OutputSpaceDimension = 2;
76  static constexpr unsigned int ParametersDimension = 6;
77 
79  using ScalarType = typename Superclass::ScalarType;
80 
82  using FixedParametersType = typename Superclass::FixedParametersType;
83  using FixedParametersValueType = typename Superclass::FixedParametersValueType;
84  using ParametersType = typename Superclass::ParametersType;
85  using ParametersValueType = typename Superclass::ParametersValueType;
86 
88  using JacobianType = typename Superclass::JacobianType;
89  using JacobianPositionType = typename Superclass::JacobianPositionType;
90  using InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType;
91 
93  using OffsetType = typename Superclass::OffsetType;
95 
97  using InputPointType = typename Superclass::InputPointType;
98  using OutputPointType = typename Superclass::OutputPointType;
99  using InputPointValueType = typename InputPointType::ValueType;
100 
102  using InputVectorType = typename Superclass::InputVectorType;
103  using OutputVectorType = typename Superclass::OutputVectorType;
104 
106  using InputCovariantVectorType = typename Superclass::InputCovariantVectorType;
107  using OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType;
108 
110  using InputVnlVectorType = typename Superclass::InputVnlVectorType;
111  using OutputVnlVectorType = typename Superclass::OutputVnlVectorType;
112 
115  using InverseTransformBaseType = typename Superclass::InverseTransformBaseType;
116  using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer;
117 
127  void
128  SetParameters(const ParametersType & parameters) override;
129 
139  const ParametersType &
140  GetParameters() const override;
141 
143  void
144  ComputeJacobianWithRespectToParameters(const InputPointType & p, JacobianType & jacobian) const override;
145 
148  void
149  SetFixedParameters(const FixedParametersType &) override;
150 
153  const FixedParametersType &
154  GetFixedParameters() const override;
155 
159  void
160  CloneInverseTo(Pointer & result) const;
161 
163  bool
164  GetInverse(Self * inverse) const;
165 
168  GetInverseTransform() const override;
169 
173  void
174  CloneTo(Pointer & result) const;
175 
176 protected:
178  CenteredSimilarity2DTransform(unsigned int spaceDimension, unsigned int parametersDimension);
179 
180  ~CenteredSimilarity2DTransform() override = default;
181  void
182  PrintSelf(std::ostream & os, Indent indent) const override;
183 };
184 
185 } // end namespace itk
186 
187 #ifndef ITK_MANUAL_INSTANTIATION
188 # include "itkCenteredSimilarity2DTransform.hxx"
189 #endif
190 
191 #endif /* itkCenteredSimilarity2DTransform_h */
itk::CenteredSimilarity2DTransform::ScalarType
typename Superclass::ScalarType ScalarType
Definition: itkCenteredSimilarity2DTransform.h:79
itkSimilarity2DTransform.h
itk::CenteredSimilarity2DTransform::JacobianPositionType
typename Superclass::JacobianPositionType JacobianPositionType
Definition: itkCenteredSimilarity2DTransform.h:89
itk::CenteredSimilarity2DTransform::InputCovariantVectorType
typename Superclass::InputCovariantVectorType InputCovariantVectorType
Definition: itkCenteredSimilarity2DTransform.h:106
itk::CenteredSimilarity2DTransform::InputPointValueType
typename InputPointType::ValueType InputPointValueType
Definition: itkCenteredSimilarity2DTransform.h:99
itk::CenteredSimilarity2DTransform::InputPointType
typename Superclass::InputPointType InputPointType
Definition: itkCenteredSimilarity2DTransform.h:97
itk::CenteredSimilarity2DTransform::OutputVectorType
typename Superclass::OutputVectorType OutputVectorType
Definition: itkCenteredSimilarity2DTransform.h:103
itk::CenteredSimilarity2DTransform::ParametersType
typename Superclass::ParametersType ParametersType
Definition: itkCenteredSimilarity2DTransform.h:84
itk::CenteredSimilarity2DTransform::InputVnlVectorType
typename Superclass::InputVnlVectorType InputVnlVectorType
Definition: itkCenteredSimilarity2DTransform.h:110
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::CenteredSimilarity2DTransform::FixedParametersType
typename Superclass::FixedParametersType FixedParametersType
Definition: itkCenteredSimilarity2DTransform.h:82
itk::CenteredSimilarity2DTransform::InputVectorType
typename Superclass::InputVectorType InputVectorType
Definition: itkCenteredSimilarity2DTransform.h:102
itk::CenteredSimilarity2DTransform::ParametersValueType
typename Superclass::ParametersValueType ParametersValueType
Definition: itkCenteredSimilarity2DTransform.h:85
itk::CenteredSimilarity2DTransform::OffsetValueType
typename Superclass::OffsetValueType OffsetValueType
Definition: itkCenteredSimilarity2DTransform.h:94
itk::CenteredSimilarity2DTransform::InverseJacobianPositionType
typename Superclass::InverseJacobianPositionType InverseJacobianPositionType
Definition: itkCenteredSimilarity2DTransform.h:90
itk::CenteredSimilarity2DTransform::OutputVnlVectorType
typename Superclass::OutputVnlVectorType OutputVnlVectorType
Definition: itkCenteredSimilarity2DTransform.h:111
itk::CenteredSimilarity2DTransform::OutputPointType
typename Superclass::OutputPointType OutputPointType
Definition: itkCenteredSimilarity2DTransform.h:98
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::CenteredSimilarity2DTransform::InverseTransformBasePointer
typename InverseTransformBaseType::Pointer InverseTransformBasePointer
Definition: itkCenteredSimilarity2DTransform.h:116
itk::Similarity2DTransform
Similarity2DTransform of a vector space (e.g. space coordinates)
Definition: itkSimilarity2DTransform.h:62
itk::CenteredSimilarity2DTransform::OutputCovariantVectorType
typename Superclass::OutputCovariantVectorType OutputCovariantVectorType
Definition: itkCenteredSimilarity2DTransform.h:107
itk::CenteredSimilarity2DTransform::FixedParametersValueType
typename Superclass::FixedParametersValueType FixedParametersValueType
Definition: itkCenteredSimilarity2DTransform.h:83
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::OffsetValueType
signed long OffsetValueType
Definition: itkIntTypes.h:94
itk::CenteredSimilarity2DTransform::JacobianType
typename Superclass::JacobianType JacobianType
Definition: itkCenteredSimilarity2DTransform.h:88
itk::CenteredSimilarity2DTransform::OffsetType
typename Superclass::OffsetType OffsetType
Definition: itkCenteredSimilarity2DTransform.h:93
itk::CenteredSimilarity2DTransform
CenteredSimilarity2DTransform of a vector space (e.g. space coordinates)
Definition: itkCenteredSimilarity2DTransform.h:55
itk::CenteredSimilarity2DTransform::InverseTransformBaseType
typename Superclass::InverseTransformBaseType InverseTransformBaseType
Definition: itkCenteredSimilarity2DTransform.h:115