ITK  5.2.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_ASSIGN(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 ScalarType = typename Superclass::ScalarType;
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 InputPointType = typename Superclass::InputPointType;
77  using OutputPointType = typename Superclass::OutputPointType;
78  using InputVectorType = typename Superclass::InputVectorType;
79  using OutputVectorType = typename Superclass::OutputVectorType;
80  using InputVnlVectorType = typename Superclass::InputVnlVectorType;
81  using OutputVnlVectorType = typename Superclass::OutputVnlVectorType;
82  using InputCovariantVectorType = typename Superclass::InputCovariantVectorType;
83  using OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType;
84  using MatrixType = typename Superclass::MatrixType;
85  using InverseMatrixType = typename Superclass::InverseMatrixType;
86  using CenterType = typename Superclass::CenterType;
87  using OffsetType = typename Superclass::OffsetType;
88  using TranslationType = typename Superclass::TranslationType;
89 
91  using VersorType = typename Superclass::VersorType;
93 
94  using AxisType = typename Superclass::AxisType;
95  using AngleType = typename Superclass::AngleType;
96 
97  using AxisValueType = typename Superclass::AxisValueType;
98  using TranslationValueType = typename Superclass::TranslationValueType;
99  using ParametersValueType = 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::Rigid3DTransform::InputPointType
typename Superclass::InputPointType InputPointType
Definition: itkRigid3DTransform.h:95
itk::VersorRigid3DTransform::TranslationValueType
typename Superclass::TranslationValueType TranslationValueType
Definition: itkVersorRigid3DTransform.h:98
itk::Rigid3DTransform::JacobianType
typename Superclass::JacobianType JacobianType
Definition: itkRigid3DTransform.h:84
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::GTest::TypedefsAndConstructors::Dimension2::VectorType
ImageBaseType::SpacingType VectorType
Definition: itkGTestTypedefsAndConstructors.h:53
itk::Rigid3DTransform::ParametersType
typename Superclass::ParametersType ParametersType
Definition: itkRigid3DTransform.h:80
itk::Rigid3DTransform::ParametersValueType
typename Superclass::ParametersValueType ParametersValueType
Definition: itkRigid3DTransform.h:81
itkVersorTransform.h
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
itk::VersorTransform
Definition: itkVersorTransform.h:47
itk::VersorRigid3DTransform::AxisValueType
typename Superclass::AxisValueType AxisValueType
Definition: itkVersorRigid3DTransform.h:97
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::VersorRigid3DTransform::AxisType
typename Superclass::AxisType AxisType
Definition: itkVersorRigid3DTransform.h:94
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::Rigid3DTransform::OutputPointType
typename Superclass::OutputPointType OutputPointType
Definition: itkRigid3DTransform.h:96
itk::VersorRigid3DTransform::VectorType
typename VersorType::VectorType VectorType
Definition: itkVersorRigid3DTransform.h:92
itk::Rigid3DTransform::TranslationType
typename Superclass::TranslationType TranslationType
Definition: itkRigid3DTransform.h:101
itk::VersorRigid3DTransform::AngleType
typename Superclass::AngleType AngleType
Definition: itkVersorRigid3DTransform.h:95
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::VersorRigid3DTransform::VersorType
typename Superclass::VersorType VersorType
Definition: itkVersorRigid3DTransform.h:91