Package org.itk.simple
Class FastSymmetricForcesDemonsRegistrationFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.FastSymmetricForcesDemonsRegistrationFilter
Deformably register two images using a symmetric forces demons
algorithm.
This class was contributed by Tom Vercauteren, INRIA & Mauna Kea
Technologies based on a variation of the DemonsRegistrationFilter .
FastSymmetricForcesDemonsRegistrationFilter implements the demons deformable algorithm that register two images
by computing the deformation field which will map a moving image onto
a fixed image.
A deformation field is represented as a image whose pixel type is some
vector type with at least N elements, where N is the dimension of the
fixed image. The vector type must support element access via operator
[]. It is assumed that the vector elements behave like floating point
scalars.
This class is templated over the fixed image type, moving image type
and the deformation field type.
The input fixed and moving images are set via methods SetFixedImage
and SetMovingImage respectively. An initial deformation field maybe
set via SetInitialDisplacementField or SetInput. If no initial field
is set, a zero field is used as the initial condition.
The output deformation field can be obtained via methods GetOutput or
GetDisplacementField.
This class make use of the finite difference solver hierarchy. Update
for each iteration is computed in DemonsRegistrationFunction .
Tom Vercauteren, INRIA & Mauna Kea Technologies
This implementation was taken from the Insight Journal paper: https://www.insight-journal.org/browse/publication/154
WARNING:
This filter assumes that the fixed image type, moving image type and
deformation field type all have the same number of dimensions.
See:
DemonsRegistrationFilter
DemonsRegistrationFunction
itk::FastSymmetricForcesDemonsRegistrationFilter for the Doxygen on the original ITK class.
C++ includes: sitkFastSymmetricForcesDemonsRegistrationFilter.h
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
-
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::FastSymmetricForcesDemonsRegistrationFilter::FastSymmetricForcesDemonsRegistrationFilter() Default Constructor that takes no arguments and initializes default parametersprotected
FastSymmetricForcesDemonsRegistrationFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::FastSymmetricForcesDemonsRegistrationFilter::~FastSymmetricForcesDemonsRegistrationFilter() DestructorImage itk::simple::FastSymmetricForcesDemonsRegistrationFilter::Execute(const Image &fixedImage, const Image &movingImage, const Image &initialDisplacementField) Execute the filter on the input imageImage itk::simple::FastSymmetricForcesDemonsRegistrationFilter::Execute(const Image &fixedImage, const Image &movingImage, const Image &initialDisplacementField) Execute the filter on the input imageprotected void
finalize()
protected static long
long
uint32_t itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetElapsedIterations() const Number of iterations run.double
double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetIntensityDifferenceThreshold() constdouble
double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMaximumError() const Set/Get the desired maximum error of the Guassian kernel approximate.long
unsigned int itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMaximumKernelWidth() const Set/Get the desired limits of the Gaussian kernel width.double
double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMaximumRMSError() constdouble
double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMaximumUpdateStepLength() constdouble
double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMetric() const Get the metric value.getName()
std::string itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetName() const Name of this classlong
uint32_t itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetNumberOfIterations() constdouble
double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetRMSChange() const Set/Get the root mean squared change of the previous iteration.boolean
bool itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetSmoothDisplacementField() const Set/Get whether the displacement field is smoothed (regularized).boolean
bool itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetSmoothUpdateField() const Set/Get whether the update field is smoothed (regularized).std::vector<double> itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetStandardDeviations() const Set/Get the Gaussian smoothing standard deviations for the displacement field.std::vector<double> itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetUpdateFieldStandardDeviations() const Set the Gaussian smoothing standard deviations for the update field.UseGradientTypeType itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetUseGradientType() constboolean
bool itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetUseImageSpacing() constvoid
setIntensityDifferenceThreshold
(double IntensityDifferenceThreshold) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetIntensityDifferenceThreshold(double IntensityDifferenceThreshold) Set/Get the threshold below which the absolute difference of intensity yields a match.void
setMaximumError
(double MaximumError) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetMaximumError(double MaximumError) Set/Get the desired maximum error of the Guassian kernel approximate.void
setMaximumKernelWidth
(long MaximumKernelWidth) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetMaximumKernelWidth(unsigned int MaximumKernelWidth) Set/Get the desired limits of the Gaussian kernel width.void
setMaximumRMSError
(double MaximumRMSError) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetMaximumRMSError(double MaximumRMSError)void
setMaximumUpdateStepLength
(double MaximumUpdateStepLength) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetMaximumUpdateStepLength(double MaximumUpdateStepLength) Set/Get the maximum update step length.void
setNumberOfIterations
(long NumberOfIterations) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetNumberOfIterations(uint32_t NumberOfIterations)void
setSmoothDisplacementField
(boolean SmoothDisplacementField) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetSmoothDisplacementField(bool SmoothDisplacementField) Set/Get whether the displacement field is smoothed (regularized).void
setSmoothUpdateField
(boolean SmoothUpdateField) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetSmoothUpdateField(bool SmoothUpdateField) Set/Get whether the update field is smoothed (regularized).void
setStandardDeviations
(double value) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetStandardDeviations(std::vector< double > StandardDeviations) Set/Get the Gaussian smoothing standard deviations for the displacement field.void
setStandardDeviations
(VectorDouble StandardDeviations) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetStandardDeviations(std::vector< double > StandardDeviations) Set/Get the Gaussian smoothing standard deviations for the displacement field.void
setUpdateFieldStandardDeviations
(double value) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetUpdateFieldStandardDeviations(std::vector< double > UpdateFieldStandardDeviations) Set the Gaussian smoothing standard deviations for the update field.void
setUpdateFieldStandardDeviations
(VectorDouble UpdateFieldStandardDeviations) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetUpdateFieldStandardDeviations(std::vector< double > UpdateFieldStandardDeviations) Set the Gaussian smoothing standard deviations for the update field.void
Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetUseGradientType(UseGradientTypeType UseGradientType)void
setUseImageSpacing
(boolean UseImageSpacing) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetUseImageSpacing(bool UseImageSpacing)void
Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SmoothDisplacementFieldOff()void
Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SmoothDisplacementFieldOn() Set the value of SmoothDisplacementField to true or false respectfully.void
Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SmoothUpdateFieldOff()void
Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SmoothUpdateFieldOn() Set the value of SmoothUpdateField to true or false respectfully.void
void itk::simple::FastSymmetricForcesDemonsRegistrationFilter::StopRegistration() This is an active measurement.protected static long
toString()
std::string itk::simple::FastSymmetricForcesDemonsRegistrationFilter::ToString() const Print ourselves outvoid
Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::UseImageSpacingOff()void
Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::UseImageSpacingOn() Set the value of UseImageSpacing to true or false respectfully.Methods 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
-
FastSymmetricForcesDemonsRegistrationFilter
protected FastSymmetricForcesDemonsRegistrationFilter(long cPtr, boolean cMemoryOwn) -
FastSymmetricForcesDemonsRegistrationFilter
public FastSymmetricForcesDemonsRegistrationFilter()itk::simple::FastSymmetricForcesDemonsRegistrationFilter::FastSymmetricForcesDemonsRegistrationFilter() 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::FastSymmetricForcesDemonsRegistrationFilter::~FastSymmetricForcesDemonsRegistrationFilter() Destructor- Overrides:
delete
in classImageFilter
-
setStandardDeviations
Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetStandardDeviations(std::vector< double > StandardDeviations) Set/Get the Gaussian smoothing standard deviations for the displacement field. The values are set with respect to pixel coordinates. -
setStandardDeviations
public void setStandardDeviations(double value) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetStandardDeviations(std::vector< double > StandardDeviations) Set/Get the Gaussian smoothing standard deviations for the displacement field. The values are set with respect to pixel coordinates. -
getStandardDeviations
std::vector<double> itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetStandardDeviations() const Set/Get the Gaussian smoothing standard deviations for the displacement field. The values are set with respect to pixel coordinates. -
setNumberOfIterations
public void setNumberOfIterations(long NumberOfIterations) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetNumberOfIterations(uint32_t NumberOfIterations) -
getNumberOfIterations
public long getNumberOfIterations()uint32_t itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetNumberOfIterations() const -
setMaximumRMSError
public void setMaximumRMSError(double MaximumRMSError) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetMaximumRMSError(double MaximumRMSError) -
getMaximumRMSError
public double getMaximumRMSError()double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMaximumRMSError() const -
setUseGradientType
public void setUseGradientType(FastSymmetricForcesDemonsRegistrationFilter.UseGradientTypeType UseGradientType) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetUseGradientType(UseGradientTypeType UseGradientType) -
getUseGradientType
UseGradientTypeType itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetUseGradientType() const -
setMaximumUpdateStepLength
public void setMaximumUpdateStepLength(double MaximumUpdateStepLength) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetMaximumUpdateStepLength(double MaximumUpdateStepLength) Set/Get the maximum update step length. -
getMaximumUpdateStepLength
public double getMaximumUpdateStepLength()double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMaximumUpdateStepLength() const -
setSmoothDisplacementField
public void setSmoothDisplacementField(boolean SmoothDisplacementField) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetSmoothDisplacementField(bool SmoothDisplacementField) Set/Get whether the displacement field is smoothed (regularized). Smoothing the displacement yields a solution elastic in nature. If SmoothDisplacementField is on, then the displacement field is smoothed with a Gaussian whose standard deviations are specified with SetStandardDeviations() -
smoothDisplacementFieldOn
public void smoothDisplacementFieldOn()Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SmoothDisplacementFieldOn() Set the value of SmoothDisplacementField to true or false respectfully. -
smoothDisplacementFieldOff
public void smoothDisplacementFieldOff()Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SmoothDisplacementFieldOff() -
getSmoothDisplacementField
public boolean getSmoothDisplacementField()bool itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetSmoothDisplacementField() const Set/Get whether the displacement field is smoothed (regularized). Smoothing the displacement yields a solution elastic in nature. If SmoothDisplacementField is on, then the displacement field is smoothed with a Gaussian whose standard deviations are specified with SetStandardDeviations() -
setSmoothUpdateField
public void setSmoothUpdateField(boolean SmoothUpdateField) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetSmoothUpdateField(bool SmoothUpdateField) Set/Get whether the update field is smoothed (regularized). Smoothing the update field yields a solution viscous in nature. If SmoothUpdateField is on, then the update field is smoothed with a Gaussian whose standard deviations are specified with SetUpdateFieldStandardDeviations() -
smoothUpdateFieldOn
public void smoothUpdateFieldOn()Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SmoothUpdateFieldOn() Set the value of SmoothUpdateField to true or false respectfully. -
smoothUpdateFieldOff
public void smoothUpdateFieldOff()Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SmoothUpdateFieldOff() -
getSmoothUpdateField
public boolean getSmoothUpdateField()bool itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetSmoothUpdateField() const Set/Get whether the update field is smoothed (regularized). Smoothing the update field yields a solution viscous in nature. If SmoothUpdateField is on, then the update field is smoothed with a Gaussian whose standard deviations are specified with SetUpdateFieldStandardDeviations() -
setUpdateFieldStandardDeviations
Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetUpdateFieldStandardDeviations(std::vector< double > UpdateFieldStandardDeviations) Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates. -
setUpdateFieldStandardDeviations
public void setUpdateFieldStandardDeviations(double value) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetUpdateFieldStandardDeviations(std::vector< double > UpdateFieldStandardDeviations) Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates. -
getUpdateFieldStandardDeviations
std::vector<double> itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetUpdateFieldStandardDeviations() const Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates. -
setMaximumKernelWidth
public void setMaximumKernelWidth(long MaximumKernelWidth) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetMaximumKernelWidth(unsigned int MaximumKernelWidth) Set/Get the desired limits of the Gaussian kernel width. -
getMaximumKernelWidth
public long getMaximumKernelWidth()unsigned int itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMaximumKernelWidth() const Set/Get the desired limits of the Gaussian kernel width. -
setMaximumError
public void setMaximumError(double MaximumError) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetMaximumError(double MaximumError) Set/Get the desired maximum error of the Guassian kernel approximate. -
getMaximumError
public double getMaximumError()double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMaximumError() const Set/Get the desired maximum error of the Guassian kernel approximate. -
setIntensityDifferenceThreshold
public void setIntensityDifferenceThreshold(double IntensityDifferenceThreshold) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetIntensityDifferenceThreshold(double IntensityDifferenceThreshold) Set/Get the threshold below which the absolute difference of intensity yields a match. When the intensities match between a moving and fixed image pixel, the update vector (for that iteration) will be the zero vector. Default is 0.001. -
getIntensityDifferenceThreshold
public double getIntensityDifferenceThreshold()double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetIntensityDifferenceThreshold() const -
setUseImageSpacing
public void setUseImageSpacing(boolean UseImageSpacing) Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::SetUseImageSpacing(bool UseImageSpacing) -
useImageSpacingOn
public void useImageSpacingOn()Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::UseImageSpacingOn() Set the value of UseImageSpacing to true or false respectfully. -
useImageSpacingOff
public void useImageSpacingOff()Self& itk::simple::FastSymmetricForcesDemonsRegistrationFilter::UseImageSpacingOff() -
getUseImageSpacing
public boolean getUseImageSpacing()bool itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetUseImageSpacing() const -
getElapsedIterations
public long getElapsedIterations()uint32_t itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetElapsedIterations() const Number of iterations run. This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution. -
getRMSChange
public double getRMSChange()double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetRMSChange() const Set/Get the root mean squared change of the previous iteration. May not be used by all solvers. This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution. -
getMetric
public double getMetric()double itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetMetric() const Get the metric value. The metric value is the mean square difference in intensity between the fixed image and transforming moving image computed over the the overlapping region between the two images. This value is calculated for the current iteration This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution. -
stopRegistration
public void stopRegistration()void itk::simple::FastSymmetricForcesDemonsRegistrationFilter::StopRegistration() This is an active measurement. It may be accessed while the filter is being executing in command call-backs and can be accessed after execution. -
getName
std::string itk::simple::FastSymmetricForcesDemonsRegistrationFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::FastSymmetricForcesDemonsRegistrationFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::FastSymmetricForcesDemonsRegistrationFilter::Execute(const Image &fixedImage, const Image &movingImage, const Image &initialDisplacementField) Execute the filter on the input image -
execute
Image itk::simple::FastSymmetricForcesDemonsRegistrationFilter::Execute(const Image &fixedImage, const Image &movingImage, const Image &initialDisplacementField) Execute the filter on the input image
-