itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension > Class Template Reference

#include <itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h>

Detailed Description

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

Modifies the UpdateTransformParameters method to perform a Gaussian smoothing of the displacement field after adding the update array.

This class is the same as DisplacementFieldTransform, except for the changes to UpdateTransformParameters. The method smooths the result of the addition of the update array and the displacement field, using a GaussianOperator filter.

To free the memory allocated and cached in GaussianSmoothDisplacementField on demand, see FreeGaussianSmoothingTempField.

Examples

SphinxExamples/src/Registration/Metricsv4/PerformRegistrationOnVectorImages/Code.cxx.

Definition at line 46 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

Inheritance diagram for itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >:

Collaboration diagram for itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	DerivativeValueType = typename DerivativeType::ValueType
using	DisplacementVectorType = typename DisplacementFieldType::PixelType
using	Pointer = SmartPointer< Self >
using	Self = GaussianSmoothingOnUpdateDisplacementFieldTransform
using	Superclass = DisplacementFieldTransform< TParametersValueType, VDimension >
using	TransformPointer = typename Transform< TParametersValueType, VDimension, VDimension >::Pointer
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 Member Functions
virtual DisplacementFieldPointer	GaussianSmoothDisplacementField (DisplacementFieldType *, ScalarType)
const char *	GetNameOfClass () const override
void	UpdateTransformParameters (const DerivativeType &update, ScalarType factor=1.0) override
virtual void	SetGaussianSmoothingVarianceForTheUpdateField (ScalarType _arg)
virtual const ScalarType &	GetGaussianSmoothingVarianceForTheUpdateField () const
virtual void	SetGaussianSmoothingVarianceForTheTotalField (ScalarType _arg)
virtual const ScalarType &	GetGaussianSmoothingVarianceForTheTotalField () const
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 ModifiedTimeType &	GetDisplacementFieldSetTime () 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
InverseTransformBasePointer	GetInverseTransform () const override
const char *	GetNameOfClass () const override
NumberOfParametersType	GetNumberOfLocalParameters () const override
TransformCategoryEnum	GetTransformCategory () const override
void	SetFixedParameters (const FixedParametersType &) 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 (DisplacementFieldType *field)
virtual void	SetDisplacementField (VectorImageDisplacementFieldType *field)
void	SetDisplacementField (std::nullptr_t)=delete
virtual DisplacementFieldType *	GetModifiableDisplacementField ()
virtual void	SetInverseDisplacementField (DisplacementFieldType *inverseField)
virtual DisplacementFieldType *	GetModifiableInverseDisplacementField ()
virtual void	SetInterpolator (InterpolatorType *interpolator)
virtual InterpolatorType *	GetModifiableInterpolator ()
virtual void	SetInverseInterpolator (InterpolatorType *interpolator)
virtual InterpolatorType *	GetModifiableInverseInterpolator ()
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 FixedParametersType &	GetFixedParameters () const override
unsigned int	GetInputSpaceDimension () const override
bool	GetInverse (Self *) const
const char *	GetNameOfClass () const override
virtual NumberOfParametersType	GetNumberOfFixedParameters () const
NumberOfParametersType	GetNumberOfParameters () const override
unsigned int	GetOutputSpaceDimension () const override
const ParametersType &	GetParameters () const override
TransformCategoryEnum	GetTransformCategory () const override
std::string	GetTransformTypeAsString () const override
virtual bool	IsLinear () const
	itkCloneMacro (Self)
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
template< typename TImage > std std::enable_if_t< TImage::ImageDimension==VInputDimension &&TImage::ImageDimension==VOutputDimension, void >	ApplyToImageMetadata (SmartPointer< TImage > image) const

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
static Pointer	New ()

Protected Types
using	GaussianSmoothingOperatorType = GaussianOperator< ScalarType, Superclass::Dimension >
using	GaussianSmoothingSmootherType = VectorNeighborhoodOperatorImageFilter< DisplacementFieldType, DisplacementFieldType >

Protected Member Functions
	GaussianSmoothingOnUpdateDisplacementFieldTransform ()
LightObject::Pointer	InternalClone () const override
void	PrintSelf (std::ostream &os, Indent indent) const override
	~GaussianSmoothingOnUpdateDisplacementFieldTransform () override=default
Protected Member Functions inherited from itk::DisplacementFieldTransform< TParametersValueType, VDimension >
	DisplacementFieldTransform ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~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 Attributes
GaussianSmoothingOperatorType	m_GaussianSmoothingOperator {}
ScalarType	m_GaussianSmoothingVarianceForTheTotalField {}
ScalarType	m_GaussianSmoothingVarianceForTheUpdateField {}
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

Additional Inherited Members
Public Attributes inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
InverseJacobianPositionType &jacobian	const
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
Static Protected Member Functions inherited from itk::Transform< TParametersValueType, VDimension, VDimension >
static InverseTransformBasePointer	InvertTransform (const TTransform &transform)

Member Typedef Documentation

ConstPointer

template<typename TParametersValueType , unsigned int VDimension>

using itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 56 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

DerivativeValueType

template<typename TParametersValueType , unsigned int VDimension>

using itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::DerivativeValueType = typename DerivativeType::ValueType

Definition at line 67 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

DisplacementVectorType

template<typename TParametersValueType , unsigned int VDimension>

using itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::DisplacementVectorType = typename DisplacementFieldType::PixelType

Definition at line 70 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

GaussianSmoothingOperatorType

template<typename TParametersValueType , unsigned int VDimension>

using itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::GaussianSmoothingOperatorType = GaussianOperator<ScalarType, Superclass::Dimension>

protected

Type of Gaussian Operator used during smoothing. Define here so we can use a member var during the operation.

Definition at line 125 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

GaussianSmoothingSmootherType

template<typename TParametersValueType , unsigned int VDimension>

using itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::GaussianSmoothingSmootherType = VectorNeighborhoodOperatorImageFilter<DisplacementFieldType, DisplacementFieldType>

protected

Definition at line 127 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

Pointer

template<typename TParametersValueType , unsigned int VDimension>

using itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::Pointer = SmartPointer<Self>

Definition at line 55 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

Self

template<typename TParametersValueType , unsigned int VDimension>

using itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::Self = GaussianSmoothingOnUpdateDisplacementFieldTransform

Standard class type aliases.

Definition at line 53 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

Superclass

template<typename TParametersValueType , unsigned int VDimension>

using itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::Superclass = DisplacementFieldTransform<TParametersValueType, VDimension>

Definition at line 54 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

TransformPointer

template<typename TParametersValueType , unsigned int VDimension>

using itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::TransformPointer = typename Transform<TParametersValueType, VDimension, VDimension>::Pointer

Definition at line 72 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

Constructor & Destructor Documentation

GaussianSmoothingOnUpdateDisplacementFieldTransform()

template<typename TParametersValueType , unsigned int VDimension>

itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::GaussianSmoothingOnUpdateDisplacementFieldTransform ( )

protected

~GaussianSmoothingOnUpdateDisplacementFieldTransform()

template<typename TParametersValueType , unsigned int VDimension>

itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::~GaussianSmoothingOnUpdateDisplacementFieldTransform ( )

overrideprotecteddefault

Member Function Documentation

GaussianSmoothDisplacementField()

template<typename TParametersValueType , unsigned int VDimension>

virtual DisplacementFieldPointer itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::GaussianSmoothDisplacementField ( DisplacementFieldType *  , ScalarType    )

virtual

Smooth the displacement field in-place. Uses m_GaussSmoothSigma to change the variance for the GaussianOperator.

Warning

Not thread safe. Does its own threading.

GetGaussianSmoothingVarianceForTheTotalField()

template<typename TParametersValueType , unsigned int VDimension>

virtual const ScalarType& itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::GetGaussianSmoothingVarianceForTheTotalField ( ) const

virtual

Get/Set the Gaussian smoothing standard deviation for the total field. Default = 0.5.

GetGaussianSmoothingVarianceForTheUpdateField()

template<typename TParametersValueType , unsigned int VDimension>

virtual const ScalarType& itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::GetGaussianSmoothingVarianceForTheUpdateField ( ) const

virtual

Get/Set the Gaussian smoothing standard deviation for the update field. Default = 1.75.

GetNameOfClass()

template<typename TParametersValueType , unsigned int VDimension>

const char* itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::GetNameOfClass ( ) const

override

See also

LightObject::GetNameOfClass()

InternalClone()

template<typename TParametersValueType , unsigned int VDimension>

LightObject::Pointer itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::InternalClone ( ) const

overrideprotected

Clone the current transform

New()

template<typename TParametersValueType , unsigned int VDimension>

static Pointer itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::New ( )

static

New macro for creation of through a Smart Pointer

PrintSelf()

template<typename TParametersValueType , unsigned int VDimension>

void itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotected

SetGaussianSmoothingVarianceForTheTotalField()

template<typename TParametersValueType , unsigned int VDimension>

virtual void itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::SetGaussianSmoothingVarianceForTheTotalField ( ScalarType  _arg )

virtual

Get/Set the Gaussian smoothing standard deviation for the total field. Default = 0.5.

SetGaussianSmoothingVarianceForTheUpdateField()

template<typename TParametersValueType , unsigned int VDimension>

virtual void itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::SetGaussianSmoothingVarianceForTheUpdateField ( ScalarType  _arg )

virtual

Get/Set the Gaussian smoothing standard deviation for the update field. Default = 1.75.

UpdateTransformParameters()

template<typename TParametersValueType , unsigned int VDimension>

void itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::UpdateTransformParameters ( const DerivativeType &  update, ScalarType  factor = 1.0  )

overridevirtual

Update the transform's parameters by the values in update. We assume update is of the same length as Parameters. Throw exception otherwise. factor is a scalar multiplier for each value in update. GaussianSmoothDisplacementField is called after the update is added to the field. See base class for more details.

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

Member Data Documentation

m_GaussianSmoothingOperator

template<typename TParametersValueType , unsigned int VDimension>

GaussianSmoothingOperatorType itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::m_GaussianSmoothingOperator {}

protected

Definition at line 128 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

m_GaussianSmoothingVarianceForTheTotalField

template<typename TParametersValueType , unsigned int VDimension>

ScalarType itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::m_GaussianSmoothingVarianceForTheTotalField {}

protected

Definition at line 121 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

m_GaussianSmoothingVarianceForTheUpdateField

template<typename TParametersValueType , unsigned int VDimension>

ScalarType itk::GaussianSmoothingOnUpdateDisplacementFieldTransform< TParametersValueType, VDimension >::m_GaussianSmoothingVarianceForTheUpdateField {}

protected

Used in GaussianSmoothDisplacementField as variance for the GaussianOperator

Definition at line 120 of file itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h.

---

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

• itkGaussianSmoothingOnUpdateDisplacementFieldTransform.h