ITK  5.2.0
Insight Toolkit
itkComposeScaleSkewVersor3DTransform.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 itkComposeScaleSkewVersor3DTransform_h
19 #define itkComposeScaleSkewVersor3DTransform_h
20 
21 #include <iostream>
23 
24 namespace itk
25 {
52 template <typename TParametersValueType = double>
53 class ITK_TEMPLATE_EXPORT ComposeScaleSkewVersor3DTransform : public VersorRigid3DTransform<TParametersValueType>
54 {
55 public:
56  ITK_DISALLOW_COPY_AND_ASSIGN(ComposeScaleSkewVersor3DTransform);
57 
63 
65  itkNewMacro(Self);
66 
69 
71  static constexpr unsigned int InputSpaceDimension = 3;
72  static constexpr unsigned int OutputSpaceDimension = 3;
73  static constexpr unsigned int ParametersDimension = 12;
74 
76  using ParametersType = typename Superclass::ParametersType;
77  using FixedParametersType = typename Superclass::FixedParametersType;
78  using JacobianType = typename Superclass::JacobianType;
79  using JacobianPositionType = typename Superclass::JacobianPositionType;
80  using InverseJacobianPositionType = typename Superclass::InverseJacobianPositionType;
81  using ScalarType = typename Superclass::ScalarType;
82  using InputPointType = typename Superclass::InputPointType;
83  using OutputPointType = typename Superclass::OutputPointType;
84  using InputVectorType = typename Superclass::InputVectorType;
85  using OutputVectorType = typename Superclass::OutputVectorType;
86  using InputVnlVectorType = typename Superclass::InputVnlVectorType;
87  using OutputVnlVectorType = typename Superclass::OutputVnlVectorType;
88  using InputCovariantVectorType = typename Superclass::InputCovariantVectorType;
89  using OutputCovariantVectorType = typename Superclass::OutputCovariantVectorType;
90  using MatrixType = typename Superclass::MatrixType;
91  using InverseMatrixType = typename Superclass::InverseMatrixType;
92  using CenterType = typename Superclass::CenterType;
93  using OffsetType = typename Superclass::OffsetType;
94  using TranslationType = typename Superclass::TranslationType;
95 
96  using VersorType = typename Superclass::VersorType;
97  using AxisType = typename Superclass::AxisType;
98  using AngleType = typename Superclass::AngleType;
99 
103 
106  using TranslationValueType = typename TranslationType::ValueType;
107 
108  using AxisValueType = typename Superclass::AxisValueType;
109  using ParametersValueType = typename Superclass::ParametersValueType;
110 
116  void
117  SetMatrix(const MatrixType & matrix) override;
118  void
119  SetMatrix(const MatrixType & matrix, const TParametersValueType tolerance) override;
121 
130  void
131  SetParameters(const ParametersType & parameters) override;
132 
133  const ParametersType &
134  GetParameters() const override;
135 
136  void
137  SetScale(const ScaleVectorType & scale);
138 
139  itkGetConstReferenceMacro(Scale, ScaleVectorType);
140 
141  void
142  SetSkew(const SkewVectorType & skew);
143 
144  itkGetConstReferenceMacro(Skew, SkewVectorType);
145 
146  void
147  SetIdentity() override;
148 
149  /* This function is not implemented for this transform. An exception
150  * is thrown if this function is called. */
151  void
152  ComputeJacobianWithRespectToParameters(const InputPointType & p, JacobianType & jacobian) const override;
153 
154 protected:
156  ComposeScaleSkewVersor3DTransform(const MatrixType & matrix, const OutputVectorType & offset);
157  ComposeScaleSkewVersor3DTransform(unsigned int paramDims);
158  ~ComposeScaleSkewVersor3DTransform() override = default;
159 
160  void
161  PrintSelf(std::ostream & os, Indent indent) const override;
162 
163  void
165  {
166  m_Scale = scale;
167  }
168 
169  void
171  {
172  m_Skew = skew;
173  }
174 
176  void
177  ComputeMatrix() override;
178 
179  void
180  ComputeMatrixParameters() override;
181 
182 private:
185 
188 }; // class ComposeScaleSkewVersor3DTransform
189 } // namespace itk
190 
191 #ifndef ITK_MANUAL_INSTANTIATION
192 # include "itkComposeScaleSkewVersor3DTransform.hxx"
193 #endif
194 
195 #endif /* __ComposeScaleSkewVersor3DTransform_h */
itk::ComposeScaleSkewVersor3DTransform::VersorType
typename Superclass::VersorType VersorType
Definition: itkComposeScaleSkewVersor3DTransform.h:96
itk::ComposeScaleSkewVersor3DTransform::OutputVnlVectorType
typename Superclass::OutputVnlVectorType OutputVnlVectorType
Definition: itkComposeScaleSkewVersor3DTransform.h:87
itk::ComposeScaleSkewVersor3DTransform::AngleType
typename Superclass::AngleType AngleType
Definition: itkComposeScaleSkewVersor3DTransform.h:98
itk::ComposeScaleSkewVersor3DTransform::OutputPointType
typename Superclass::OutputPointType OutputPointType
Definition: itkComposeScaleSkewVersor3DTransform.h:83
itk::ComposeScaleSkewVersor3DTransform::SetVarScale
void SetVarScale(const ScaleVectorType &scale)
Definition: itkComposeScaleSkewVersor3DTransform.h:164
itk::ComposeScaleSkewVersor3DTransform
ComposeScaleSkewVersor3DTransform of a vector space (space coords)
Definition: itkComposeScaleSkewVersor3DTransform.h:53
itk::ComposeScaleSkewVersor3DTransform::ParametersType
typename Superclass::ParametersType ParametersType
Definition: itkComposeScaleSkewVersor3DTransform.h:76
itk::VersorRigid3DTransform
VersorRigid3DTransform of a vector space (e.g. space coordinates)
Definition: itkVersorRigid3DTransform.h:46
itk::Vector< TParametersValueType, 3 >
itk::ComposeScaleSkewVersor3DTransform::InputVectorType
typename Superclass::InputVectorType InputVectorType
Definition: itkComposeScaleSkewVersor3DTransform.h:84
itk::ComposeScaleSkewVersor3DTransform::AxisType
typename Superclass::AxisType AxisType
Definition: itkComposeScaleSkewVersor3DTransform.h:97
itk::SmartPointer< Self >
itk::Indent
Control indentation during Print() invocation.
Definition: itkIndent.h:49
itk::ComposeScaleSkewVersor3DTransform::InverseJacobianPositionType
typename Superclass::InverseJacobianPositionType InverseJacobianPositionType
Definition: itkComposeScaleSkewVersor3DTransform.h:80
itk::ComposeScaleSkewVersor3DTransform::OutputCovariantVectorType
typename Superclass::OutputCovariantVectorType OutputCovariantVectorType
Definition: itkComposeScaleSkewVersor3DTransform.h:89
itk::ComposeScaleSkewVersor3DTransform::JacobianPositionType
typename Superclass::JacobianPositionType JacobianPositionType
Definition: itkComposeScaleSkewVersor3DTransform.h:79
itk::LightObject
Light weight base class for most itk classes.
Definition: itkLightObject.h:59
itk::ComposeScaleSkewVersor3DTransform::InverseMatrixType
typename Superclass::InverseMatrixType InverseMatrixType
Definition: itkComposeScaleSkewVersor3DTransform.h:91
itkVersorRigid3DTransform.h
itk::ComposeScaleSkewVersor3DTransform::AxisValueType
typename Superclass::AxisValueType AxisValueType
Definition: itkComposeScaleSkewVersor3DTransform.h:108
itk::ComposeScaleSkewVersor3DTransform::CenterType
typename Superclass::CenterType CenterType
Definition: itkComposeScaleSkewVersor3DTransform.h:92
itk::ComposeScaleSkewVersor3DTransform::FixedParametersType
typename Superclass::FixedParametersType FixedParametersType
Definition: itkComposeScaleSkewVersor3DTransform.h:77
itk::Vector< TParametersValueType, 3 >::ValueType
TParametersValueType ValueType
Definition: itkVector.h:71
itk::ComposeScaleSkewVersor3DTransform::MatrixType
typename Superclass::MatrixType MatrixType
Definition: itkComposeScaleSkewVersor3DTransform.h:90
itk::ComposeScaleSkewVersor3DTransform::ScaleVectorValueType
typename ScaleVectorType::ValueType ScaleVectorValueType
Definition: itkComposeScaleSkewVersor3DTransform.h:104
itk::ComposeScaleSkewVersor3DTransform::OutputVectorType
typename Superclass::OutputVectorType OutputVectorType
Definition: itkComposeScaleSkewVersor3DTransform.h:85
itk::ComposeScaleSkewVersor3DTransform::ScalarType
typename Superclass::ScalarType ScalarType
Definition: itkComposeScaleSkewVersor3DTransform.h:81
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::ComposeScaleSkewVersor3DTransform::TranslationType
typename Superclass::TranslationType TranslationType
Definition: itkComposeScaleSkewVersor3DTransform.h:94
itk::ComposeScaleSkewVersor3DTransform::SetVarSkew
void SetVarSkew(const SkewVectorType &skew)
Definition: itkComposeScaleSkewVersor3DTransform.h:170
itk::ComposeScaleSkewVersor3DTransform::OffsetType
typename Superclass::OffsetType OffsetType
Definition: itkComposeScaleSkewVersor3DTransform.h:93
itk::ComposeScaleSkewVersor3DTransform::InputPointType
typename Superclass::InputPointType InputPointType
Definition: itkComposeScaleSkewVersor3DTransform.h:82
itk::ComposeScaleSkewVersor3DTransform::ParametersValueType
typename Superclass::ParametersValueType ParametersValueType
Definition: itkComposeScaleSkewVersor3DTransform.h:109
itk::ComposeScaleSkewVersor3DTransform::JacobianType
typename Superclass::JacobianType JacobianType
Definition: itkComposeScaleSkewVersor3DTransform.h:78
itk::ComposeScaleSkewVersor3DTransform::m_Scale
ScaleVectorType m_Scale
Definition: itkComposeScaleSkewVersor3DTransform.h:184
itk::ComposeScaleSkewVersor3DTransform::SkewVectorValueType
typename SkewVectorType::ValueType SkewVectorValueType
Definition: itkComposeScaleSkewVersor3DTransform.h:105
itk::ComposeScaleSkewVersor3DTransform::TranslationValueType
typename TranslationType::ValueType TranslationValueType
Definition: itkComposeScaleSkewVersor3DTransform.h:106
itk::ComposeScaleSkewVersor3DTransform::m_Skew
SkewVectorType m_Skew
Definition: itkComposeScaleSkewVersor3DTransform.h:187
itk::ComposeScaleSkewVersor3DTransform::InputVnlVectorType
typename Superclass::InputVnlVectorType InputVnlVectorType
Definition: itkComposeScaleSkewVersor3DTransform.h:86
itk::ComposeScaleSkewVersor3DTransform::InputCovariantVectorType
typename Superclass::InputCovariantVectorType InputCovariantVectorType
Definition: itkComposeScaleSkewVersor3DTransform.h:88