Package org.itk.simple
Class TransformToDisplacementFieldFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.TransformToDisplacementFieldFilter
Generate a displacement field from a coordinate transform.
Output information (spacing, size and direction) for the output image
should be set. This information has the normal defaults of unit
spacing, zero origin and identity direction. Optionally, the output
information can be obtained from a reference image. If the reference
image is provided and UseReferenceImage is On, then the spacing,
origin and direction of the reference image will be used.
Since this filter produces an image which is a different size than its
input, it needs to override several of the methods defined in ProcessObject in order to properly manage the pipeline execution model. In
particular, this filter overrides ProcessObject::GenerateOutputInformation() .
This filter is implemented as a multithreaded filter. It provides a
ThreadedGenerateData() method for its implementation.
Marius Staring, Leiden University Medical Center, The Netherlands.
This class was taken from the Insight Journal paper: https://www.insight-journal.org/browse/publication/240
See:
itk::simple::TransformToDisplacementFieldFilter for the procedural interface
itk::TransformToDisplacementFieldFilter for the Doxygen on the original ITK class.
C++ includes: sitkTransformToDisplacementFieldFilter.h
-
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::TransformToDisplacementFieldFilter::TransformToDisplacementFieldFilter() Default Constructor that takes no arguments and initializes default parametersprotected
TransformToDisplacementFieldFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::TransformToDisplacementFieldFilter::~TransformToDisplacementFieldFilter() DestructorImage itk::simple::TransformToDisplacementFieldFilter::Execute(const Transform &transform) Execute the filter on the input imageprotected void
finalize()
protected static long
getName()
std::string itk::simple::TransformToDisplacementFieldFilter::GetName() const Name of this classstd::vector<double> itk::simple::TransformToDisplacementFieldFilter::GetOutputDirection() const Set the output direction cosine matrix.std::vector<double> itk::simple::TransformToDisplacementFieldFilter::GetOutputOrigin() const Get the output image origin.PixelIDValueEnum itk::simple::TransformToDisplacementFieldFilter::GetOutputPixelType() const Get the ouput pixel type.std::vector<double> itk::simple::TransformToDisplacementFieldFilter::GetOutputSpacing() const Get the output image spacing.getSize()
std::vector<unsigned int> itk::simple::TransformToDisplacementFieldFilter::GetSize() const Set/Get the size of the output image.void
setOutputDirection
(VectorDouble OutputDirection) Self& itk::simple::TransformToDisplacementFieldFilter::SetOutputDirection(std::vector< double > OutputDirection) Set the output direction cosine matrix.void
setOutputOrigin
(VectorDouble OutputOrigin) Self& itk::simple::TransformToDisplacementFieldFilter::SetOutputOrigin(std::vector< double > OutputOrigin) Set the output image origin.void
setOutputPixelType
(PixelIDValueEnum OutputPixelType) Self& itk::simple::TransformToDisplacementFieldFilter::SetOutputPixelType(PixelIDValueEnum OutputPixelType) Set the output pixel type, only sitkVectorFloat32 and sitkVectorFloat64 are supported.void
setOutputSpacing
(VectorDouble OutputSpacing) Self& itk::simple::TransformToDisplacementFieldFilter::SetOutputSpacing(std::vector< double > OutputSpacing) Set the output image spacing.void
setReferenceImage
(Image refImage) void itk::simple::TransformToDisplacementFieldFilter::SetReferenceImage(const Image &refImage) This methods sets the size, origin, spacing and direction to that of the provided imagevoid
setSize
(VectorUInt32 Size) Self& itk::simple::TransformToDisplacementFieldFilter::SetSize(std::vector< unsigned int > Size) Set/Get the size of the output image.protected static long
toString()
std::string itk::simple::TransformToDisplacementFieldFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFilter
getCPtr, swigRelease
Methods inherited from class org.itk.simple.ProcessObject
abort, addCommand, debugOff, debugOn, getCPtr, getDebug, getGlobalDefaultCoordinateTolerance, getGlobalDefaultDebug, getGlobalDefaultDirectionTolerance, getGlobalDefaultNumberOfThreads, getGlobalDefaultThreader, getGlobalWarningDisplay, getNumberOfThreads, getNumberOfWorkUnits, getProgress, globalDefaultDebugOff, globalDefaultDebugOn, globalWarningDisplayOff, globalWarningDisplayOn, hasCommand, removeAllCommands, setDebug, setGlobalDefaultCoordinateTolerance, setGlobalDefaultDebug, setGlobalDefaultDirectionTolerance, setGlobalDefaultNumberOfThreads, setGlobalDefaultThreader, setGlobalWarningDisplay, setNumberOfThreads, setNumberOfWorkUnits, swigRelease
-
Constructor Details
-
TransformToDisplacementFieldFilter
protected TransformToDisplacementFieldFilter(long cPtr, boolean cMemoryOwn) -
TransformToDisplacementFieldFilter
public TransformToDisplacementFieldFilter()itk::simple::TransformToDisplacementFieldFilter::TransformToDisplacementFieldFilter() Default Constructor that takes no arguments and initializes default parameters
-
-
Method Details
-
getCPtr
-
swigRelease
-
finalize
protected void finalize()- Overrides:
finalize
in classImageFilter
-
delete
public void delete()virtual itk::simple::TransformToDisplacementFieldFilter::~TransformToDisplacementFieldFilter() Destructor- Overrides:
delete
in classImageFilter
-
setOutputPixelType
Self& itk::simple::TransformToDisplacementFieldFilter::SetOutputPixelType(PixelIDValueEnum OutputPixelType) Set the output pixel type, only sitkVectorFloat32 and sitkVectorFloat64 are supported. -
getOutputPixelType
PixelIDValueEnum itk::simple::TransformToDisplacementFieldFilter::GetOutputPixelType() const Get the ouput pixel type. -
setSize
Self& itk::simple::TransformToDisplacementFieldFilter::SetSize(std::vector< unsigned int > Size) Set/Get the size of the output image. -
getSize
std::vector<unsigned int> itk::simple::TransformToDisplacementFieldFilter::GetSize() const Set/Get the size of the output image. -
setOutputOrigin
Self& itk::simple::TransformToDisplacementFieldFilter::SetOutputOrigin(std::vector< double > OutputOrigin) Set the output image origin. -
getOutputOrigin
std::vector<double> itk::simple::TransformToDisplacementFieldFilter::GetOutputOrigin() const Get the output image origin. -
setOutputSpacing
Self& itk::simple::TransformToDisplacementFieldFilter::SetOutputSpacing(std::vector< double > OutputSpacing) Set the output image spacing. -
getOutputSpacing
std::vector<double> itk::simple::TransformToDisplacementFieldFilter::GetOutputSpacing() const Get the output image spacing. -
setOutputDirection
Self& itk::simple::TransformToDisplacementFieldFilter::SetOutputDirection(std::vector< double > OutputDirection) Set the output direction cosine matrix. -
getOutputDirection
std::vector<double> itk::simple::TransformToDisplacementFieldFilter::GetOutputDirection() const Set the output direction cosine matrix. -
getName
std::string itk::simple::TransformToDisplacementFieldFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::TransformToDisplacementFieldFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::TransformToDisplacementFieldFilter::Execute(const Transform &transform) Execute the filter on the input image -
setReferenceImage
void itk::simple::TransformToDisplacementFieldFilter::SetReferenceImage(const Image &refImage) This methods sets the size, origin, spacing and direction to that of the provided image
-