ITK  4.6.0
Insight Segmentation and Registration Toolkit
itkVelocityFieldTransform.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
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 __itkVelocityFieldTransform_h
19 #define __itkVelocityFieldTransform_h
20 
22 
23 namespace itk
24 {
25 
35 template
36 <class TScalar, unsigned int NDimensions>
38  public DisplacementFieldTransform<TScalar, NDimensions>
39 {
40 public:
46 
49 
51  itkNewMacro( Self );
52 
55 
58 
62 
65 
68 
72 
76 
79 
82 
84  itkStaticConstMacro( VelocityFieldDimension, unsigned int, NDimensions + 1 );
85 
87  itkStaticConstMacro( Dimension, unsigned int, NDimensions );
88 
92 
96 
105 
108 
112 
117  virtual void SetVelocityField( VelocityFieldType * );
118  itkGetModifiableObjectMacro(VelocityField, VelocityFieldType );
120 
121  virtual void SetFixedParameters( const ParametersType & );
122 
126  itkGetModifiableObjectMacro(VelocityFieldInterpolator, VelocityFieldInterpolatorType );
128 
130  itkGetConstReferenceMacro( VelocityFieldSetTime, unsigned long );
131 
137  itkSetObjectMacro( DisplacementField, DisplacementFieldType );
138 
139  virtual void UpdateTransformParameters( const DerivativeType & update, ScalarType factor = 1.0 );
140 
142  bool GetInverse( Self *inverse ) const;
143 
146 
148  virtual void IntegrateVelocityField() {};
149 
154  itkSetClampMacro( LowerTimeBound, ScalarType, 0.0, 1.0 );
155 
160  itkGetConstMacro( LowerTimeBound, ScalarType );
161 
166  itkSetClampMacro( UpperTimeBound, ScalarType, 0.0, 1.0 );
167 
172  itkGetConstMacro( UpperTimeBound, ScalarType );
173 
177  itkSetMacro( NumberOfIntegrationSteps, unsigned int );
178 
182  itkGetConstMacro( NumberOfIntegrationSteps, unsigned int );
183 
184 protected:
185 
187  virtual ~VelocityFieldTransform();
188  void PrintSelf( std::ostream& os, Indent indent ) const;
189 
191  virtual typename LightObject::Pointer InternalClone() const;
192 
193  typename DisplacementFieldType::Pointer CopyDisplacementField( const DisplacementFieldType * ) const;
194 
197 
199 
201 
204 
207  unsigned long m_VelocityFieldSetTime;
208 
209 private:
210  VelocityFieldTransform( const Self & ); // purposely not implemented
211  void operator=( const Self & ); // purposely not implemented
212 
217  virtual void SetFixedParametersFromVelocityField() const;
218 
219 };
220 } // end namespace itk
221 
222 #ifndef ITK_MANUAL_INSTANTIATION
223 #include "itkVelocityFieldTransform.hxx"
224 #endif
225 
226 #endif // __itkVelocityFieldTransform_h
Superclass::ParametersValueType ParametersValueType
static const unsigned int Dimension
Superclass::RegionType RegionType
Definition: itkImage.h:140
static const unsigned int VelocityFieldDimension
Superclass::InputVectorType InputVectorType
Light weight base class for most itk classes.
VelocityFieldInterpolatorType::Pointer m_VelocityFieldInterpolator
Superclass::InverseTransformBasePointer InverseTransformBasePointer
VelocityFieldType::DirectionType DirectionType
Represent the size (bounds) of a n-dimensional image.
Definition: itkSize.h:52
Superclass::OutputVectorPixelType OutputVectorPixelType
Superclass::InputVectorPixelType InputVectorPixelType
Provides local/dense/high-dimensionaltiy transformation via a a displacement field.
Superclass::NumberOfParametersType NumberOfParametersType
Image< OutputVectorType, Dimension > DisplacementFieldType
Superclass::OutputVectorType OutputVectorType
virtual void SetVelocityField(VelocityFieldType *)
VelocityFieldType::PixelType PixelType
Superclass::ParametersValueType ParametersValueType
Superclass::TransformCategoryType TransformCategoryType
virtual void SetFixedParameters(const ParametersType &)
DisplacementFieldType::Pointer DisplacementFieldPointer
TPixel PixelType
Definition: itkImage.h:89
virtual LightObject::Pointer InternalClone() const
virtual void SetFixedParametersFromVelocityField() const
VelocityFieldType::IndexType IndexType
Image< OutputVectorType, VelocityFieldDimension > VelocityFieldType
ImageVectorOptimizerParametersHelper< ScalarType, Dimension, VelocityFieldDimension > OptimizerParametersHelperType
VelocityFieldInterpolatorType::Pointer VelocityFieldInterpolatorPointer
Superclass::InputPointType InputPointType
VectorInterpolateImageFunction< VelocityFieldType, ScalarType > VelocityFieldInterpolatorType
Class to hold and manage parameters of type Image&lt;Vector&lt;...&gt;,...&gt;, used in Transforms, etc.
Class to hold and manage different parameter types used during optimization.
DisplacementFieldType::Pointer CopyDisplacementField(const DisplacementFieldType *) const
Superclass::TransformCategoryType TransformCategoryType
virtual void UpdateTransformParameters(const DerivativeType &update, ScalarType factor=1.0)
Superclass::IndexType IndexType
Definition: itkImage.h:122
Superclass::OutputPointType OutputPointType
Superclass::DerivativeType DerivativeType
Superclass::NumberOfParametersType NumberOfParametersType
void operator=(const Self &)
Superclass::OutputVectorType OutputVectorType
Superclass::OutputVectorPixelType OutputVectorPixelType
virtual InverseTransformBasePointer GetInverseTransform() const
void PrintSelf(std::ostream &os, Indent indent) const
Superclass::InputVectorPixelType InputVectorPixelType
Superclass::ParametersType ParametersType
VelocityFieldType::SizeType SizeType
Superclass::InverseTransformBasePointer InverseTransformBasePointer
VelocityFieldType::Pointer VelocityFieldPointer
DisplacementFieldTransform< TScalar, NDimensions > Superclass
Control indentation during Print() invocation.
Definition: itkIndent.h:49
Base class for all vector image interpolaters.
virtual void SetVelocityFieldInterpolator(VelocityFieldInterpolatorType *)
VelocityFieldType::PointType PointType
Superclass::DisplacementFieldType DisplacementFieldType
VelocityFieldType::RegionType RegionType
Templated n-dimensional image class.
Definition: itkImage.h:75
Provides local/dense/high-dimensionality transformation via a a velocity field.
VelocityFieldType::SpacingType SpacingType
SmartPointer< const Self > ConstPointer
bool GetInverse(Self *inverse) const