ITK  5.2.0
Insight Toolkit
itkEuler3DTransform.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 itkEuler3DTransform_h
19 #define itkEuler3DTransform_h
20 
21 #include <iostream>
22 #include "itkRigid3DTransform.h"
23 
24 namespace itk
25 {
46 template <typename TParametersValueType = double>
47 class ITK_TEMPLATE_EXPORT Euler3DTransform : public Rigid3DTransform<TParametersValueType>
48 {
49 public:
50  ITK_DISALLOW_COPY_AND_ASSIGN(Euler3DTransform);
51 
57 
59  itkNewMacro(Self);
60 
62  itkTypeMacro(Euler3DTransform, Rigid3DTransform);
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 = 6;
69 
70  using ParametersType = typename Superclass::ParametersType;
71  using ParametersValueType = typename Superclass::ParametersValueType;
72  using FixedParametersType = typename Superclass::FixedParametersType;
73  using FixedParametersValueType = typename Superclass::FixedParametersValueType;
74  using JacobianType = typename Superclass::JacobianType;
75  using JacobianPositionType = typename Superclass::JacobianPositionType;
76  using InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType;
78  using InputVectorType = typename Superclass::InputVectorType;
79  using OutputVectorType = typename Superclass::OutputVectorType;
80  using InputCovariantVectorType = typename Superclass::InputCovariantVectorType;
81  using OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType;
82  using InputVnlVectorType = typename Superclass::InputVnlVectorType;
83  using OutputVnlVectorType = typename Superclass::OutputVnlVectorType;
84  using InputPointType = typename Superclass::InputPointType;
85  using OutputPointType = typename Superclass::OutputPointType;
86  using MatrixType = typename Superclass::MatrixType;
87  using InverseMatrixType = typename Superclass::InverseMatrixType;
88  using CenterType = typename Superclass::CenterType;
89  using TranslationType = typename Superclass::TranslationType;
90  using OffsetType = typename Superclass::OffsetType;
92 
97  void
98  SetParameters(const ParametersType & parameters) override;
99 
100  const ParametersType &
101  GetParameters() const override;
102 
103  const FixedParametersType &
104  GetFixedParameters() const override;
105  void
106  SetFixedParameters(const FixedParametersType & parameters) override;
107 
109  void
110  SetRotation(ScalarType angleX, ScalarType angleY, ScalarType angleZ);
111 
112  itkGetConstMacro(AngleX, ScalarType);
113  itkGetConstMacro(AngleY, ScalarType);
114  itkGetConstMacro(AngleZ, ScalarType);
115 
120  void
121  ComputeJacobianWithRespectToParameters(const InputPointType & p, JacobianType & jacobian) const override;
122  using Superclass::ComputeJacobianWithRespectToPosition;
123 
130  virtual void
131  SetComputeZYX(const bool flag);
132  itkGetConstMacro(ComputeZYX, bool);
134 
135  void
136  SetIdentity() override;
137 
138 protected:
139  Euler3DTransform(const MatrixType & matrix, const OutputPointType & offset);
140  Euler3DTransform(unsigned int paramsSpaceDims);
142 
143  ~Euler3DTransform() override = default;
144 
145  void
146  PrintSelf(std::ostream & os, Indent indent) const override;
147 
149  void
150  SetVarRotation(ScalarType angleX, ScalarType angleY, ScalarType angleZ);
151 
153  void
154  ComputeMatrix() override;
155 
156  void
157  ComputeMatrixParameters() override;
158 
159 private:
164 }; // class Euler3DTransform
165 } // namespace itk
166 
167 #ifndef ITK_MANUAL_INSTANTIATION
168 # include "itkEuler3DTransform.hxx"
169 #endif
170 
171 #endif /* itkEuler3DTransform_h */
itk::Euler3DTransform
Euler3DTransform of a vector space (e.g. space coordinates)
Definition: itkEuler3DTransform.h:47
itk::Rigid3DTransform
Rigid3DTransform of a vector space (e.g. space coordinates)
Definition: itkRigid3DTransform.h:57
itk::Euler3DTransform::InverseMatrixType
typename Superclass::InverseMatrixType InverseMatrixType
Definition: itkEuler3DTransform.h:87
itk::Euler3DTransform::ParametersType
typename Superclass::ParametersType ParametersType
Definition: itkEuler3DTransform.h:70
itk::Euler3DTransform::InputVnlVectorType
typename Superclass::InputVnlVectorType InputVnlVectorType
Definition: itkEuler3DTransform.h:82
itk::Euler3DTransform::InputPointType
typename Superclass::InputPointType InputPointType
Definition: itkEuler3DTransform.h:84
itk::Euler3DTransform::JacobianPositionType
typename Superclass::JacobianPositionType JacobianPositionType
Definition: itkEuler3DTransform.h:75
itk::Euler3DTransform::OutputVnlVectorType
typename Superclass::OutputVnlVectorType OutputVnlVectorType
Definition: itkEuler3DTransform.h:83
itk::Euler3DTransform::AngleType
typename Superclass::ScalarType AngleType
Definition: itkEuler3DTransform.h:91
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::Euler3DTransform::ScalarType
typename Superclass::ScalarType ScalarType
Definition: itkEuler3DTransform.h:77
itk::Euler3DTransform::CenterType
typename Superclass::CenterType CenterType
Definition: itkEuler3DTransform.h:88
itk::Euler3DTransform::FixedParametersValueType
typename Superclass::FixedParametersValueType FixedParametersValueType
Definition: itkEuler3DTransform.h:73
itk::Euler3DTransform::FixedParametersType
typename Superclass::FixedParametersType FixedParametersType
Definition: itkEuler3DTransform.h:72
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::Euler3DTransform::OutputVectorType
typename Superclass::OutputVectorType OutputVectorType
Definition: itkEuler3DTransform.h:79
itk::Euler3DTransform::OutputCovariantVectorType
typename Superclass::OutputCovariantVectorType OutputCovariantVectorType
Definition: itkEuler3DTransform.h:81
itk::Euler3DTransform::m_AngleY
ScalarType m_AngleY
Definition: itkEuler3DTransform.h:161
itk::Euler3DTransform::m_AngleX
ScalarType m_AngleX
Definition: itkEuler3DTransform.h:160
itkRigid3DTransform.h
itk::Euler3DTransform::ParametersValueType
typename Superclass::ParametersValueType ParametersValueType
Definition: itkEuler3DTransform.h:71
itk::Euler3DTransform::InputVectorType
typename Superclass::InputVectorType InputVectorType
Definition: itkEuler3DTransform.h:78
itk::Euler3DTransform::JacobianType
typename Superclass::JacobianType JacobianType
Definition: itkEuler3DTransform.h:74
itk::Rigid3DTransform::ScalarType
typename Superclass::ScalarType ScalarType
Definition: itkRigid3DTransform.h:87
itk::Euler3DTransform::MatrixType
typename Superclass::MatrixType MatrixType
Definition: itkEuler3DTransform.h:86
itk::Euler3DTransform::InverseJacobianPositionType
typename Superclass::InverseJacobianPositionType InverseJacobianPositionType
Definition: itkEuler3DTransform.h:76
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::Euler3DTransform::OutputPointType
typename Superclass::OutputPointType OutputPointType
Definition: itkEuler3DTransform.h:85
itk::Euler3DTransform::TranslationType
typename Superclass::TranslationType TranslationType
Definition: itkEuler3DTransform.h:89
itk::Euler3DTransform::m_ComputeZYX
bool m_ComputeZYX
Definition: itkEuler3DTransform.h:163
itk::Euler3DTransform::m_AngleZ
ScalarType m_AngleZ
Definition: itkEuler3DTransform.h:162
itk::Euler3DTransform::OffsetType
typename Superclass::OffsetType OffsetType
Definition: itkEuler3DTransform.h:90
itk::Euler3DTransform::InputCovariantVectorType
typename Superclass::InputCovariantVectorType InputCovariantVectorType
Definition: itkEuler3DTransform.h:80