ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::VelocityFieldTransform< TParametersValueType, VDimension > Class Template Reference

#include <itkVelocityFieldTransform.h>

+ Inheritance diagram for itk::VelocityFieldTransform< TParametersValueType, VDimension >:
+ Collaboration diagram for itk::VelocityFieldTransform< TParametersValueType, VDimension >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DirectionType = typename VelocityFieldType::DirectionType
 
using DisplacementFieldPointer = typename DisplacementFieldType::Pointer
 
using IndexType = typename VelocityFieldType::IndexType
 
using OptimizerParametersHelperType = ImageVectorOptimizerParametersHelper< ScalarType, Dimension, VelocityFieldDimension >
 
using PixelType = typename VelocityFieldType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename VelocityFieldType::PointType
 
using RegionType = typename VelocityFieldType::RegionType
 
using Self = VelocityFieldTransform
 
using SizeType = typename VelocityFieldType::SizeType
 
using SpacingType = typename VelocityFieldType::SpacingType
 
using Superclass = DisplacementFieldTransform< TParametersValueType, VDimension >
 
using VelocityFieldInterpolatorPointer = typename VelocityFieldInterpolatorType::Pointer
 
using VelocityFieldInterpolatorType = VectorInterpolateImageFunction< VelocityFieldType, ScalarType >
 
using VelocityFieldPointer = typename VelocityFieldType::Pointer
 
using VelocityFieldType = Image< OutputVectorType, VelocityFieldDimension >
 
- Public Types inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
using ConstPointer = SmartPointer< const Self >
 
using DirectionType = typename DisplacementFieldType::DirectionType
 
using DisplacementFieldConstPointer = typename DisplacementFieldType::ConstPointer
 
using DisplacementFieldPointer = typename DisplacementFieldType::Pointer
 
using DisplacementFieldType = Image< OutputVectorType, Dimension >
 
using IndexType = typename DisplacementFieldType::IndexType
 
using InputTensorEigenVectorType = CovariantVector< ScalarType, InputDiffusionTensor3DType::Dimension >
 
using InterpolatorType = VectorInterpolateImageFunction< DisplacementFieldType, ScalarType >
 
using OptimizerParametersHelperType = ImageVectorOptimizerParametersHelper< ScalarType, OutputVectorType::Dimension, Dimension >
 
using OutputTensorEigenVectorType = CovariantVector< ScalarType, OutputDiffusionTensor3DType::Dimension >
 
using PixelType = typename DisplacementFieldType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename DisplacementFieldType::PointType
 
using RegionType = typename DisplacementFieldType::RegionType
 
using Self = DisplacementFieldTransform
 
using SizeType = typename DisplacementFieldType::SizeType
 
using SpacingType = typename DisplacementFieldType::SpacingType
 
using Superclass = Transform< TParametersValueType, VDimension, VDimension >
 
using VectorImageDisplacementFieldType = VectorImage< TParametersValueType, Dimension >
 
- Public Types inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
using ConstPointer = SmartPointer< const Self >
 
using DerivativeType = Array< ParametersValueType >
 
using DirectionChangeMatrix = Matrix< double, Self::OutputSpaceDimension, Self::InputSpaceDimension >
 
using InputCovariantVectorType = CovariantVector< TParametersValueType, VInputDimension >
 
using InputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using InputDirectionMatrix = Matrix< double, Self::InputSpaceDimension, Self::InputSpaceDimension >
 
using InputPointType = Point< TParametersValueType, VInputDimension >
 
using InputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VInputDimension >
 
using InputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using InputVectorType = Vector< TParametersValueType, VInputDimension >
 
using InputVnlVectorType = vnl_vector_fixed< TParametersValueType, VInputDimension >
 
using InverseJacobianPositionType = vnl_matrix_fixed< ParametersValueType, VInputDimension, VOutputDimension >
 
using InverseTransformBasePointer = typename InverseTransformBaseType::Pointer
 
using InverseTransformBaseType = Transform< TParametersValueType, VOutputDimension, VInputDimension >
 
using JacobianPositionType = vnl_matrix_fixed< ParametersValueType, VOutputDimension, VInputDimension >
 
using JacobianType = Array2D< ParametersValueType >
 
using MatrixType = Matrix< TParametersValueType, Self::OutputSpaceDimension, Self::InputSpaceDimension >
 
using OutputCovariantVectorType = CovariantVector< TParametersValueType, VOutputDimension >
 
using OutputDiffusionTensor3DType = DiffusionTensor3D< TParametersValueType >
 
using OutputDirectionMatrix = Matrix< double, Self::OutputSpaceDimension, Self::OutputSpaceDimension >
 
using OutputPointType = Point< TParametersValueType, VOutputDimension >
 
using OutputSymmetricSecondRankTensorType = SymmetricSecondRankTensor< TParametersValueType, VOutputDimension >
 
using OutputVectorPixelType = VariableLengthVector< TParametersValueType >
 
using OutputVectorType = Vector< TParametersValueType, VOutputDimension >
 
using OutputVnlVectorType = vnl_vector_fixed< TParametersValueType, VOutputDimension >
 
using Pointer = SmartPointer< Self >
 
using ScalarType = ParametersValueType
 
using Self = Transform
 
using Superclass = TransformBaseTemplate< TParametersValueType >
 
- Public Types inherited from itk::TransformBaseTemplate< TParametersValueType >
using ConstPointer = SmartPointer< const Self >
 
using FixedParametersType = OptimizerParameters< FixedParametersValueType >
 
using FixedParametersValueType = double
 
using NumberOfParametersType = IdentifierType
 
using ParametersType = OptimizerParameters< ParametersValueType >
 
using ParametersValueType = TParametersValueType
 
using Pointer = SmartPointer< Self >
 
using Self = TransformBaseTemplate
 
using Superclass = Object
 
using TransformCategoryEnum = TransformBaseTemplateEnums::TransformCategory
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

bool GetInverse (Self *inverse) const
 
InverseTransformBasePointer GetInverseTransform () const override
 
virtual ScalarType GetLowerTimeBound () const
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfIntegrationSteps () const
 
virtual ScalarType GetUpperTimeBound () const
 
virtual const unsigned long & GetVelocityFieldSetTime () const
 
virtual void IntegrateVelocityField ()
 
void SetFixedParameters (const FixedParametersType &) override
 
virtual void SetLowerTimeBound (ScalarType _arg)
 
virtual void SetNumberOfIntegrationSteps (unsigned int _arg)
 
virtual void SetUpperTimeBound (ScalarType _arg)
 
void UpdateTransformParameters (const DerivativeType &update, ScalarType factor=1.0) override
 
virtual void SetVelocityField (VelocityFieldType *)
 
virtual VelocityFieldTypeGetModifiableVelocityField ()
 
virtual void SetVelocityFieldInterpolator (VelocityFieldInterpolatorType *)
 
virtual VelocityFieldInterpolatorTypeGetModifiableVelocityFieldInterpolator ()
 
void SetDisplacementField (DisplacementFieldType *displacementField) override
 
- Public Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
void ComputeInverseJacobianWithRespectToPosition (const InputPointType &point, InverseJacobianPositionType &jacobian) const override
 
virtual void ComputeJacobianWithRespectToParameters (const IndexType &, JacobianType &j) const
 
virtual void ComputeJacobianWithRespectToPosition (const IndexType &index, JacobianPositionType &jacobian) const
 
void ComputeJacobianWithRespectToPosition (const InputPointType &point, JacobianPositionType &jacobian) const override
 
virtual const ModifiedTimeTypeGetDisplacementFieldSetTime () const
 
bool GetInverse (Self *inverse) const
 
virtual void GetInverseJacobianOfForwardFieldWithRespectToPosition (const IndexType &index, JacobianPositionType &jacobian, bool useSVD=false) const
 
virtual void GetInverseJacobianOfForwardFieldWithRespectToPosition (const InputPointType &point, JacobianPositionType &jacobian, bool useSVD=false) const
 
NumberOfParametersType GetNumberOfLocalParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
virtual void SetIdentity ()
 
OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &) const override
 
OutputVectorPixelType TransformDiffusionTensor (const InputVectorPixelType &) const
 
OutputPointType TransformPoint (const InputPointType &inputPoint) const override
 
OutputVectorPixelType TransformVector (const InputVectorPixelType &) const override
 
OutputVnlVectorType TransformVector (const InputVnlVectorType &) const override
 
virtual void SetDisplacementField (VectorImageDisplacementFieldType *field)
 
void SetDisplacementField (std::nullptr_t)=delete
 
virtual DisplacementFieldTypeGetModifiableDisplacementField ()
 
virtual void SetInverseDisplacementField (DisplacementFieldType *inverseField)
 
virtual DisplacementFieldTypeGetModifiableInverseDisplacementField ()
 
virtual void SetInterpolator (InterpolatorType *interpolator)
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual void SetInverseInterpolator (InterpolatorType *interpolator)
 
virtual InterpolatorTypeGetModifiableInverseInterpolator ()
 
OutputVectorType TransformVector (const InputVectorType &) const override
 
OutputDiffusionTensor3DType TransformDiffusionTensor (const InputDiffusionTensor3DType &) const
 
OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &) const override
 
void SetParameters (const ParametersType &params) override
 
void ComputeJacobianWithRespectToParameters (const InputPointType &, JacobianType &j) const override
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
virtual void ComputeJacobianWithRespectToParametersCachedTemporaries (const InputPointType &p, JacobianType &jacobian, JacobianType &) const
 
void CopyInFixedParameters (const FixedParametersValueType *const begin, const FixedParametersValueType *const end) override
 
void CopyInParameters (const ParametersValueType *const begin, const ParametersValueType *const end) override
 
const FixedParametersTypeGetFixedParameters () const override
 
unsigned int GetInputSpaceDimension () const override
 
bool GetInverse (Self *) const
 
virtual NumberOfParametersType GetNumberOfFixedParameters () const
 
NumberOfParametersType GetNumberOfParameters () const override
 
unsigned int GetOutputSpaceDimension () const override
 
const ParametersTypeGetParameters () const override
 
TransformCategoryEnum GetTransformCategory () const override
 
std::string GetTransformTypeAsString () const override
 
virtual bool IsLinear () const
 
 itkCloneMacro (Self)
 
void SetFixedParameters (const FixedParametersType &) override=0
 
void SetParameters (const ParametersType &) override=0
 
void SetParametersByValue (const ParametersType &p) override
 
virtual OutputCovariantVectorType TransformCovariantVector (const InputCovariantVectorType &vector, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformCovariantVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &) const
 
virtual OutputDiffusionTensor3DType TransformDiffusionTensor3D (const InputDiffusionTensor3DType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformDiffusionTensor3D (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &) const
 
virtual OutputSymmetricSecondRankTensorType TransformSymmetricSecondRankTensor (const InputSymmetricSecondRankTensorType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &) const
 
virtual OutputVectorPixelType TransformSymmetricSecondRankTensor (const InputVectorPixelType &inputTensor, const InputPointType &point) const
 
virtual OutputVectorPixelType TransformVector (const InputVectorPixelType &vector, const InputPointType &point) const
 
virtual OutputVectorType TransformVector (const InputVectorType &vector, const InputPointType &point) const
 
virtual OutputVnlVectorType TransformVector (const InputVnlVectorType &vector, const InputPointType &point) const
 
 itkLegacyMacro (virtual void ComputeJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
 itkLegacyMacro (virtual void ComputeInverseJacobianWithRespectToPosition(const InputPointType &x, JacobianType &jacobian) const)
 
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (TImage *image) const
 
std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void > ApplyToImageMetadata (SmartPointer< TImage > image) const
 
- Public Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
virtual void SetParametersByValue (const ParametersType &p)=0
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int Dimension = VDimension
 
static constexpr unsigned int VelocityFieldDimension = VDimension + 1
 
- Static Public Attributes inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
static constexpr unsigned int Dimension = VDimension
 
- Static Public Attributes inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
static constexpr unsigned int InputSpaceDimension
 
static constexpr unsigned int OutputSpaceDimension
 

Protected Member Functions

DisplacementFieldType::Pointer CopyDisplacementField (const DisplacementFieldType *) const
 
LightObject::Pointer InternalClone () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 VelocityFieldTransform ()
 
 ~VelocityFieldTransform () override=default
 
- Protected Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
 DisplacementFieldTransform ()
 
 ~DisplacementFieldTransform () override=default
 
- Protected Member Functions inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
LightObject::Pointer InternalClone () const override
 
OutputDiffusionTensor3DType PreservationOfPrincipalDirectionDiffusionTensor3DReorientation (const InputDiffusionTensor3DType &, const InverseJacobianPositionType &) const
 
 Transform ()=default
 
 Transform (NumberOfParametersType numberOfParameters)
 
 ~Transform () override=default
 
- Protected Member Functions inherited from itk::TransformBaseTemplate< TParametersValueType >
 TransformBaseTemplate ()=default
 
 ~TransformBaseTemplate () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

ScalarType m_LowerTimeBound
 
unsigned int m_NumberOfIntegrationSteps
 
ScalarType m_UpperTimeBound
 
VelocityFieldPointer m_VelocityField
 
VelocityFieldInterpolatorType::Pointer m_VelocityFieldInterpolator
 
unsigned long m_VelocityFieldSetTime
 
- Protected Attributes inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
DisplacementFieldType::Pointer m_DisplacementField
 
ModifiedTimeType m_DisplacementFieldSetTime { 0 }
 
JacobianType m_IdentityJacobian
 
InterpolatorType::Pointer m_Interpolator
 
DisplacementFieldType::Pointer m_InverseDisplacementField
 
InterpolatorType::Pointer m_InverseInterpolator
 
- Protected Attributes inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
FixedParametersType m_FixedParameters
 
ParametersType m_Parameters
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Private Member Functions

virtual void SetFixedParametersFromVelocityField () const
 

Detailed Description

template<typename TParametersValueType, unsigned int VDimension>
class itk::VelocityFieldTransform< TParametersValueType, VDimension >

Provides local/dense/high-dimensionality transformation via a a velocity field.

Author
Nick Tustison
Brian Avants

Definition at line 36 of file itkVelocityFieldTransform.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 45 of file itkVelocityFieldTransform.h.

◆ DirectionType

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::DirectionType = typename VelocityFieldType::DirectionType

Definition at line 107 of file itkVelocityFieldTransform.h.

◆ DisplacementFieldPointer

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::DisplacementFieldPointer = typename DisplacementFieldType::Pointer

Definition at line 93 of file itkVelocityFieldTransform.h.

◆ IndexType

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::IndexType = typename VelocityFieldType::IndexType

Standard types for the velocity Field

Definition at line 103 of file itkVelocityFieldTransform.h.

◆ OptimizerParametersHelperType

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::OptimizerParametersHelperType = ImageVectorOptimizerParametersHelper<ScalarType, Dimension, VelocityFieldDimension>

Define the internal parameter helper used to access the field

Definition at line 116 of file itkVelocityFieldTransform.h.

◆ PixelType

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::PixelType = typename VelocityFieldType::PixelType

Definition at line 109 of file itkVelocityFieldTransform.h.

◆ Pointer

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::Pointer = SmartPointer<Self>

Definition at line 44 of file itkVelocityFieldTransform.h.

◆ PointType

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::PointType = typename VelocityFieldType::PointType

Definition at line 108 of file itkVelocityFieldTransform.h.

◆ RegionType

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::RegionType = typename VelocityFieldType::RegionType

Definition at line 104 of file itkVelocityFieldTransform.h.

◆ Self

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::Self = VelocityFieldTransform

Standard class type aliases.

Definition at line 42 of file itkVelocityFieldTransform.h.

◆ SizeType

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::SizeType = typename VelocityFieldType::SizeType

Definition at line 105 of file itkVelocityFieldTransform.h.

◆ SpacingType

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::SpacingType = typename VelocityFieldType::SpacingType

Definition at line 106 of file itkVelocityFieldTransform.h.

◆ Superclass

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::Superclass = DisplacementFieldTransform<TParametersValueType, VDimension>

Definition at line 43 of file itkVelocityFieldTransform.h.

◆ VelocityFieldInterpolatorPointer

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldInterpolatorPointer = typename VelocityFieldInterpolatorType::Pointer

Definition at line 112 of file itkVelocityFieldTransform.h.

◆ VelocityFieldInterpolatorType

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldInterpolatorType = VectorInterpolateImageFunction<VelocityFieldType, ScalarType>

Definition at line 111 of file itkVelocityFieldTransform.h.

◆ VelocityFieldPointer

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldPointer = typename VelocityFieldType::Pointer

Definition at line 100 of file itkVelocityFieldTransform.h.

◆ VelocityFieldType

template<typename TParametersValueType , unsigned int VDimension>
using itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldType = Image<OutputVectorType, VelocityFieldDimension>

Define the displacement field type and corresponding interpolator type.

Definition at line 99 of file itkVelocityFieldTransform.h.

Constructor & Destructor Documentation

◆ VelocityFieldTransform()

template<typename TParametersValueType , unsigned int VDimension>
itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldTransform ( )
protected

◆ ~VelocityFieldTransform()

template<typename TParametersValueType , unsigned int VDimension>
itk::VelocityFieldTransform< TParametersValueType, VDimension >::~VelocityFieldTransform ( )
overrideprotecteddefault

Member Function Documentation

◆ CopyDisplacementField()

template<typename TParametersValueType , unsigned int VDimension>
DisplacementFieldType::Pointer itk::VelocityFieldTransform< TParametersValueType, VDimension >::CopyDisplacementField ( const DisplacementFieldType ) const
protected

◆ GetInverse()

template<typename TParametersValueType , unsigned int VDimension>
bool itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetInverse ( Self inverse) const

Return an inverse of this transform.

◆ GetInverseTransform()

template<typename TParametersValueType , unsigned int VDimension>
InverseTransformBasePointer itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetInverseTransform ( ) const
overridevirtual

Return an inverse of this transform.

Reimplemented from itk::DisplacementFieldTransform< TParametersValueType, VDimension >.

◆ GetLowerTimeBound()

template<typename TParametersValueType , unsigned int VDimension>
virtual ScalarType itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetLowerTimeBound ( ) const
virtual

Get the lower time bound defining the integration domain of the transform. We assume that the total possible time domain is [0,1]

◆ GetModifiableVelocityField()

template<typename TParametersValueType , unsigned int VDimension>
virtual VelocityFieldType* itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetModifiableVelocityField ( )
virtual

Get/Set the velocity field. Set the displacement field. Create special set accessor to update interpolator and assign displacement field to transform parameters container.

◆ GetModifiableVelocityFieldInterpolator()

template<typename TParametersValueType , unsigned int VDimension>
virtual VelocityFieldInterpolatorType* itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetModifiableVelocityFieldInterpolator ( )
virtual

Get/Set the interpolator. Create out own set accessor that assigns the velocity field

◆ GetNameOfClass()

template<typename TParametersValueType , unsigned int VDimension>
virtual const char* itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetNameOfClass ( ) const
virtual

◆ GetNumberOfIntegrationSteps()

template<typename TParametersValueType , unsigned int VDimension>
virtual unsigned int itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetNumberOfIntegrationSteps ( ) const
virtual

Get the number of integration steps. Default = 100;

◆ GetUpperTimeBound()

template<typename TParametersValueType , unsigned int VDimension>
virtual ScalarType itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetUpperTimeBound ( ) const
virtual

Get the upper time bound defining the integration domain of the transform. We assume that the total possible time domain is [0,1]

◆ GetVelocityFieldSetTime()

template<typename TParametersValueType , unsigned int VDimension>
virtual const unsigned long& itk::VelocityFieldTransform< TParametersValueType, VDimension >::GetVelocityFieldSetTime ( ) const
virtual

Get the modification time of velocity field

◆ IntegrateVelocityField()

template<typename TParametersValueType , unsigned int VDimension>
virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::IntegrateVelocityField ( )
inlinevirtual

Trigger the computation of the displacement field by integrating the velocity field.

Reimplemented in itk::TimeVaryingBSplineVelocityFieldTransform< TParametersValueType, VDimension >, and itk::TimeVaryingVelocityFieldTransform< TParametersValueType, VDimension >.

Definition at line 172 of file itkVelocityFieldTransform.h.

◆ InternalClone()

template<typename TParametersValueType , unsigned int VDimension>
LightObject::Pointer itk::VelocityFieldTransform< TParametersValueType, VDimension >::InternalClone ( ) const
overrideprotectedvirtual

Clone the current transform

Reimplemented from itk::LightObject.

◆ New()

template<typename TParametersValueType , unsigned int VDimension>
static Pointer itk::VelocityFieldTransform< TParametersValueType, VDimension >::New ( )
static

New macro for creation of through a Smart Pointer

◆ PrintSelf()

template<typename TParametersValueType , unsigned int VDimension>
void itk::VelocityFieldTransform< TParametersValueType, VDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::DisplacementFieldTransform< TParametersValueType, VDimension >.

◆ SetDisplacementField()

template<typename TParametersValueType , unsigned int VDimension>
void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetDisplacementField ( DisplacementFieldType displacementField)
inlineoverridevirtual

Set the deformation field. We want to override the base class implementation since we don't want to optimize over the deformation field for this class but rather the time-varying velocity field

Reimplemented from itk::DisplacementFieldTransform< TParametersValueType, VDimension >.

Definition at line 148 of file itkVelocityFieldTransform.h.

◆ SetFixedParameters()

template<typename TParametersValueType , unsigned int VDimension>
void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetFixedParameters ( const FixedParametersType )
overridevirtual

This method sets the fixed parameters of the transform. For a displacement field transform, the fixed parameters are the following: field size, field origin, field spacing, and field direction.

Note: If a displacement field already exists, this function creates a new one with zero displacement (identity transform). If an inverse displacement field exists, a new one is also created.

Reimplemented from itk::DisplacementFieldTransform< TParametersValueType, VDimension >.

◆ SetFixedParametersFromVelocityField()

template<typename TParametersValueType , unsigned int VDimension>
virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetFixedParametersFromVelocityField ( ) const
privatevirtual

Convenience method which reads the information from the current velocity field into m_FixedParameters.

◆ SetLowerTimeBound()

template<typename TParametersValueType , unsigned int VDimension>
virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetLowerTimeBound ( ScalarType  _arg)
virtual

Set the lower time bound defining the integration domain of the transform. We assume that the total possible time domain is [0,1]

◆ SetNumberOfIntegrationSteps()

template<typename TParametersValueType , unsigned int VDimension>
virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetNumberOfIntegrationSteps ( unsigned int  _arg)
virtual

Set the number of integration steps. Default = 100;

◆ SetUpperTimeBound()

template<typename TParametersValueType , unsigned int VDimension>
virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetUpperTimeBound ( ScalarType  _arg)
virtual

Set the upper time bound defining the integration domain of the transform. We assume that the total possible time domain is [0,1]

◆ SetVelocityField()

template<typename TParametersValueType , unsigned int VDimension>
virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetVelocityField ( VelocityFieldType )
virtual

Get/Set the velocity field. Set the displacement field. Create special set accessor to update interpolator and assign displacement field to transform parameters container.

◆ SetVelocityFieldInterpolator()

template<typename TParametersValueType , unsigned int VDimension>
virtual void itk::VelocityFieldTransform< TParametersValueType, VDimension >::SetVelocityFieldInterpolator ( VelocityFieldInterpolatorType )
virtual

Get/Set the interpolator. Create out own set accessor that assigns the velocity field

◆ UpdateTransformParameters()

template<typename TParametersValueType , unsigned int VDimension>
void itk::VelocityFieldTransform< TParametersValueType, VDimension >::UpdateTransformParameters ( const DerivativeType update,
ScalarType  factor = 1.0 
)
overridevirtual

Update the transform's parameters by the values in update.

Parameters
updatemust be of the same length as returned by GetNumberOfParameters(). Throw an exception otherwise.
factoris a scalar multiplier for each value in update. SetParameters is called at the end of this method, to allow the transform to perform any required operations on the updated parameters - typically a conversion to member variables for use in TransformPoint.

Reimplemented from itk::DisplacementFieldTransform< TParametersValueType, VDimension >.

Member Data Documentation

◆ Dimension

template<typename TParametersValueType , unsigned int VDimension>
constexpr unsigned int itk::VelocityFieldTransform< TParametersValueType, VDimension >::Dimension = VDimension
staticconstexpr

Dimension of the vector spaces.

Definition at line 89 of file itkVelocityFieldTransform.h.

◆ m_LowerTimeBound

template<typename TParametersValueType , unsigned int VDimension>
ScalarType itk::VelocityFieldTransform< TParametersValueType, VDimension >::m_LowerTimeBound
protected

Definition at line 221 of file itkVelocityFieldTransform.h.

◆ m_NumberOfIntegrationSteps

template<typename TParametersValueType , unsigned int VDimension>
unsigned int itk::VelocityFieldTransform< TParametersValueType, VDimension >::m_NumberOfIntegrationSteps
protected

Definition at line 224 of file itkVelocityFieldTransform.h.

◆ m_UpperTimeBound

template<typename TParametersValueType , unsigned int VDimension>
ScalarType itk::VelocityFieldTransform< TParametersValueType, VDimension >::m_UpperTimeBound
protected

Definition at line 222 of file itkVelocityFieldTransform.h.

◆ m_VelocityField

template<typename TParametersValueType , unsigned int VDimension>
VelocityFieldPointer itk::VelocityFieldTransform< TParametersValueType, VDimension >::m_VelocityField
protected

Definition at line 226 of file itkVelocityFieldTransform.h.

◆ m_VelocityFieldInterpolator

template<typename TParametersValueType , unsigned int VDimension>
VelocityFieldInterpolatorType::Pointer itk::VelocityFieldTransform< TParametersValueType, VDimension >::m_VelocityFieldInterpolator
protected

The interpolator.

Definition at line 229 of file itkVelocityFieldTransform.h.

◆ m_VelocityFieldSetTime

template<typename TParametersValueType , unsigned int VDimension>
unsigned long itk::VelocityFieldTransform< TParametersValueType, VDimension >::m_VelocityFieldSetTime
protected

Track when the VELOCITY field was last set/assigned, as distinct from when it may have had its contents modified.

Definition at line 233 of file itkVelocityFieldTransform.h.

◆ VelocityFieldDimension

template<typename TParametersValueType , unsigned int VDimension>
constexpr unsigned int itk::VelocityFieldTransform< TParametersValueType, VDimension >::VelocityFieldDimension = VDimension + 1
staticconstexpr

Dimension of the velocity field .

Definition at line 86 of file itkVelocityFieldTransform.h.


The documentation for this class was generated from the following file: