go home Home | Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages
Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright UMC Utrecht and contributors
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 /*=========================================================================
19 
20  Program: Insight Segmentation & Registration Toolkit
21  Module: $RCSfile: itkAdvancedTranslationTransform.h,v $
22  Language: C++
23  Date: $Date: 2007-07-15 16:38:25 $
24  Version: $Revision: 1.36 $
25 
26  Copyright (c) Insight Software Consortium. All rights reserved.
27  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
28 
29  This software is distributed WITHOUT ANY WARRANTY; without even
30  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
31  PURPOSE. See the above copyright notices for more information.
32 
33 =========================================================================*/
34 
35 #ifndef __itkAdvancedTranslationTransform_h
36 #define __itkAdvancedTranslationTransform_h
37 
38 #include <iostream>
39 #include "itkAdvancedTransform.h"
40 #include "itkExceptionObject.h"
41 #include "itkMatrix.h"
42 
43 namespace itk
44 {
45 
53 template<
54  class TScalarType = double, // Data type for scalars (float or double)
55  unsigned int NDimensions = 3 > // Number of dimensions
56 class ITK_EXPORT AdvancedTranslationTransform :
57  public AdvancedTransform< TScalarType, NDimensions, NDimensions >
58 {
59 public:
60 
65  typedef SmartPointer< const Self > ConstPointer;
66 
68  itkNewMacro( Self );
69 
72 
74  itkStaticConstMacro( SpaceDimension, unsigned int, NDimensions );
75  itkStaticConstMacro( ParametersDimension, unsigned int, NDimensions );
76 
78  typedef typename Superclass::ScalarType ScalarType;
79 
81  typedef typename Superclass::ParametersType ParametersType;
82  typedef typename Superclass::NumberOfParametersType NumberOfParametersType;
83 
85  typedef typename Superclass::JacobianType JacobianType;
86 
88  typedef Vector< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > InputVectorType;
89  typedef Vector< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > OutputVectorType;
90 
92  typedef CovariantVector< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > InputCovariantVectorType;
93  typedef CovariantVector< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > OutputCovariantVectorType;
94 
96  typedef vnl_vector_fixed< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > InputVnlVectorType;
97  typedef vnl_vector_fixed< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > OutputVnlVectorType;
98 
100  typedef Point< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > InputPointType;
101  typedef Point< TScalarType, itkGetStaticConstMacro( SpaceDimension ) > OutputPointType;
102 
104  typedef typename Superclass
105  ::NonZeroJacobianIndicesType NonZeroJacobianIndicesType;
106  typedef typename Superclass::SpatialJacobianType SpatialJacobianType;
107  typedef typename Superclass
108  ::JacobianOfSpatialJacobianType JacobianOfSpatialJacobianType;
109  typedef typename Superclass::SpatialHessianType SpatialHessianType;
110  typedef typename Superclass
111  ::JacobianOfSpatialHessianType JacobianOfSpatialHessianType;
112  typedef typename Superclass::InternalMatrixType InternalMatrixType;
113 
117  const OutputVectorType & GetOffset( void ) const
118  { return m_Offset; }
119 
122  void SetParameters( const ParametersType & parameters );
123 
125  virtual const ParametersType & GetParameters( void ) const;
126 
130  void SetOffset( const OutputVectorType & offset )
131  { m_Offset = offset; return; }
132 
134  void Compose( const Self * other, bool pre = 0 );
135 
140  void Translate( const OutputVectorType & offset, bool pre = 0 );
141 
147 
149 
151 
153  const InputCovariantVectorType & vector ) const;
154 
158  inline InputPointType BackTransform( const OutputPointType & point ) const;
159 
160  inline InputVectorType BackTransform( const OutputVectorType & vector ) const;
161 
162  inline InputVnlVectorType BackTransform( const OutputVnlVectorType & vector ) const;
163 
165  const OutputCovariantVectorType & vector ) const;
166 
171  bool GetInverse( Self * inverse ) const;
172 
174  virtual void GetJacobian(
175  const InputPointType &,
176  JacobianType &,
177  NonZeroJacobianIndicesType & ) const;
178 
180  virtual void GetSpatialJacobian(
181  const InputPointType &,
182  SpatialJacobianType & ) const;
183 
185  virtual void GetSpatialHessian(
186  const InputPointType &,
187  SpatialHessianType & ) const;
188 
191  const InputPointType &,
193  NonZeroJacobianIndicesType & ) const;
194 
197  const InputPointType &,
200  NonZeroJacobianIndicesType & ) const;
201 
204  const InputPointType &,
206  NonZeroJacobianIndicesType & ) const;
207 
212  const InputPointType & ipp,
213  SpatialHessianType & sh,
215  NonZeroJacobianIndicesType & nonZeroJacobianIndices ) const;
216 
218  void SetIdentity( void );
219 
222  { return NDimensions; }
223 
229  virtual bool IsLinear() const { return true; }
230 
234  virtual void SetFixedParameters( const ParametersType & )
235  { /* purposely blank */ }
236 
240  virtual const ParametersType & GetFixedParameters( void ) const
241  {
242  this->m_FixedParameters.SetSize( 0 );
243  return this->m_FixedParameters;
244  }
245 
246 
247 protected:
248 
252  void PrintSelf( std::ostream & os, Indent indent ) const;
253 
254 private:
255 
256  AdvancedTranslationTransform( const Self & ); // purposely not implemented
257  void operator=( const Self & ); // purposely not implemented
258 
259  OutputVectorType m_Offset; // Offset of the transformation
260 
261  JacobianType m_LocalJacobian;
262  SpatialJacobianType m_SpatialJacobian;
263  SpatialHessianType m_SpatialHessian;
264  NonZeroJacobianIndicesType m_NonZeroJacobianIndices;
265  JacobianOfSpatialJacobianType m_JacobianOfSpatialJacobian;
266  JacobianOfSpatialHessianType m_JacobianOfSpatialHessian;
267 
268 };
269 
270 //class AdvancedTranslationTransform
271 
272 // Back transform a point
273 template< class TScalarType, unsigned int NDimensions >
274 inline
277 ::BackTransform( const OutputPointType & point ) const
278 {
279  return point - m_Offset;
280 }
281 
282 
283 // Back transform a vector
284 template< class TScalarType, unsigned int NDimensions >
285 inline
288 ::BackTransform( const OutputVectorType & vect ) const
289 {
290  return vect;
291 }
292 
293 
294 // Back transform a vnl_vector
295 template< class TScalarType, unsigned int NDimensions >
296 inline
299 ::BackTransform( const OutputVnlVectorType & vect ) const
300 {
301  return vect;
302 }
303 
304 
305 // Back Transform a CovariantVector
306 template< class TScalarType, unsigned int NDimensions >
307 inline
310 ::BackTransform( const OutputCovariantVectorType & vect ) const
311 {
312  return vect;
313 }
314 
315 
316 } // namespace itk
317 
318 #ifndef ITK_MANUAL_INSTANTIATION
319 #include "itkAdvancedTranslationTransform.txx"
320 #endif
321 
322 #endif /* __itkAdvancedTranslationTransform_h */
itk::AdvancedTranslationTransform::IsLinear
virtual bool IsLinear() const
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:229
itk::AdvancedTranslationTransform::GetFixedParameters
virtual const ParametersType & GetFixedParameters(void) const
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:240
itk::AdvancedTransform< float, NDimensions, NDimensions >::OutputPointType
Superclass::OutputPointType OutputPointType
Definition: itkAdvancedTransform.h:125
itk::AdvancedTranslationTransform::InputVectorType
Vector< TScalarType, itkGetStaticConstMacro(SpaceDimension) > InputVectorType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:88
itk::AdvancedTranslationTransform::SetIdentity
void SetIdentity(void)
itk::AdvancedTranslationTransform
Translation transformation of a vector space (e.g. space coordinates)
Definition: Common/Transforms/itkAdvancedTranslationTransform.h:58
itk::AdvancedTranslationTransform::~AdvancedTranslationTransform
~AdvancedTranslationTransform()
itk::AdvancedTranslationTransform::itkStaticConstMacro
itkStaticConstMacro(SpaceDimension, unsigned int, NDimensions)
itk::AdvancedTranslationTransform::itkStaticConstMacro
itkStaticConstMacro(ParametersDimension, unsigned int, NDimensions)
itk::AdvancedTranslationTransform::JacobianType
Superclass::JacobianType JacobianType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:85
itk::AdvancedTranslationTransform::OutputVnlVectorType
vnl_vector_fixed< TScalarType, itkGetStaticConstMacro(SpaceDimension) > OutputVnlVectorType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:97
itk::AdvancedTransform< float, NDimensions, NDimensions >::SpatialJacobianType
Matrix< ScalarType, OutputSpaceDimension, InputSpaceDimension > SpatialJacobianType
Definition: itkAdvancedTransform.h:143
itk::AdvancedTranslationTransform::OutputPointType
Point< TScalarType, itkGetStaticConstMacro(SpaceDimension) > OutputPointType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:101
itk::AdvancedTranslationTransform::GetParameters
virtual const ParametersType & GetParameters(void) const
itk::AdvancedTranslationTransform::Superclass
AdvancedTransform< TScalarType, NDimensions, NDimensions > Superclass
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:63
itk::AdvancedTranslationTransform::GetNumberOfParameters
virtual NumberOfParametersType GetNumberOfParameters(void) const
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:221
itkAdvancedTransform.h
itk::AdvancedTransform< float, NDimensions, NDimensions >::InputCovariantVectorType
Superclass ::InputCovariantVectorType InputCovariantVectorType
Definition: itkAdvancedTransform.h:119
itk::AdvancedTranslationTransform::OutputCovariantVectorType
CovariantVector< TScalarType, itkGetStaticConstMacro(SpaceDimension) > OutputCovariantVectorType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:93
itk::AdvancedTranslationTransform::AdvancedTranslationTransform
AdvancedTranslationTransform(const Self &)
itk::AdvancedTransform< float, NDimensions, NDimensions >::InputPointType
Superclass::InputPointType InputPointType
Definition: itkAdvancedTransform.h:124
SmartPointer< Self >
itk::AdvancedTransform< float, NDimensions, NDimensions >::InputVnlVectorType
Superclass::InputVnlVectorType InputVnlVectorType
Definition: itkAdvancedTransform.h:122
itk::AdvancedTranslationTransform::InputVnlVectorType
vnl_vector_fixed< TScalarType, itkGetStaticConstMacro(SpaceDimension) > InputVnlVectorType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:96
itk::AdvancedTranslationTransform::BackTransform
InputCovariantVectorType BackTransform(const OutputCovariantVectorType &vector) const
itk::AdvancedTranslationTransform::GetInverse
bool GetInverse(Self *inverse) const
itk::AdvancedTranslationTransform::SetOffset
void SetOffset(const OutputVectorType &offset)
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:130
itk::AdvancedTranslationTransform::GetJacobianOfSpatialJacobian
virtual void GetJacobianOfSpatialJacobian(const InputPointType &, SpatialJacobianType &, JacobianOfSpatialJacobianType &, NonZeroJacobianIndicesType &) const
itk::AdvancedTranslationTransform::ConstPointer
SmartPointer< const Self > ConstPointer
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:65
itk::AdvancedTransform< float, NDimensions, NDimensions >::JacobianOfSpatialHessianType
std::vector< SpatialHessianType > JacobianOfSpatialHessianType
Definition: itkAdvancedTransform.h:150
itk::AdvancedTranslationTransform::AdvancedTranslationTransform
AdvancedTranslationTransform()
itk::AdvancedTranslationTransform::SetParameters
void SetParameters(const ParametersType &parameters)
itk::AdvancedTranslationTransform::PrintSelf
void PrintSelf(std::ostream &os, Indent indent) const
itk::AdvancedTranslationTransform::TransformVector
OutputVnlVectorType TransformVector(const InputVnlVectorType &vector) const
itk::AdvancedTranslationTransform::JacobianOfSpatialJacobianType
Superclass ::JacobianOfSpatialJacobianType JacobianOfSpatialJacobianType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:108
itk::AdvancedTranslationTransform::BackTransform
InputVnlVectorType BackTransform(const OutputVnlVectorType &vector) const
itk::AdvancedTranslationTransform::SpatialJacobianType
Superclass::SpatialJacobianType SpatialJacobianType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:106
itk::AdvancedTranslationTransform::GetSpatialJacobian
virtual void GetSpatialJacobian(const InputPointType &, SpatialJacobianType &) const
itk::AdvancedTranslationTransform::GetOffset
const OutputVectorType & GetOffset(void) const
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:117
itk::AdvancedTranslationTransform::NumberOfParametersType
Superclass::NumberOfParametersType NumberOfParametersType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:82
itk::AdvancedTranslationTransform::InputPointType
Point< TScalarType, itkGetStaticConstMacro(SpaceDimension) > InputPointType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:100
itk::AdvancedTranslationTransform::InternalMatrixType
Superclass::InternalMatrixType InternalMatrixType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:112
itk::AdvancedTranslationTransform::JacobianOfSpatialHessianType
Superclass ::JacobianOfSpatialHessianType JacobianOfSpatialHessianType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:111
itk::AdvancedTranslationTransform::TransformCovariantVector
OutputCovariantVectorType TransformCovariantVector(const InputCovariantVectorType &vector) const
itk::AdvancedTranslationTransform::InputCovariantVectorType
CovariantVector< TScalarType, itkGetStaticConstMacro(SpaceDimension) > InputCovariantVectorType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:92
double
itk::AdvancedTranslationTransform::GetJacobianOfSpatialJacobian
virtual void GetJacobianOfSpatialJacobian(const InputPointType &, JacobianOfSpatialJacobianType &, NonZeroJacobianIndicesType &) const
itk::AdvancedTransform< float, NDimensions, NDimensions >::JacobianType
Superclass::JacobianType JacobianType
Definition: itkAdvancedTransform.h:115
itk::AdvancedTranslationTransform::Pointer
SmartPointer< Self > Pointer
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:64
itk::AdvancedTransform< TScalarType, NDimensions, NDimensions >
itk::AdvancedTransform< float, NDimensions, NDimensions >::SpatialHessianType
FixedArray< Matrix< ScalarType, InputSpaceDimension, InputSpaceDimension >, OutputSpaceDimension > SpatialHessianType
Definition: itkAdvancedTransform.h:149
itk::AdvancedTransform< float, NDimensions, NDimensions >::InputVectorType
Superclass::InputVectorType InputVectorType
Definition: itkAdvancedTransform.h:116
itk::AdvancedTranslationTransform::GetJacobianOfSpatialHessian
virtual void GetJacobianOfSpatialHessian(const InputPointType &, JacobianOfSpatialHessianType &, NonZeroJacobianIndicesType &) const
itk::AdvancedTranslationTransform::Compose
void Compose(const Self *other, bool pre=0)
itk::AdvancedTranslationTransform::OutputVectorType
Vector< TScalarType, itkGetStaticConstMacro(SpaceDimension) > OutputVectorType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:89
itk::AdvancedTranslationTransform::TransformPoint
OutputPointType TransformPoint(const InputPointType &point) const
itk::AdvancedTranslationTransform::ScalarType
Superclass::ScalarType ScalarType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:78
itk::AdvancedTranslationTransform::operator=
void operator=(const Self &)
itk::AdvancedTransform< float, NDimensions, NDimensions >::JacobianOfSpatialJacobianType
std::vector< SpatialJacobianType > JacobianOfSpatialJacobianType
Definition: itkAdvancedTransform.h:144
itk::AdvancedTranslationTransform::GetJacobian
virtual void GetJacobian(const InputPointType &, JacobianType &, NonZeroJacobianIndicesType &) const
itk::AdvancedTransform< float, NDimensions, NDimensions >::NonZeroJacobianIndicesType
std::vector< unsigned long > NonZeroJacobianIndicesType
Definition: itkAdvancedTransform.h:141
itk
Definition: itkAdvancedImageToImageMetric.h:40
itk::AdvancedTranslationTransform::TransformVector
OutputVectorType TransformVector(const InputVectorType &vector) const
itk::AdvancedTransform< float, NDimensions, NDimensions >::OutputVectorType
Superclass::OutputVectorType OutputVectorType
Definition: itkAdvancedTransform.h:117
itk::AdvancedTranslationTransform::SetFixedParameters
virtual void SetFixedParameters(const ParametersType &)
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:234
itk::AdvancedTranslationTransform::BackTransform
InputVectorType BackTransform(const OutputVectorType &vector) const
itk::AdvancedTranslationTransform::ParametersType
Superclass::ParametersType ParametersType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:81
itk::AdvancedTranslationTransform::GetJacobianOfSpatialHessian
virtual void GetJacobianOfSpatialHessian(const InputPointType &ipp, SpatialHessianType &sh, JacobianOfSpatialHessianType &jsh, NonZeroJacobianIndicesType &nonZeroJacobianIndices) const
itk::AdvancedTranslationTransform::BackTransform
InputPointType BackTransform(const OutputPointType &point) const
Definition: Common/Transforms/itkAdvancedTranslationTransform.h:287
itk::AdvancedTransform< float, NDimensions, NDimensions >::NumberOfParametersType
Superclass::NumberOfParametersType NumberOfParametersType
Definition: itkAdvancedTransform.h:113
TScalarType
itk::AdvancedTranslationTransform::Self
AdvancedTranslationTransform Self
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:62
itk::AdvancedTranslationTransform::Translate
void Translate(const OutputVectorType &offset, bool pre=0)
itk::AdvancedTranslationTransform::SpatialHessianType
Superclass::SpatialHessianType SpatialHessianType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:109
itk::AdvancedTransform< float, NDimensions, NDimensions >::ParametersType
Superclass::ParametersType ParametersType
Definition: itkAdvancedTransform.h:110
itk::AdvancedTranslationTransform::GetSpatialHessian
virtual void GetSpatialHessian(const InputPointType &, SpatialHessianType &) const
itk::AdvancedTransform< float, NDimensions, NDimensions >::OutputVnlVectorType
Superclass::OutputVnlVectorType OutputVnlVectorType
Definition: itkAdvancedTransform.h:123
itk::AdvancedTranslationTransform::NonZeroJacobianIndicesType
Superclass ::NonZeroJacobianIndicesType NonZeroJacobianIndicesType
Definition: Components/Transforms/TranslationStackTransform/itkAdvancedTranslationTransform.h:105
itk::AdvancedTransform< float, NDimensions, NDimensions >::OutputCovariantVectorType
Superclass ::OutputCovariantVectorType OutputCovariantVectorType
Definition: itkAdvancedTransform.h:121
itk::AdvancedTranslationTransform::BackTransform
InputPointType BackTransform(const OutputPointType &point) const


Generated on OURCE_DATE_EPOCH for elastix by doxygen 1.8.18 elastix logo