ITK
6.0.0
Insight Toolkit
|
#include <itkNormalizedCorrelationImageToImageMetric.h>
Computes similarity between two images to be registered.
This metric computes the correlation between pixels in the fixed image and pixels in the moving image. The spatial correspondence between fixed and moving image is established through a Transform. Pixel values are taken from the fixed image, their positions are mapped to the moving image and result in general in non-grid position on it. Values at these non-grid position of the moving image are interpolated using a user-selected Interpolator. The correlation is normalized by the autocorrelations of both the fixed and moving images.
A more negative metric value indicates a greater degree of correlation between the fixed and moving image. This makes the metric simpler to use with optimizers that strive to minimize their cost function by default.
Definition at line 46 of file itkNormalizedCorrelationImageToImageMetric.h.
Public Member Functions | |
void | GetDerivative (const TransformParametersType ¶meters, DerivativeType &derivative) const override |
const char * | GetNameOfClass () const override |
MeasureType | GetValue (const TransformParametersType ¶meters) const override |
void | GetValueAndDerivative (const TransformParametersType ¶meters, MeasureType &value, DerivativeType &derivative) const override |
virtual void | SetSubtractMean (bool _arg) |
virtual const bool & | GetSubtractMean () const |
virtual void | SubtractMeanOn () |
Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage > | |
virtual void | ComputeGradient () |
virtual const FixedImageRegionType & | GetFixedImageRegion () const |
virtual const FixedImagePixelType & | GetFixedImageSamplesIntensityThreshold () const |
virtual GradientImageType * | GetModifiableGradientImage () |
virtual InterpolatorType * | GetModifiableInterpolator () |
virtual TransformType * | GetModifiableTransform () |
const char * | GetNameOfClass () const override |
SizeValueType | GetNumberOfMovingImageSamples () |
unsigned int | GetNumberOfParameters () const override |
virtual const SizeValueType & | GetNumberOfPixelsCounted () const |
SizeValueType | GetNumberOfSpatialSamples () |
virtual const bool & | GetUseAllPixels () const |
virtual const bool & | GetUseFixedImageIndexes () const |
virtual const bool & | GetUseFixedImageSamplesIntensityThreshold () const |
virtual const bool & | GetUseSequentialSampling () const |
virtual void | Initialize () |
virtual void | MultiThreadingInitialize () |
void | SetFixedImageIndexes (const FixedImageIndexContainer &indexes) |
virtual void | SetFixedImageRegion (const FixedImageRegionType reg) |
void | SetFixedImageSamplesIntensityThreshold (const FixedImagePixelType &thresh) |
virtual void | SetInterpolator (InterpolatorType *_arg) |
void | SetNumberOfSpatialSamples (SizeValueType num) |
virtual void | SetTransform (TransformType *_arg) |
void | SetTransformParameters (const ParametersType ¶meters) const |
void | SetUseAllPixels (bool useAllPixels) |
void | SetUseFixedImageIndexes (bool useIndexes) |
void | SetUseFixedImageSamplesIntensityThreshold (bool useThresh) |
void | SetUseSequentialSampling (bool useSequential) |
void | UseAllPixelsOff () |
void | UseAllPixelsOn () |
virtual void | SetFixedImage (const FixedImageType *_arg) |
virtual const FixedImageType * | GetFixedImage () const |
virtual void | SetMovingImage (const MovingImageType *_arg) |
virtual const MovingImageType * | GetMovingImage () const |
virtual void | SetMovingImageMask (const MovingImageMaskType *_arg) |
virtual const MovingImageMaskType * | GetMovingImageMask () const |
virtual void | SetFixedImageMask (const FixedImageMaskType *_arg) |
virtual const FixedImageMaskType * | GetFixedImageMask () const |
void | SetNumberOfWorkUnits (ThreadIdType numberOfThreads) |
virtual const ThreadIdType & | GetNumberOfWorkUnits () const |
virtual void | SetComputeGradient (bool _arg) |
virtual const bool & | GetComputeGradient () const |
virtual void | ComputeGradientOn () |
virtual void | SetNumberOfFixedImageSamples (SizeValueType numSamples) |
virtual const SizeValueType & | GetNumberOfFixedImageSamples () const |
void | ReinitializeSeed () |
void | ReinitializeSeed (int seed) |
virtual void | SetUseCachingOfBSplineWeights (bool _arg) |
virtual const bool & | GetUseCachingOfBSplineWeights () const |
virtual void | UseCachingOfBSplineWeightsOn () |
virtual MultiThreaderType * | GetModifiableThreader () |
const TransformPointer * | GetThreaderTransform () |
Public Member Functions inherited from itk::SingleValuedCostFunction | |
virtual void | GetDerivative (const ParametersType ¶meters, DerivativeType &derivative) const =0 |
const char * | GetNameOfClass () const override |
virtual MeasureType | GetValue (const ParametersType ¶meters) const =0 |
virtual void | GetValueAndDerivative (const ParametersType ¶meters, MeasureType &value, DerivativeType &derivative) const |
Public Member Functions inherited from itk::CostFunctionTemplate< double > | |
const char * | GetNameOfClass () const override |
virtual unsigned int | GetNumberOfParameters () const=0 |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *cmd) const |
unsigned long | AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const |
LightObject::Pointer | CreateAnother () const override |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary () |
const MetaDataDictionary & | GetMetaDataDictionary () const |
virtual ModifiedTimeType | GetMTime () const |
const char * | GetNameOfClass () const override |
virtual const TimeStamp & | GetTimeStamp () const |
bool | HasObserver (const EventObject &event) const |
void | InvokeEvent (const EventObject &) |
void | InvokeEvent (const EventObject &) const |
virtual void | Modified () const |
void | Register () const override |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) const |
void | SetDebug (bool debugFlag) const |
void | SetReferenceCount (int) override |
void | UnRegister () const noexcept override |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
void | SetMetaDataDictionary (MetaDataDictionary &&rrhs) |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
Public Member Functions inherited from itk::LightObject | |
Pointer | Clone () const |
virtual Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from itk::Object | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool val) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Protected Member Functions | |
NormalizedCorrelationImageToImageMetric () | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~NormalizedCorrelationImageToImageMetric () override=default | |
Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage > | |
virtual void | ComputeImageDerivatives (const MovingImagePointType &mappedPoint, ImageDerivativesType &gradient, ThreadIdType threadId) const |
void | GetValueAndDerivativeMultiThreadedInitiate () const |
void | GetValueAndDerivativeMultiThreadedPostProcessInitiate () const |
virtual void | GetValueAndDerivativeThread (ThreadIdType threadId) const |
virtual void | GetValueAndDerivativeThreadPostProcess (ThreadIdType, bool) const |
virtual void | GetValueAndDerivativeThreadPreProcess (ThreadIdType, bool) const |
virtual bool | GetValueAndDerivativeThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double, const ImageDerivativesType &) const |
ImageToImageMetric () | |
virtual void | PreComputeTransformValues () |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SampleFixedImageIndexes (FixedImageSampleContainer &samples) const |
virtual void | SampleFixedImageRegion (FixedImageSampleContainer &samples) const |
virtual void | SampleFullFixedImageRegion (FixedImageSampleContainer &samples) const |
virtual void | SynchronizeTransforms () const |
virtual void | TransformPoint (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleOk, double &movingImageValue, ThreadIdType threadId) const |
virtual void | TransformPointWithDerivatives (unsigned int sampleNumber, MovingImagePointType &mappedPoint, bool &sampleOk, double &movingImageValue, ImageDerivativesType &movingImageGradient, ThreadIdType threadId) const |
~ImageToImageMetric () override=default | |
void | GetValueMultiThreadedInitiate () const |
void | GetValueMultiThreadedPostProcessInitiate () const |
virtual void | GetValueThread (ThreadIdType threadId) const |
virtual void | GetValueThreadPreProcess (ThreadIdType, bool) const |
virtual bool | GetValueThreadProcessSample (ThreadIdType, SizeValueType, const MovingImagePointType &, double) const |
virtual void | GetValueThreadPostProcess (ThreadIdType, bool) const |
Protected Member Functions inherited from itk::SingleValuedCostFunction | |
SingleValuedCostFunction ()=default | |
~SingleValuedCostFunction () override | |
Protected Member Functions inherited from itk::CostFunctionTemplate< double > | |
CostFunctionTemplate ()=default | |
void | PrintSelf (std::ostream &os, Indent indent) const override |
~CostFunctionTemplate () override=default | |
Protected Member Functions inherited from itk::Object | |
Object () | |
bool | PrintObservers (std::ostream &os, Indent indent) const |
void | PrintSelf (std::ostream &os, Indent indent) const override |
virtual void | SetTimeStamp (const TimeStamp &timeStamp) |
~Object () override | |
Protected Member Functions inherited from itk::LightObject | |
virtual LightObject::Pointer | InternalClone () const |
LightObject () | |
virtual void | PrintHeader (std::ostream &os, Indent indent) const |
virtual void | PrintSelf (std::ostream &os, Indent indent) const |
virtual void | PrintTrailer (std::ostream &os, Indent indent) const |
virtual | ~LightObject () |
Private Attributes | |
bool | m_SubtractMean {} |
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer = SmartPointer<const Self> |
Definition at line 55 of file itkNormalizedCorrelationImageToImageMetric.h.
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::Pointer = SmartPointer<Self> |
Definition at line 54 of file itkNormalizedCorrelationImageToImageMetric.h.
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::Self = NormalizedCorrelationImageToImageMetric |
Standard class type aliases.
Definition at line 52 of file itkNormalizedCorrelationImageToImageMetric.h.
using itk::NormalizedCorrelationImageToImageMetric< TFixedImage, TMovingImage >::Superclass = ImageToImageMetric<TFixedImage, TMovingImage> |
Definition at line 53 of file itkNormalizedCorrelationImageToImageMetric.h.
|
protected |
|
overrideprotecteddefault |
|
override |
Get the derivatives of the match measure.
|
overridevirtual |
Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.
|
virtual |
Set/Get SubtractMean boolean. If true, the sample mean is subtracted from the sample values in the cross-correlation formula and typically results in narrower valleys in the cost function. Default value is false.
|
override |
Get the value for single valued optimizers.
|
override |
Get value and derivatives for multiple valued optimizers.
|
static |
Method for creation through the object factory.
|
overrideprotectedvirtual |
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.
|
virtual |
Set/Get SubtractMean boolean. If true, the sample mean is subtracted from the sample values in the cross-correlation formula and typically results in narrower valleys in the cost function. Default value is false.
|
virtual |
Set/Get SubtractMean boolean. If true, the sample mean is subtracted from the sample values in the cross-correlation formula and typically results in narrower valleys in the cost function. Default value is false.
|
private |
Definition at line 110 of file itkNormalizedCorrelationImageToImageMetric.h.