ITK  5.3.0
Insight Toolkit
itkVersorRigid3DTransform.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 itkVersorRigid3DTransform_h
19 #define itkVersorRigid3DTransform_h
20 
21 #include <iostream>
22 #include "itkVersorTransform.h"
23 
24 namespace itk
25 {
45 template <typename TParametersValueType = double>
46 class ITK_TEMPLATE_EXPORT VersorRigid3DTransform : public VersorTransform<TParametersValueType>
47 {
48 public:
49  ITK_DISALLOW_COPY_AND_MOVE(VersorRigid3DTransform);
50 
56 
58  itkNewMacro(Self);
59 
62 
64  static constexpr unsigned int SpaceDimension = 3;
65  static constexpr unsigned int InputSpaceDimension = 3;
66  static constexpr unsigned int OutputSpaceDimension = 3;
67  static constexpr unsigned int ParametersDimension = 6;
68 
70  using typename Superclass::ScalarType;
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::InputPointType;
77  using typename Superclass::OutputPointType;
78  using typename Superclass::InputVectorType;
79  using typename Superclass::OutputVectorType;
80  using typename Superclass::InputVnlVectorType;
81  using typename Superclass::OutputVnlVectorType;
82  using typename Superclass::InputCovariantVectorType;
83  using typename Superclass::OutputCovariantVectorType;
84  using typename Superclass::MatrixType;
85  using typename Superclass::InverseMatrixType;
86  using typename Superclass::CenterType;
87  using typename Superclass::OffsetType;
88  using typename Superclass::TranslationType;
89 
91  using typename Superclass::VersorType;
93 
94  using typename Superclass::AxisType;
95  using typename Superclass::AngleType;
96 
97  using typename Superclass::AxisValueType;
98  using typename Superclass::TranslationValueType;
99  using typename Superclass::ParametersValueType;
100 
102 
107  void
108  SetParameters(const ParametersType & parameters) override;
109 
110  const ParametersType &
111  GetParameters() const override;
112 
120  void
121  UpdateTransformParameters(const DerivativeType & update, TParametersValueType factor = 1.0) override;
122 
127  void
128  ComputeJacobianWithRespectToParameters(const InputPointType & p, JacobianType & jacobian) const override;
129 
130 protected:
131  VersorRigid3DTransform(const MatrixType & matrix, const OutputVectorType & offset);
132  VersorRigid3DTransform(unsigned int paramDim);
134  ~VersorRigid3DTransform() override = default;
135 
136  void
137  PrintSelf(std::ostream & os, Indent indent) const override;
138 }; // class VersorRigid3DTransform
139 } // namespace itk
140 
141 #ifndef ITK_MANUAL_INSTANTIATION
142 # include "itkVersorRigid3DTransform.hxx"
143 #endif
144 
145 #endif /* itkVersorRigid3DTransform_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::GTest::TypedefsAndConstructors::Dimension2::VectorType
ImageBaseType::SpacingType VectorType
Definition: itkGTestTypedefsAndConstructors.h:53
itk::Vector
A templated class holding a n-Dimensional vector.
Definition: itkVector.h:62
itkVersorTransform.h
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::VersorTransform
Definition: itkVersorTransform.h:47
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::Array
Array class with size defined at construction time.
Definition: itkArray.h:47
itk::VersorRigid3DTransform::VectorType
typename VersorType::VectorType VectorType
Definition: itkVersorRigid3DTransform.h:92
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 with size defined at construction time.
Definition: itkArray2D.h:45