SimpleITK
|
Deformably register two images using the demons algorithm. More...
#include <sitkSymmetricForcesDemonsRegistrationFilter.h>
Deformably register two images using the demons algorithm.
This class was contributed by Corinne Mattmann, ETH Zurich, Switzerland. based on a variation of the DemonsRegistrationFilter . The basic modification is to use equation (5) from Thirion's paper along with the modification for avoiding large deformations when gradients have small values.
SymmetricForcesDemonsRegistrationFilter 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 algorithm has one parameters: the number of iteration to be performed.
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 .
Definition at line 66 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
Public Types | |
using | PixelIDTypeList = BasicPixelIDTypeList |
using | Self = SymmetricForcesDemonsRegistrationFilter |
Public Types inherited from itk::simple::ImageFilter | |
using | Self = ImageFilter |
Public Types inherited from itk::simple::ProcessObject | |
using | Self = ProcessObject |
Public Member Functions | |
Image | Execute (const Image &fixedImage, const Image &movingImage) |
Image | Execute (const Image &fixedImage, const Image &movingImage, const Image &initialDisplacementField) |
uint32_t | GetElapsedIterations () const |
Number of iterations run. More... | |
double | GetIntensityDifferenceThreshold () const |
double | GetMaximumError () const |
unsigned int | GetMaximumKernelWidth () const |
double | GetMaximumRMSError () const |
double | GetMetric () const |
std::string | GetName () const |
uint32_t | GetNumberOfIterations () const |
double | GetRMSChange () const |
bool | GetSmoothDisplacementField () const |
bool | GetSmoothUpdateField () const |
std::vector< double > | GetStandardDeviations () const |
std::vector< double > | GetUpdateFieldStandardDeviations () const |
bool | GetUseImageSpacing () const |
Self & | SetIntensityDifferenceThreshold (double IntensityDifferenceThreshold) |
Self & | SetMaximumError (double MaximumError) |
Self & | SetMaximumKernelWidth (unsigned int MaximumKernelWidth) |
Self & | SetMaximumRMSError (double MaximumRMSError) |
Self & | SetNumberOfIterations (uint32_t NumberOfIterations) |
Self & | SetSmoothDisplacementField (bool SmoothDisplacementField) |
Self & | SetSmoothUpdateField (bool SmoothUpdateField) |
Self & | SetStandardDeviations (double value) |
Self & | SetStandardDeviations (std::vector< double > StandardDeviations) |
Self & | SetUpdateFieldStandardDeviations (double value) |
Self & | SetUpdateFieldStandardDeviations (std::vector< double > UpdateFieldStandardDeviations) |
Self & | SetUseImageSpacing (bool UseImageSpacing) |
Self & | SmoothDisplacementFieldOff () |
Self & | SmoothDisplacementFieldOn () |
Self & | SmoothUpdateFieldOff () |
Self & | SmoothUpdateFieldOn () |
void | StopRegistration () |
SymmetricForcesDemonsRegistrationFilter () | |
std::string | ToString () const |
Self & | UseImageSpacingOff () |
Self & | UseImageSpacingOn () |
virtual | ~SymmetricForcesDemonsRegistrationFilter () |
Public Member Functions inherited from itk::simple::ImageFilter | |
ImageFilter () | |
virtual | ~ImageFilter ()=0 |
Public Member Functions inherited from itk::simple::ProcessObject | |
virtual void | Abort () |
virtual int | AddCommand (itk::simple::EventEnum event, const std::function< void()> &func) |
Directly add a callback to observe an event. More... | |
virtual int | AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd) |
Add a Command Object to observer the event. More... | |
virtual float | GetProgress () const |
An Active Measurement of the progress of execution. More... | |
virtual bool | HasCommand (itk::simple::EventEnum event) const |
Query of this object has any registered commands for event. More... | |
ProcessObject () | |
virtual void | RemoveAllCommands () |
Remove all registered commands. More... | |
virtual | ~ProcessObject () |
virtual void | DebugOn () |
virtual void | DebugOff () |
virtual bool | GetDebug () const |
virtual void | SetDebug (bool debugFlag) |
virtual void | SetNumberOfThreads (unsigned int n) |
virtual unsigned int | GetNumberOfThreads () const |
virtual void | SetNumberOfWorkUnits (unsigned int n) |
virtual unsigned int | GetNumberOfWorkUnits () const |
Private Types | |
using | MemberFunctionType = Image(Self::*)(const Image *fixedImage, const Image *movingImage, const Image *initialDisplacementField) |
Private Member Functions | |
template<class TImageType > | |
Image | ExecuteInternal (const Image *fixedImage, const Image *movingImage, const Image *initialDisplacementField) |
Private Attributes | |
itk::ProcessObject * | m_Filter {nullptr} |
double | m_IntensityDifferenceThreshold {0.001} |
double | m_MaximumError {0.1} |
unsigned int | m_MaximumKernelWidth {30u} |
double | m_MaximumRMSError {0.02} |
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > | m_MemberFactory |
uint32_t | m_NumberOfIterations {10u} |
std::function< uint32_t()> | m_pfGetElapsedIterations |
std::function< double()> | m_pfGetMetric |
std::function< void()> | m_pfGetStopRegistration |
double | m_RMSChange {0.0} |
bool | m_SmoothDisplacementField {true} |
bool | m_SmoothUpdateField {false} |
std::vector< double > | m_StandardDeviations {std::vector<double>(3, 1.0)} |
std::vector< double > | m_UpdateFieldStandardDeviations {std::vector<double>(3, 1.0)} |
bool | m_UseImageSpacing {true} |
Friends | |
struct | detail::MemberFunctionAddressor< MemberFunctionType > |
Additional Inherited Members | |
Static Public Member Functions inherited from itk::simple::ProcessObject | |
static bool | GetGlobalDefaultDebug () |
static void | GlobalDefaultDebugOff () |
static void | GlobalDefaultDebugOn () |
static void | SetGlobalDefaultDebug (bool debugFlag) |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static void | SetGlobalWarningDisplay (bool flag) |
static bool | GetGlobalWarningDisplay () |
static double | GetGlobalDefaultCoordinateTolerance () |
Access the global tolerance to determine congruent spaces. More... | |
static void | SetGlobalDefaultCoordinateTolerance (double) |
Access the global tolerance to determine congruent spaces. More... | |
static double | GetGlobalDefaultDirectionTolerance () |
Access the global tolerance to determine congruent spaces. More... | |
static void | SetGlobalDefaultDirectionTolerance (double) |
Access the global tolerance to determine congruent spaces. More... | |
static bool | SetGlobalDefaultThreader (const std::string &threader) |
Set/Get the default threader used for process objects. More... | |
static std::string | GetGlobalDefaultThreader () |
Set/Get the default threader used for process objects. More... | |
static void | SetGlobalDefaultNumberOfThreads (unsigned int n) |
static unsigned int | GetGlobalDefaultNumberOfThreads () |
Set/Get the default threader used for process objects. More... | |
Protected Member Functions inherited from itk::simple::ImageFilter | |
void | CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name) |
void | CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name) |
void | CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name) |
Protected Member Functions inherited from itk::simple::ProcessObject | |
virtual unsigned long | AddITKObserver (const itk::EventObject &, itk::Command *) |
virtual itk::ProcessObject * | GetActiveProcess () |
virtual void | OnActiveProcessDelete () |
virtual void | onCommandDelete (const itk::simple::Command *cmd) noexcept |
virtual void | PreUpdate (itk::ProcessObject *p) |
virtual void | RemoveITKObserver (EventCommand &e) |
Protected Member Functions inherited from itk::simple::NonCopyable | |
NonCopyable ()=default | |
NonCopyable (const NonCopyable &)=delete | |
NonCopyable & | operator= (const NonCopyable &)=delete |
Static Protected Member Functions inherited from itk::simple::ImageFilter | |
template<class TImageType > | |
static void | FixNonZeroIndex (TImageType *img) |
Static Protected Member Functions inherited from itk::simple::ProcessObject | |
template<class TImageType > | |
static TImageType::ConstPointer | CastImageToITK (const Image &img) |
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector> | |
static Image | CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img) |
template<unsigned int VImageDimension, unsigned int VLength, template< unsigned int > class TVector> | |
static Image | CastITKToImage (itk::Image< TVector< VLength >, VImageDimension > *img) |
template<class TImageType > | |
static Image | CastITKToImage (TImageType *img) |
static const itk::EventObject & | GetITKEventObject (EventEnum e) |
template<typename T > | |
static std::ostream & | ToStringHelper (std::ostream &os, const T &v) |
static std::ostream & | ToStringHelper (std::ostream &os, const char &v) |
static std::ostream & | ToStringHelper (std::ostream &os, const signed char &v) |
static std::ostream & | ToStringHelper (std::ostream &os, const unsigned char &v) |
|
private |
Setup for member function dispatching
Definition at line 243 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
Define the pixels types supported by this filter
Definition at line 78 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
using itk::simple::SymmetricForcesDemonsRegistrationFilter::Self = SymmetricForcesDemonsRegistrationFilter |
Definition at line 68 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
virtual |
Destructor
itk::simple::SymmetricForcesDemonsRegistrationFilter::SymmetricForcesDemonsRegistrationFilter | ( | ) |
Default Constructor that takes no arguments and initializes default parameters
Image itk::simple::SymmetricForcesDemonsRegistrationFilter::Execute | ( | const Image & | fixedImage, |
const Image & | movingImage | ||
) |
Image itk::simple::SymmetricForcesDemonsRegistrationFilter::Execute | ( | const Image & | fixedImage, |
const Image & | movingImage, | ||
const Image & | initialDisplacementField | ||
) |
Execute the filter on the input image
|
private |
|
inline |
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.
Definition at line 198 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Definition at line 178 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set/Get the desired maximum error of the Guassian kernel approximate.
Definition at line 169 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set/Get the desired limits of the Gaussian kernel width.
Definition at line 159 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Definition at line 108 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
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 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.
Definition at line 215 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inlinevirtual |
Name of this class
Implements itk::simple::ProcessObject.
Definition at line 228 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Definition at line 100 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
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.
Definition at line 206 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
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()
Definition at line 122 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
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()
Definition at line 136 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set/Get the Gaussian smoothing standard deviations for the displacement field. The values are set with respect to pixel coordinates.
Definition at line 92 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates.
Definition at line 149 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Definition at line 190 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
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.
Definition at line 174 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set/Get the desired maximum error of the Guassian kernel approximate.
Definition at line 164 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set/Get the desired limits of the Gaussian kernel width.
Definition at line 154 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Definition at line 104 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Definition at line 96 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
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()
Definition at line 113 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
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()
Definition at line 127 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set the values of the StandardDeviations vector all to value
Definition at line 87 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set/Get the Gaussian smoothing standard deviations for the displacement field. The values are set with respect to pixel coordinates.
Definition at line 84 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set the values of the UpdateFieldStandardDeviations vector all to value
Definition at line 144 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates.
Definition at line 141 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Definition at line 182 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Definition at line 117 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set the value of SmoothDisplacementField to true or false respectfully.
Definition at line 116 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Definition at line 131 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set the value of SmoothUpdateField to true or false respectfully.
Definition at line 130 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
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.
Definition at line 224 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
virtual |
Print ourselves out
Reimplemented from itk::simple::ProcessObject.
|
inline |
Definition at line 186 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
inline |
Set the value of UseImageSpacing to true or false respectfully.
Definition at line 185 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
friend |
Definition at line 247 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 284 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 270 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 268 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 266 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 258 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 249 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 255 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 275 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 279 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 281 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 277 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 260 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 262 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 252 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 264 of file sitkSymmetricForcesDemonsRegistrationFilter.h.
|
private |
Definition at line 272 of file sitkSymmetricForcesDemonsRegistrationFilter.h.