SimpleITK
2.0.0
|
Deformably register two images using the demons algorithm. More...
#include <sitkDemonsRegistrationFilter.h>
Public Types | |
using | PixelIDTypeList = BasicPixelIDTypeList |
using | Self = DemonsRegistrationFilter |
Public Types inherited from itk::simple::ImageFilter | |
using | Self = ImageFilter |
Public Types inherited from itk::simple::ProcessObject | |
using | Self = ProcessObject |
Public Member Functions | |
DemonsRegistrationFilter () | |
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 |
The Root Mean Square of the levelset upon termination. More... | |
bool | GetSmoothDisplacementField () const |
bool | GetSmoothUpdateField () const |
std::vector< double > | GetStandardDeviations () const |
std::vector< double > | GetUpdateFieldStandardDeviations () const |
bool | GetUseImageSpacing () const |
bool | GetUseMovingImageGradient () 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 & | SetUseMovingImageGradient (bool UseMovingImageGradient) |
Self & | SmoothDisplacementFieldOff () |
Self & | SmoothDisplacementFieldOn () |
Self & | SmoothUpdateFieldOff () |
Self & | SmoothUpdateFieldOn () |
std::string | ToString () const |
Self & | UseImageSpacingOff () |
Self & | UseImageSpacingOn () |
Self & | UseMovingImageGradientOff () |
Self & | UseMovingImageGradientOn () |
virtual | ~DemonsRegistrationFilter () |
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 |
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} |
bool | m_UseMovingImageGradient {false} |
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<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) |
Deformably register two images using the demons algorithm.
DemonsRegistrationFilter implements the demons deformable algorithm that register two images by computing the displacement field which will map a moving image onto a fixed image.
A displacement 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 displacement field type.
The input fixed and moving images are set via methods SetFixedImage and SetMovingImage respectively. An initial displacement 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 displacement 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 59 of file sitkDemonsRegistrationFilter.h.
|
private |
Setup for member function dispatching
Definition at line 241 of file sitkDemonsRegistrationFilter.h.
Define the pixels types supported by this filter
Definition at line 71 of file sitkDemonsRegistrationFilter.h.
Definition at line 61 of file sitkDemonsRegistrationFilter.h.
|
virtual |
Destructor
itk::simple::DemonsRegistrationFilter::DemonsRegistrationFilter | ( | ) |
Default Constructor that takes no arguments and initializes default parameters
Image itk::simple::DemonsRegistrationFilter::Execute | ( | const Image & | fixedImage, |
const Image & | movingImage | ||
) |
Image itk::simple::DemonsRegistrationFilter::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 205 of file sitkDemonsRegistrationFilter.h.
|
inline |
Definition at line 185 of file sitkDemonsRegistrationFilter.h.
|
inline |
Set/Get the desired maximum error of the Guassian kernel approximate.
Definition at line 176 of file sitkDemonsRegistrationFilter.h.
|
inline |
Set/Get the desired limits of the Gaussian kernel width.
Definition at line 166 of file sitkDemonsRegistrationFilter.h.
|
inline |
Definition at line 101 of file sitkDemonsRegistrationFilter.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 the overlapping region between the two images. This is value is only available for the previous iteration and NOT 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 222 of file sitkDemonsRegistrationFilter.h.
|
inlinevirtual |
Name of this class
Implements itk::simple::ProcessObject.
Definition at line 226 of file sitkDemonsRegistrationFilter.h.
|
inline |
Definition at line 93 of file sitkDemonsRegistrationFilter.h.
|
inline |
The Root Mean Square of the levelset upon termination.
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 213 of file sitkDemonsRegistrationFilter.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 129 of file sitkDemonsRegistrationFilter.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 143 of file sitkDemonsRegistrationFilter.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 85 of file sitkDemonsRegistrationFilter.h.
|
inline |
Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates.
Definition at line 156 of file sitkDemonsRegistrationFilter.h.
|
inline |
Definition at line 197 of file sitkDemonsRegistrationFilter.h.
|
inline |
Switch between using the fixed image and moving image gradient for computing the displacement field updates.
Definition at line 115 of file sitkDemonsRegistrationFilter.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 181 of file sitkDemonsRegistrationFilter.h.
|
inline |
Set/Get the desired maximum error of the Guassian kernel approximate.
Definition at line 171 of file sitkDemonsRegistrationFilter.h.
|
inline |
Set/Get the desired limits of the Gaussian kernel width.
Definition at line 161 of file sitkDemonsRegistrationFilter.h.
|
inline |
Definition at line 97 of file sitkDemonsRegistrationFilter.h.
|
inline |
Definition at line 89 of file sitkDemonsRegistrationFilter.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 120 of file sitkDemonsRegistrationFilter.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 134 of file sitkDemonsRegistrationFilter.h.
|
inline |
Set the values of the StandardDeviations vector all to value
Definition at line 80 of file sitkDemonsRegistrationFilter.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 77 of file sitkDemonsRegistrationFilter.h.
|
inline |
Set the values of the UpdateFieldStandardDeviations vector all to value
Definition at line 151 of file sitkDemonsRegistrationFilter.h.
|
inline |
Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates.
Definition at line 148 of file sitkDemonsRegistrationFilter.h.
|
inline |
Definition at line 189 of file sitkDemonsRegistrationFilter.h.
|
inline |
Switch between using the fixed image and moving image gradient for computing the displacement field updates.
Definition at line 106 of file sitkDemonsRegistrationFilter.h.
|
inline |
Definition at line 124 of file sitkDemonsRegistrationFilter.h.
|
inline |
Set the value of SmoothDisplacementField to true or false respectfully.
Definition at line 123 of file sitkDemonsRegistrationFilter.h.
|
inline |
Definition at line 138 of file sitkDemonsRegistrationFilter.h.
|
inline |
Set the value of SmoothUpdateField to true or false respectfully.
Definition at line 137 of file sitkDemonsRegistrationFilter.h.
|
virtual |
Print ourselves out
Reimplemented from itk::simple::ProcessObject.
|
inline |
Definition at line 193 of file sitkDemonsRegistrationFilter.h.
|
inline |
Set the value of UseImageSpacing to true or false respectfully.
Definition at line 192 of file sitkDemonsRegistrationFilter.h.
|
inline |
Definition at line 110 of file sitkDemonsRegistrationFilter.h.
|
inline |
Set the value of UseMovingImageGradient to true or false respectfully.
Definition at line 109 of file sitkDemonsRegistrationFilter.h.
|
friend |
Definition at line 245 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 282 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 270 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 268 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 266 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 256 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 247 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 253 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 275 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 279 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 277 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 260 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 262 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 250 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 264 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 272 of file sitkDemonsRegistrationFilter.h.
|
private |
Definition at line 258 of file sitkDemonsRegistrationFilter.h.