itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage > Class Template Reference

#include <itkKappaStatisticImageToImageMetric.h>

Detailed Description

template<typename TFixedImage, typename TMovingImage>
class itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >

Computes similarity between two binary objects to be registered.

This Class is templated over the type of the fixed and moving images to be compared. The metric here is designed for matching pixels in two images with the same exact value. Only one value can be considered (the default is 255) and can be specified with the SetForegroundValue method. In the computation of the metric, only foreground pixels are considered. The metric value is given by 2*|A&B|/(|A|+|B|), where A is the foreground region in the moving image, B is the foreground region in the fixed image, & is intersection, and |.| indicates the area of the enclosed set. The metric is described in "Morphometric Analysis of White Matter Lesions in MR Images: Method and Validation", A. P. Zijdenbos, B. M. Dawant, R. A. Margolin, A. C. Palmer.

This metric is especially useful when considering the similarity between binary images. Given the nature of binary images, a nearest neighbor interpolator is the preferred interpolator.

Metric values range from 0.0 (no foreground alignment) to 1.0 (perfect foreground alignment). When dealing with optimizers that can only minimize a metric, use the ComplementOn() method.

Definition at line 54 of file itkKappaStatisticImageToImageMetric.h.

Inheritance diagram for itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >:

Collaboration diagram for itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >:

Public Types
using	ConstPointer = SmartPointer<const Self>
using	DerivativeType
using	FixedImageConstPointer
using	FixedImageRegionType
using	FixedImageType
using	GradientImageType
using	GradientPixelType
using	InputPointType
using	MeasureType
using	MovingImageConstPointer
using	MovingImageType
using	OutputPointType
using	Pointer = SmartPointer<Self>
using	RealType
using	Self = KappaStatisticImageToImageMetric
using	Superclass = ImageToImageMetric<TFixedImage, TMovingImage>
using	TransformJacobianType
using	TransformParametersType
using	TransformPointer
using	TransformType
Public Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
using	ConstPointer = SmartPointer<const Self>
using	CoordinateRepresentationType = Superclass::ParametersValueType
using	DerivativeType
using	FixedImageConstPointer = typename FixedImageType::ConstPointer
using	FixedImageIndexContainer = std::vector<FixedImageIndexType>
using	FixedImageIndexType = typename FixedImageType::IndexType
using	FixedImageIndexValueType = typename FixedImageIndexType::IndexValueType
using	FixedImageMaskConstPointer = typename FixedImageMaskType::ConstPointer
using	FixedImageMaskPointer = typename FixedImageMaskType::Pointer
using	FixedImageMaskType = SpatialObject<Self::FixedImageDimension>
using	FixedImagePixelType = typename TFixedImage::PixelType
using	FixedImagePointType = typename TransformType::InputPointType
using	FixedImageRegionType = typename FixedImageType::RegionType
using	FixedImageType = TFixedImage
using	GradientImageFilterPointer = typename GradientImageFilterType::Pointer
using	GradientImageFilterType = GradientRecursiveGaussianImageFilter<MovingImageType, GradientImageType>
using	GradientImagePointer = SmartPointer<GradientImageType>
using	GradientImageType = Image<GradientPixelType, Self::MovingImageDimension>
using	GradientPixelType = CovariantVector<RealType, Self::MovingImageDimension>
using	InputPointType = typename TransformType::InputPointType
using	InterpolatorPointer = typename InterpolatorType::Pointer
using	InterpolatorType = InterpolateImageFunction<MovingImageType, CoordinateRepresentationType>
using	MeasureType
using	MovingImageConstPointer = typename MovingImageType::ConstPointer
using	MovingImageIndexType = typename MovingImageType::IndexType
using	MovingImageMaskConstPointer = typename MovingImageMaskType::ConstPointer
using	MovingImageMaskPointer = typename MovingImageMaskType::Pointer
using	MovingImageMaskType = SpatialObject<Self::MovingImageDimension>
using	MovingImagePixelType = typename TMovingImage::PixelType
using	MovingImagePointType = typename TransformType::OutputPointType
using	MovingImageType = TMovingImage
using	OutputPointType = typename TransformType::OutputPointType
using	ParametersType
using	Pointer = SmartPointer<Self>
using	RealType = typename NumericTraits<MovingImagePixelType>::RealType
using	Self = ImageToImageMetric
using	Superclass = SingleValuedCostFunction
using	TransformJacobianType = typename TransformType::JacobianType
using	TransformParametersType = typename TransformType::ParametersType
using	TransformPointer = typename TransformType::Pointer
using	TransformType = Transform<CoordinateRepresentationType, Self::MovingImageDimension, Self::FixedImageDimension>
Public Types inherited from itk::SingleValuedCostFunction
using	ConstPointer = SmartPointer<const Self>
using	DerivativeType = Array<ParametersValueType>
using	MeasureType = double
using	ParametersType = Superclass::ParametersType
using	ParametersValueType = Superclass::ParametersValueType
using	Pointer = SmartPointer<Self>
using	Self = SingleValuedCostFunction
using	Superclass = CostFunction
Public Types inherited from itk::CostFunctionTemplate< double >
using	ConstPointer
using	ParametersType
using	ParametersValueType
using	Pointer
using	Self
using	Superclass
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer<const Self>
using	Pointer = SmartPointer<Self>
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer<const Self>
using	Pointer = SmartPointer<Self>
using	Self = LightObject

Public Member Functions
void	ComputeGradient () override
virtual::itk::LightObject::Pointer	CreateAnother () const
void	GetDerivative (const TransformParametersType &, DerivativeType &derivative) const override
virtual const char *	GetNameOfClass () const
MeasureType	GetValue (const TransformParametersType &parameters) const override
void	GetValueAndDerivative (const TransformParametersType &parameters, MeasureType &Value, DerivativeType &Derivative) const override
virtual void	SetForegroundValue (RealType _arg)
virtual RealType	GetForegroundValue () const
virtual void	SetComplement (bool _arg)
virtual void	ComplementOn ()
virtual void	ComplementOff ()
virtual bool	GetComplement () const
Public Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
virtual const FixedImageRegionType &	GetFixedImageRegion () const
virtual const FixedImagePixelType &	GetFixedImageSamplesIntensityThreshold () const
virtual const GradientImageType *	GetGradientImage () const
virtual const InterpolatorType *	GetInterpolator () const
virtual GradientImageType *	GetModifiableGradientImage ()
virtual InterpolatorType *	GetModifiableInterpolator ()
virtual TransformType *	GetModifiableTransform ()
SizeValueType	GetNumberOfMovingImageSamples ()
unsigned int	GetNumberOfParameters () const override
virtual const SizeValueType &	GetNumberOfPixelsCounted () const
SizeValueType	GetNumberOfSpatialSamples ()
virtual const TransformType *	GetTransform () const
virtual const bool &	GetUseAllPixels () const
virtual const bool &	GetUseFixedImageIndexes () const
virtual const bool &	GetUseFixedImageSamplesIntensityThreshold () const
virtual const bool &	GetUseSequentialSampling () const
virtual void	Initialize ()
	itkVirtualSetObjectMacro (Transform, TransformType)
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)
void	SetTransformParameters (const ParametersType &parameters) 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 numberOfWorkUnits)
virtual const ThreadIdType &	GetNumberOfWorkUnits () const
virtual void	SetComputeGradient (bool _arg)
virtual const bool &	GetComputeGradient () const
virtual void	ComputeGradientOn ()
virtual void	ComputeGradientOff ()
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 void	UseCachingOfBSplineWeightsOff ()
virtual MultiThreaderBase *	GetModifiableThreader ()
virtual const MultiThreaderBase *	GetThreader () const
const TransformPointer *	GetThreaderTransform ()
Public Member Functions inherited from itk::SingleValuedCostFunction
virtual void	GetDerivative (const ParametersType &parameters, DerivativeType &derivative) const =0
virtual MeasureType	GetValue (const ParametersType &parameters) const =0
virtual void	GetValueAndDerivative (const ParametersType &parameters, MeasureType &value, DerivativeType &derivative) const
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
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 void	Delete ()
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const

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
	KappaStatisticImageToImageMetric ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~KappaStatisticImageToImageMetric () 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 threadId, bool withinSampleThread) const
virtual void	GetValueAndDerivativeThreadPreProcess (ThreadIdType threadId, bool withinSampleThread) const
virtual bool	GetValueAndDerivativeThreadProcessSample (ThreadIdType threadId, SizeValueType fixedImageSample, const MovingImagePointType &mappedPoint, double movingImageValue, const ImageDerivativesType &movingImageGradientValue) const
void	GetValueMultiThreadedInitiate () const
void	GetValueMultiThreadedPostProcessInitiate () const
virtual void	GetValueThread (ThreadIdType threadId) const
	ImageToImageMetric ()
virtual void	PreComputeTransformValues ()
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
virtual void	GetValueThreadPreProcess (ThreadIdType threadId, bool withinSampleThread) const
virtual bool	GetValueThreadProcessSample (ThreadIdType threadId, SizeValueType fixedImageSample, const MovingImagePointType &mappedPoint, double movingImageValue) const
virtual void	GetValueThreadPostProcess (ThreadIdType threadId, bool withinSampleThread) const
Protected Member Functions inherited from itk::SingleValuedCostFunction
	SingleValuedCostFunction ()=default
	~SingleValuedCostFunction () override
Protected Member Functions inherited from itk::CostFunctionTemplate< double >
	CostFunctionTemplate ()=default
	CostFunctionTemplate ()=default
	~CostFunctionTemplate () override=default
	~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	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Attributes
bool	m_Complement { false }
RealType	m_ForegroundValue {}

Additional Inherited Members
Static Public Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static constexpr unsigned int	FixedImageDimension = TFixedImage::ImageDimension
static constexpr unsigned int	MovingImageDimension = TMovingImage::ImageDimension
Protected Types inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
using	BooleanArrayType = std::vector<bool>
using	BSplineInterpolatorType = BSplineInterpolateImageFunction<MovingImageType, CoordinateRepresentationType>
using	BSplineParametersOffsetType = FixedArray<SizeValueType, FixedImageType::ImageDimension>
using	BSplineTransformIndexArrayType = typename BSplineTransformType::ParameterIndexArrayType
using	BSplineTransformIndicesArrayType = Array2D<IndexValueType>
using	BSplineTransformType
using	BSplineTransformWeightsArrayType = Array2D<WeightsValueType>
using	BSplineTransformWeightsType = typename BSplineTransformType::WeightsType
using	DerivativeFunctionType = CentralDifferenceImageFunction<MovingImageType, CoordinateRepresentationType>
using	FixedImageSampleContainer = std::vector<FixedImageSamplePoint>
using	ImageDerivativesType = CovariantVector<double, Self::MovingImageDimension>
using	IndexValueType = typename BSplineTransformIndexArrayType::ValueType
using	MovingImagePointArrayType = std::vector<MovingImagePointType>
using	WeightsValueType = typename BSplineTransformWeightsType::ValueType
Static Protected Member Functions inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueAndDerivativeMultiThreaded (void *workunitInfoAsVoid)
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueAndDerivativeMultiThreadedPostProcess (void *workunitInfoAsVoid)
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueMultiThreaded (void *workunitInfoAsVoid)
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	GetValueMultiThreadedPostProcess (void *workunitInfoAsVoid)
Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
BSplineInterpolatorType::Pointer	m_BSplineInterpolator {}
BSplineParametersOffsetType	m_BSplineParametersOffset {}
MovingImagePointArrayType	m_BSplinePreTransformPointsArray {}
BSplineTransformType::Pointer	m_BSplineTransform {}
BSplineTransformIndexArrayType	m_BSplineTransformIndices {}
BSplineTransformIndicesArrayType	m_BSplineTransformIndicesArray {}
BSplineTransformWeightsType	m_BSplineTransformWeights {}
BSplineTransformWeightsArrayType	m_BSplineTransformWeightsArray {}
bool	m_ComputeGradient { true }
std::unique_ptr< ConstantPointerWrapper >	m_ConstSelfWrapper
DerivativeFunctionType::Pointer	m_DerivativeCalculator {}
FixedImageConstPointer	m_FixedImage {}
FixedImageIndexContainer	m_FixedImageIndexes {}
FixedImageMaskConstPointer	m_FixedImageMask {}
FixedImageSampleContainer	m_FixedImageSamples {}
FixedImagePixelType	m_FixedImageSamplesIntensityThreshold {}
GradientImagePointer	m_GradientImage {}
InterpolatorPointer	m_Interpolator {}
MovingImageConstPointer	m_MovingImage {}
MovingImageMaskConstPointer	m_MovingImageMask {}
SizeValueType	m_NumberOfFixedImageSamples { 50000 }
SizeValueType	m_NumberOfParameters { 0 }
SizeValueType	m_NumberOfPixelsCounted { 0 }
ThreadIdType	m_NumberOfWorkUnits { 1 }
SizeValueType	m_NumBSplineWeights { 0 }
int	m_RandomSeed {}
bool	m_ReseedIterator { false }
MultiThreaderBase::Pointer	m_Threader {}
std::unique_ptr< BSplineTransformIndexArrayType[]>	m_ThreaderBSplineTransformIndices
std::unique_ptr< BSplineTransformWeightsType[]>	m_ThreaderBSplineTransformWeights
std::unique_ptr< unsigned int[]>	m_ThreaderNumberOfMovingImageSamples
std::unique_ptr< TransformPointer[]>	m_ThreaderTransform
TransformPointer	m_Transform {}
bool	m_UseAllPixels { false }
bool	m_UseCachingOfBSplineWeights { true }
bool	m_UseFixedImageIndexes { false }
bool	m_UseFixedImageSamplesIntensityThreshold { false }
bool	m_UseSequentialSampling { false }
BooleanArrayType	m_WithinBSplineSupportRegionArray {}
bool	m_WithinThreadPostProcess { false }
bool	m_WithinThreadPreProcess { false }
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}
Static Protected Attributes inherited from itk::ImageToImageMetric< TFixedImage, TMovingImage >
static constexpr unsigned int	DeformationSplineOrder = 3

Member Typedef Documentation

ConstPointer

template<typename TFixedImage, typename TMovingImage>

using itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::ConstPointer = SmartPointer<const Self>

Definition at line 63 of file itkKappaStatisticImageToImageMetric.h.

DerivativeType

template<typename TFixedImage, typename TMovingImage>

using itk::SingleValuedCostFunction::DerivativeType

DerivativeType type alias. It defines a type used to return the cost function derivative.

Definition at line 133 of file itkSingleValuedCostFunction.h.

FixedImageConstPointer

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageConstPointer

Definition at line 79 of file itkImageToImageMetric.h.

FixedImageRegionType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageRegionType

Definition at line 80 of file itkImageToImageMetric.h.

FixedImageType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::FixedImageType

Type of the fixed Image.

Definition at line 77 of file itkImageToImageMetric.h.

GradientImageType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::GradientImageType

Definition at line 110 of file itkImageToImageMetric.h.

GradientPixelType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::GradientPixelType

Definition at line 109 of file itkImageToImageMetric.h.

InputPointType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::InputPointType

Definition at line 90 of file itkImageToImageMetric.h.

MeasureType

template<typename TFixedImage, typename TMovingImage>

using itk::SingleValuedCostFunction::MeasureType

MeasureType type alias. It defines a type used to return the cost function value.

Definition at line 130 of file itkSingleValuedCostFunction.h.

MovingImageConstPointer

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImageConstPointer

Definition at line 74 of file itkImageToImageMetric.h.

MovingImageType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::MovingImageType

Type of the moving Image.

Definition at line 72 of file itkImageToImageMetric.h.

OutputPointType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::OutputPointType

Definition at line 91 of file itkImageToImageMetric.h.

Pointer

template<typename TFixedImage, typename TMovingImage>

using itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::Pointer = SmartPointer<Self>

Definition at line 62 of file itkKappaStatisticImageToImageMetric.h.

RealType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::RealType

Gaussian filter to compute the gradient of the Moving Image

Definition at line 108 of file itkImageToImageMetric.h.

Self

template<typename TFixedImage, typename TMovingImage>

using itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::Self = KappaStatisticImageToImageMetric

Standard class type aliases.

Definition at line 60 of file itkKappaStatisticImageToImageMetric.h.

Superclass

template<typename TFixedImage, typename TMovingImage>

using itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::Superclass = ImageToImageMetric<TFixedImage, TMovingImage>

Definition at line 61 of file itkKappaStatisticImageToImageMetric.h.

TransformJacobianType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformJacobianType

Definition at line 93 of file itkImageToImageMetric.h.

TransformParametersType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformParametersType

Definition at line 92 of file itkImageToImageMetric.h.

TransformPointer

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformPointer

Definition at line 89 of file itkImageToImageMetric.h.

TransformType

template<typename TFixedImage, typename TMovingImage>

using itk::ImageToImageMetric< TFixedImage, TMovingImage >::TransformType

Type of the Transform Base class

Definition at line 87 of file itkImageToImageMetric.h.

Constructor & Destructor Documentation

KappaStatisticImageToImageMetric()

template<typename TFixedImage, typename TMovingImage>

itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::KappaStatisticImageToImageMetric ( )

protected

Referenced by GetNameOfClass().

~KappaStatisticImageToImageMetric()

template<typename TFixedImage, typename TMovingImage>

itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::~KappaStatisticImageToImageMetric ( )

overrideprotecteddefault

Member Function Documentation

ComplementOff()

template<typename TFixedImage, typename TMovingImage>

virtual void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::ComplementOff ( )

virtual

Set/Get whether this metric returns 2*|A&B|/(|A|+|B|) (ComplementOff, the default) or 1.0 - 2*|A&B|/(|A|+|B|) (ComplementOn). When using an optimizer that minimizes metric values use ComplementOn().

ComplementOn()

template<typename TFixedImage, typename TMovingImage>

virtual void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::ComplementOn ( )

virtual

Set/Get whether this metric returns 2*|A&B|/(|A|+|B|) (ComplementOff, the default) or 1.0 - 2*|A&B|/(|A|+|B|) (ComplementOn). When using an optimizer that minimizes metric values use ComplementOn().

ComputeGradient()

template<typename TFixedImage, typename TMovingImage>

void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::ComputeGradient ( )

overridevirtual

Computes the gradient image and assigns it to m_GradientImage

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

CreateAnother()

template<typename TFixedImage, typename TMovingImage>

virtual::itk::LightObject::Pointer itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

GetComplement()

template<typename TFixedImage, typename TMovingImage>

virtual bool itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GetComplement ( ) const

virtual

Set/Get whether this metric returns 2*|A&B|/(|A|+|B|) (ComplementOff, the default) or 1.0 - 2*|A&B|/(|A|+|B|) (ComplementOn). When using an optimizer that minimizes metric values use ComplementOn().

GetDerivative()

template<typename TFixedImage, typename TMovingImage>

void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative ( const TransformParametersType & , DerivativeType & derivative ) const

override

Get the derivatives of the match measure.

GetForegroundValue()

template<typename TFixedImage, typename TMovingImage>

virtual RealType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GetForegroundValue ( ) const

virtual

This method allows the user to set the foreground value. The default value is 255.

GetNameOfClass()

template<typename TFixedImage, typename TMovingImage>

virtual const char * itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GetNameOfClass ( ) const

virtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::ImageToImageMetric< TFixedImage, TMovingImage >.

References KappaStatisticImageToImageMetric().

GetValue()

template<typename TFixedImage, typename TMovingImage>

MeasureType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GetValue ( const TransformParametersType & parameters ) const

override

Get the value of the metric at a particular parameter setting. The metric value is given by 2*|A&B|/(|A|+|B|), where A is the moving image, B is the fixed image, & is intersection, and |.| indicates the area of the enclosed set. If ComplementOn has been set, the metric value is 1.0-2*|A&B|/(|A|+|B|).

GetValueAndDerivative()

template<typename TFixedImage, typename TMovingImage>

void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::GetValueAndDerivative ( const TransformParametersType & parameters, MeasureType & Value, DerivativeType & Derivative ) const

override

Get both the value and derivative. This method internally calls the GetValue() and the GetDerivative() method.

New()

template<typename TFixedImage, typename TMovingImage>

static Pointer itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::New ( )

static

Method for creation through the object factory.

PrintSelf()

template<typename TFixedImage, typename TMovingImage>

void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::PrintSelf ( std::ostream & os, Indent indent ) const

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 >.

SetComplement()

template<typename TFixedImage, typename TMovingImage>

virtual void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::SetComplement ( bool _arg )

virtual

Set/Get whether this metric returns 2*|A&B|/(|A|+|B|) (ComplementOff, the default) or 1.0 - 2*|A&B|/(|A|+|B|) (ComplementOn). When using an optimizer that minimizes metric values use ComplementOn().

SetForegroundValue()

template<typename TFixedImage, typename TMovingImage>

virtual void itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::SetForegroundValue ( RealType _arg )

virtual

This method allows the user to set the foreground value. The default value is 255.

Member Data Documentation

m_Complement

template<typename TFixedImage, typename TMovingImage>

bool itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::m_Complement { false }

private

Definition at line 136 of file itkKappaStatisticImageToImageMetric.h.

m_ForegroundValue

template<typename TFixedImage, typename TMovingImage>

RealType itk::KappaStatisticImageToImageMetric< TFixedImage, TMovingImage >::m_ForegroundValue {}

private

Definition at line 135 of file itkKappaStatisticImageToImageMetric.h.

---

The documentation for this class was generated from the following file:

• itkKappaStatisticImageToImageMetric.h