Class DisplacementFieldTransform

java.lang.Object

org.itk.simple.Transform

org.itk.simple.DisplacementFieldTransform

public class DisplacementFieldTransform
extends Transform

A dense deformable transform over a bounded spatial domain for 2D or 3D coordinates space. See: itk::DisplacementFieldTransform C++ includes: sitkDisplacementFieldTransform.h

Field Summary

Fields inherited from class Transform

swigCMemOwn

Modifier and Type	Field	Description
protected boolean	swigCMemOwn

Constructor Summary

Constructors

Modifier	Constructor	Description
	DisplacementFieldTransform(long dimensions)	itk::simple::DisplacementFieldTransform::DisplacementFieldTransform(unsigned int dimensions)
protected	DisplacementFieldTransform(long cPtr, boolean cMemoryOwn)
	DisplacementFieldTransform(DisplacementFieldTransform arg0)	itk::simple::DisplacementFieldTransform::DisplacementFieldTransform(unsigned int dimensions)
	DisplacementFieldTransform(Image arg0)	itk::simple::DisplacementFieldTransform::DisplacementFieldTransform(unsigned int dimensions)
	DisplacementFieldTransform(Transform arg0)	itk::simple::DisplacementFieldTransform::DisplacementFieldTransform(unsigned int dimensions)

Method Summary

Modifier and Type	Method	Description
void	delete()	itk::simple::DisplacementFieldTransform::~DisplacementFieldTransform() override
protected void	finalize()
protected static long	getCPtr(DisplacementFieldTransform obj)
Image	getDisplacementField()	Image itk::simple::DisplacementFieldTransform::GetDisplacementField() const Todo The returned image should not directly modify the internal displacement field.
Image	getInverseDisplacementField()	Image itk::simple::DisplacementFieldTransform::GetInverseDisplacementField() const Todo The returned image is should not directly modify the internal displacement field.
String	getName()	std::string itk::simple::DisplacementFieldTransform::GetName() const override Name of this class
void	setDisplacementField(Image arg0)	Self& itk::simple::DisplacementFieldTransform::SetDisplacementField(Image &) Consume an image, and set the displacement field.
void	setInterpolator(InterpolatorEnum interp)	Self& itk::simple::DisplacementFieldTransform::SetInterpolator(InterpolatorEnum interp) Set the interpolator used between the field voxels.
void	setInverseDisplacementField(Image arg0)	Self& itk::simple::DisplacementFieldTransform::SetInverseDisplacementField(Image &) fixed parameter
void	setSmoothingBSplineOnUpdate()	Self& itk::simple::DisplacementFieldTransform::SetSmoothingBSplineOnUpdate(const std::vector< unsigned int > &numberOfControlPointsForUpdateField=std::vector< unsigned int >(3, 4), const std::vector< unsigned int > &numberOfControlPointsForTotalField=std::vector< unsigned int >(3, 4), bool enforceStationaryBoundary=true, unsigned int order=3)
void	setSmoothingBSplineOnUpdate(VectorUInt32 numberOfControlPointsForUpdateField)	Self& itk::simple::DisplacementFieldTransform::SetSmoothingBSplineOnUpdate(const std::vector< unsigned int > &numberOfControlPointsForUpdateField=std::vector< unsigned int >(3, 4), const std::vector< unsigned int > &numberOfControlPointsForTotalField=std::vector< unsigned int >(3, 4), bool enforceStationaryBoundary=true, unsigned int order=3)
void	setSmoothingBSplineOnUpdate(VectorUInt32 numberOfControlPointsForUpdateField, VectorUInt32 numberOfControlPointsForTotalField)	Self& itk::simple::DisplacementFieldTransform::SetSmoothingBSplineOnUpdate(const std::vector< unsigned int > &numberOfControlPointsForUpdateField=std::vector< unsigned int >(3, 4), const std::vector< unsigned int > &numberOfControlPointsForTotalField=std::vector< unsigned int >(3, 4), bool enforceStationaryBoundary=true, unsigned int order=3)
void	setSmoothingBSplineOnUpdate(VectorUInt32 numberOfControlPointsForUpdateField, VectorUInt32 numberOfControlPointsForTotalField, boolean enforceStationaryBoundary)	Self& itk::simple::DisplacementFieldTransform::SetSmoothingBSplineOnUpdate(const std::vector< unsigned int > &numberOfControlPointsForUpdateField=std::vector< unsigned int >(3, 4), const std::vector< unsigned int > &numberOfControlPointsForTotalField=std::vector< unsigned int >(3, 4), bool enforceStationaryBoundary=true, unsigned int order=3)
void	setSmoothingBSplineOnUpdate(VectorUInt32 numberOfControlPointsForUpdateField, VectorUInt32 numberOfControlPointsForTotalField, boolean enforceStationaryBoundary, long order)	Self& itk::simple::DisplacementFieldTransform::SetSmoothingBSplineOnUpdate(const std::vector< unsigned int > &numberOfControlPointsForUpdateField=std::vector< unsigned int >(3, 4), const std::vector< unsigned int > &numberOfControlPointsForTotalField=std::vector< unsigned int >(3, 4), bool enforceStationaryBoundary=true, unsigned int order=3)
void	setSmoothingGaussianOnUpdate()	Self& itk::simple::DisplacementFieldTransform::SetSmoothingGaussianOnUpdate(double varianceForUpdateField=1.75, double varianceForTotalField=0.5)
void	setSmoothingGaussianOnUpdate(double varianceForUpdateField)	Self& itk::simple::DisplacementFieldTransform::SetSmoothingGaussianOnUpdate(double varianceForUpdateField=1.75, double varianceForTotalField=0.5)
void	setSmoothingGaussianOnUpdate(double varianceForUpdateField, double varianceForTotalField)	Self& itk::simple::DisplacementFieldTransform::SetSmoothingGaussianOnUpdate(double varianceForUpdateField=1.75, double varianceForTotalField=0.5)
void	setSmoothingOff()	Self& itk::simple::DisplacementFieldTransform::SetSmoothingOff()
protected static long	swigRelease(DisplacementFieldTransform obj)

Methods inherited from class Transform

getCPtr, getDimension, getFixedParameters, getInverse, getITKBase, getNumberOfFixedParameters, getNumberOfParameters, getParameters, getTransformEnum, isLinear, makeUnique, setFixedParameters, setIdentity, setInverse, setParameters, swigRelease, toString, transformPoint, transformVector, writeTransform

Modifier and Type	Method	Description
protected static long	getCPtr(Transform obj)
long	getDimension()	unsigned int itk::simple::Transform::GetDimension() const Return the dimension of the Transform ( 2D or 3D )
VectorDouble	getFixedParameters()
Transform	getInverse()	Transform itk::simple::Transform::GetInverse() const Return a new inverse transform of the same type as this.
SWIGTYPE_p_itk__TransformBaseTemplateT_double_t	getITKBase()
long	getNumberOfFixedParameters()	unsigned int itk::simple::Transform::GetNumberOfFixedParameters() const Get the number of fixed parameters
long	getNumberOfParameters()	unsigned int itk::simple::Transform::GetNumberOfParameters() const Return the number of optimizable parameters
VectorDouble	getParameters()
TransformEnum	getTransformEnum()	TransformEnum itk::simple::Transform::GetTransformEnum() const Get the TransformEnum of the underlying Transform.
boolean	isLinear()	virtual bool itk::simple::Transform::IsLinear() const
void	makeUnique()	void itk::simple::Transform::MakeUnique() Performs actually coping if needed to make object unique.
void	setFixedParameters(VectorDouble parameters)
void	setIdentity()	virtual void itk::simple::Transform::SetIdentity()
boolean	setInverse()	virtual bool itk::simple::Transform::SetInverse() Try to change the current transform to it's inverse.
void	setParameters(VectorDouble parameters)
protected static long	swigRelease(Transform obj)
String	toString()	std::string itk::simple::Transform::ToString() const
VectorDouble	transformPoint(VectorDouble point)	std::vector<double> itk::simple::Transform::TransformPoint(const std::vector< double > &point) const Apply transform to a point.
VectorDouble	transformVector(VectorDouble vector, VectorDouble point)	std::vector<double> itk::simple::Transform::TransformVector(const std::vector< double > &vector, const std::vector< double > &point) const Apply transform to a vector at a point.
void	writeTransform(String filename)	void itk::simple::Transform::WriteTransform(const std::string &filename) const

Methods inherited from class Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DisplacementFieldTransform

protected DisplacementFieldTransform(long cPtr,
 boolean cMemoryOwn)

DisplacementFieldTransform

public DisplacementFieldTransform(long dimensions)

itk::simple::DisplacementFieldTransform::DisplacementFieldTransform(unsigned int dimensions)

DisplacementFieldTransform

public DisplacementFieldTransform(Image arg0)

itk::simple::DisplacementFieldTransform::DisplacementFieldTransform(unsigned int dimensions)

DisplacementFieldTransform

public DisplacementFieldTransform(DisplacementFieldTransform arg0)

itk::simple::DisplacementFieldTransform::DisplacementFieldTransform(unsigned int dimensions)

DisplacementFieldTransform

public DisplacementFieldTransform(Transform arg0)

itk::simple::DisplacementFieldTransform::DisplacementFieldTransform(unsigned int dimensions)

Method Details

getCPtr

protected static long getCPtr(DisplacementFieldTransform obj)

swigRelease

protected static long swigRelease(DisplacementFieldTransform obj)

finalize

protected void finalize()

Overrides:

finalize in class Transform

delete

public void delete()

itk::simple::DisplacementFieldTransform::~DisplacementFieldTransform() override

Overrides:

delete in class Transform

getName

public String getName()

std::string itk::simple::DisplacementFieldTransform::GetName() const override Name of this class

Overrides:

getName in class Transform

setDisplacementField

public void setDisplacementField(Image arg0)

Self& itk::simple::DisplacementFieldTransform::SetDisplacementField(Image &) Consume an image, and set the displacement field. parameters WARNING: The ownership of the input displacement image is transferred to the constructed transform object. The input image is modified to be a default constructed Image object. Image must be of sitkVectorFloat64 pixel type with the number of components equal to the image dimension.

getDisplacementField

public Image getDisplacementField()

Image itk::simple::DisplacementFieldTransform::GetDisplacementField() const Todo The returned image should not directly modify the internal displacement field.

setInverseDisplacementField

public void setInverseDisplacementField(Image arg0)

Self& itk::simple::DisplacementFieldTransform::SetInverseDisplacementField(Image &) fixed parameter

getInverseDisplacementField

public Image getInverseDisplacementField()

Image itk::simple::DisplacementFieldTransform::GetInverseDisplacementField() const Todo The returned image is should not directly modify the internal displacement field.

setInterpolator

public void setInterpolator(InterpolatorEnum interp)

Self& itk::simple::DisplacementFieldTransform::SetInterpolator(InterpolatorEnum interp) Set the interpolator used between the field voxels.

setSmoothingOff

public void setSmoothingOff()

Self& itk::simple::DisplacementFieldTransform::SetSmoothingOff()

setSmoothingGaussianOnUpdate

public void setSmoothingGaussianOnUpdate(double varianceForUpdateField,
 double varianceForTotalField)

Self& itk::simple::DisplacementFieldTransform::SetSmoothingGaussianOnUpdate(double varianceForUpdateField=1.75, double varianceForTotalField=0.5)

setSmoothingGaussianOnUpdate

public void setSmoothingGaussianOnUpdate(double varianceForUpdateField)

Self& itk::simple::DisplacementFieldTransform::SetSmoothingGaussianOnUpdate(double varianceForUpdateField=1.75, double varianceForTotalField=0.5)

setSmoothingGaussianOnUpdate

public void setSmoothingGaussianOnUpdate()

Self& itk::simple::DisplacementFieldTransform::SetSmoothingGaussianOnUpdate(double varianceForUpdateField=1.75, double varianceForTotalField=0.5)

setSmoothingBSplineOnUpdate

public void setSmoothingBSplineOnUpdate(VectorUInt32 numberOfControlPointsForUpdateField,
 VectorUInt32 numberOfControlPointsForTotalField,
 boolean enforceStationaryBoundary,
 long order)

Self& itk::simple::DisplacementFieldTransform::SetSmoothingBSplineOnUpdate(const std::vector< unsigned int > &numberOfControlPointsForUpdateField=std::vector< unsigned int >(3, 4), const std::vector< unsigned int > &numberOfControlPointsForTotalField=std::vector< unsigned int >(3, 4), bool enforceStationaryBoundary=true, unsigned int order=3)

setSmoothingBSplineOnUpdate

public void setSmoothingBSplineOnUpdate(VectorUInt32 numberOfControlPointsForUpdateField,
 VectorUInt32 numberOfControlPointsForTotalField,
 boolean enforceStationaryBoundary)

Self& itk::simple::DisplacementFieldTransform::SetSmoothingBSplineOnUpdate(const std::vector< unsigned int > &numberOfControlPointsForUpdateField=std::vector< unsigned int >(3, 4), const std::vector< unsigned int > &numberOfControlPointsForTotalField=std::vector< unsigned int >(3, 4), bool enforceStationaryBoundary=true, unsigned int order=3)

setSmoothingBSplineOnUpdate

public void setSmoothingBSplineOnUpdate(VectorUInt32 numberOfControlPointsForUpdateField,
 VectorUInt32 numberOfControlPointsForTotalField)

Self& itk::simple::DisplacementFieldTransform::SetSmoothingBSplineOnUpdate(const std::vector< unsigned int > &numberOfControlPointsForUpdateField=std::vector< unsigned int >(3, 4), const std::vector< unsigned int > &numberOfControlPointsForTotalField=std::vector< unsigned int >(3, 4), bool enforceStationaryBoundary=true, unsigned int order=3)

setSmoothingBSplineOnUpdate

public void setSmoothingBSplineOnUpdate(VectorUInt32 numberOfControlPointsForUpdateField)

Self& itk::simple::DisplacementFieldTransform::SetSmoothingBSplineOnUpdate(const std::vector< unsigned int > &numberOfControlPointsForUpdateField=std::vector< unsigned int >(3, 4), const std::vector< unsigned int > &numberOfControlPointsForTotalField=std::vector< unsigned int >(3, 4), bool enforceStationaryBoundary=true, unsigned int order=3)

setSmoothingBSplineOnUpdate

public void setSmoothingBSplineOnUpdate()

Self& itk::simple::DisplacementFieldTransform::SetSmoothingBSplineOnUpdate(const std::vector< unsigned int > &numberOfControlPointsForUpdateField=std::vector< unsigned int >(3, 4), const std::vector< unsigned int > &numberOfControlPointsForTotalField=std::vector< unsigned int >(3, 4), bool enforceStationaryBoundary=true, unsigned int order=3)