#include <itkMahalanobisDistanceThresholdImageFunction.h>

Inheritance diagram for itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >:

Collaboration diagram for itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ContinuousIndexType = typename Superclass::ContinuousIndexType

using	CovarianceMatrixType = vnl_matrix< double >

using	IndexType = typename Superclass::IndexType

using	InputImageType = typename Superclass::InputImageType

using	MeanVectorType = vnl_vector< double >

using	PixelType = typename TInputImage::PixelType

using	Pointer = SmartPointer< Self >

using	PointType = typename Superclass::PointType

using	Self = MahalanobisDistanceThresholdImageFunction

using	Superclass = ImageFunction< TInputImage, bool, TCoordRep >

Public Types inherited from itk::ImageFunction< TInputImage, bool, TCoordRep >
using	ConstPointer = SmartPointer< const Self >

using	ContinuousIndexType = ContinuousIndex< TCoordRep, Self::ImageDimension >

using	CoordRepType = TCoordRep

using	IndexType = typename InputImageType::IndexType

using	IndexValueType = typename InputImageType::IndexValueType

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImageType = TInputImage

using	InputPixelType = typename InputImageType::PixelType

using	OutputType = bool

using	Pointer = SmartPointer< Self >

using	PointType = Point< TCoordRep, Self::ImageDimension >

using	Self = ImageFunction

using	Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, bool >

Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, bool >
using	ConstPointer = SmartPointer< const Self >

using	InputType = Point< TCoordRep, TInputImage::ImageDimension >

using	OutputType = bool

using	Pointer = SmartPointer< Self >

using	Self = FunctionBase

using	Superclass = Object

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
virtual ::itk::LightObject::Pointer	CreateAnother () const

bool	Evaluate (const PointType &point) const override

bool	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override

bool	EvaluateAtIndex (const IndexType &index) const override

virtual double	EvaluateDistance (const PointType &point) const

virtual double	EvaluateDistanceAtIndex (const IndexType &index) const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::ImageFunction< TInputImage, bool, TCoordRep >
bool	Evaluate (const PointType &point) const override=0

virtual bool	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0

virtual bool	EvaluateAtIndex (const IndexType &index) const=0

const InputImageType *	GetInputImage () const

virtual void	SetInputImage (const InputImageType *ptr)

virtual bool	IsInsideBuffer (const IndexType &index) const

virtual bool	IsInsideBuffer (const ContinuousIndexType &index) const

virtual bool	IsInsideBuffer (const PointType &point) const

void	ConvertPointToNearestIndex (const PointType &point, IndexType &index) const

void	ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const

void	ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const

virtual const IndexType &	GetStartIndex () const

virtual const IndexType &	GetEndIndex () const

virtual const ContinuousIndexType &	GetStartContinuousIndex () const

virtual const ContinuousIndexType &	GetEndContinuousIndex () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

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)

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 ()

Static Public Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::ImageFunction< TInputImage, bool, TCoordRep >
static constexpr unsigned int	ImageDimension

using	MahalanobisDistanceFunctionType = Statistics::MahalanobisDistanceMembershipFunction< PixelType >

using	MahalanobisDistanceFunctionPointer = typename MahalanobisDistanceFunctionType::Pointer

double	m_Threshold

MahalanobisDistanceFunctionPointer	m_MahalanobisDistanceMembershipFunction

MeanVectorType	m_Mean

CovarianceMatrixType	m_Covariance

virtual const double &	GetThreshold () const

virtual void	SetThreshold (double _arg)

void	SetMean (const MeanVectorType &mean)

virtual const MeanVectorType &	GetMean () const

void	SetCovariance (const CovarianceMatrixType &covariance)

virtual const CovarianceMatrixType &	GetCovariance () const

	MahalanobisDistanceThresholdImageFunction ()

	~MahalanobisDistanceThresholdImageFunction () override=default

void	PrintSelf (std::ostream &os, Indent indent) const override

Additional Inherited Members
Protected Member Functions inherited from itk::ImageFunction< TInputImage, bool, TCoordRep >
	ImageFunction ()

	~ImageFunction () override=default

void	PrintSelf (std::ostream &os, Indent indent) const override

Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, bool >
	FunctionBase ()=default

	~FunctionBase () override=default

Protected Member Functions inherited from itk::Object
	Object ()

	~Object () override

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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 ()

Protected Attributes inherited from itk::ImageFunction< TInputImage, bool, TCoordRep >
InputImageConstPointer	m_Image

IndexType	m_StartIndex

IndexType	m_EndIndex

ContinuousIndexType	m_StartContinuousIndex

ContinuousIndexType	m_EndContinuousIndex

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Detailed Description

template<typename TInputImage, typename TCoordRep = float>
class itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >

Returns true if the pixel value of a vector image has a Mahalanobis distance below the value specified by the threshold.

This ImageFunction returns true if the pixel value of a vector image has a Mahalanobis distance below the value specified by the threshold. The Mahalanobis distance is computed with the MahalanobisDistanceMembershipFunction class which has to be initialized with a mean and covariance. This class is intended to be used only with images whose pixel type is a vector (array).

The input image is set via method SetInputImage().

Methods Evaluate, EvaluateAtIndex and EvaluateAtContinuousIndex respectively evaluate the function at an geometric point, image index and continuous image index.

Definition at line 50 of file itkMahalanobisDistanceThresholdImageFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::ConstPointer = SmartPointer<const Self>

Definition at line 59 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ ContinuousIndexType

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::ContinuousIndexType = typename Superclass::ContinuousIndexType

ContinuousIndex type alias support

Definition at line 83 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ CovarianceMatrixType

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::CovarianceMatrixType = vnl_matrix<double>

Type used to represent the Covariance matrix of the vector population.

Definition at line 86 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ IndexType

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::IndexType = typename Superclass::IndexType

Index type alias support

Definition at line 80 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ InputImageType

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::InputImageType = typename Superclass::InputImageType

InputImageType type alias support

Definition at line 68 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ MahalanobisDistanceFunctionPointer

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::MahalanobisDistanceFunctionPointer = typename MahalanobisDistanceFunctionType::Pointer

private

Get the lower threshold value.

Definition at line 173 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ MahalanobisDistanceFunctionType

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::MahalanobisDistanceFunctionType = Statistics::MahalanobisDistanceMembershipFunction<PixelType>

private

Get the lower threshold value.

Definition at line 171 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ MeanVectorType

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::MeanVectorType = vnl_vector<double>

Type used to represent the Mean Vector of the vector population.

Definition at line 89 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ PixelType

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::PixelType = typename TInputImage::PixelType

Typedef to describe the type of pixel.

Definition at line 71 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::Pointer = SmartPointer<Self>

Definition at line 58 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ PointType

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::PointType = typename Superclass::PointType

Point type alias support

Definition at line 77 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::Self = MahalanobisDistanceThresholdImageFunction

Standard class type aliases.

Definition at line 56 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = float>

using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::Superclass = ImageFunction<TInputImage, bool, TCoordRep>

Definition at line 57 of file itkMahalanobisDistanceThresholdImageFunction.h.

Constructor & Destructor Documentation

◆ MahalanobisDistanceThresholdImageFunction()

template<typename TInputImage , typename TCoordRep = float>

itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::MahalanobisDistanceThresholdImageFunction ( )

protected

Get the lower threshold value.

◆ ~MahalanobisDistanceThresholdImageFunction()

template<typename TInputImage , typename TCoordRep = float>

itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::~MahalanobisDistanceThresholdImageFunction ( )

overrideprotecteddefault

Get the lower threshold value.

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage , typename TCoordRep = float>

virtual::itk::LightObject::Pointer itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::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::Object.

◆ Evaluate()

template<typename TInputImage , typename TCoordRep = float>

bool itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType & point ) const

override

BinaryThreshold the image at a point position

Returns true if the image intensity at the specified point position satisfies the threshold criteria. The point is assumed to lie within the image buffer.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = float>

bool itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType & index ) const

override

BinaryThreshold the image at a continuous index position

Returns true if the image intensity at the specified point position satisfies the threshold criteria. The point is assumed to lie within the image buffer.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordRep = float>

bool itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType & index ) const

override

BinaryThreshold the image at an index position.

Returns true if the image intensity at the specified point position satisfies the threshold criteria. The point is assumed to lie within the image buffer.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

◆ EvaluateDistance()

template<typename TInputImage , typename TCoordRep = float>

virtual double itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::EvaluateDistance ( const PointType & point ) const

virtual

Returns the actual value of the MahalanobisDistance at that point. The point is assumed to lie within the image buffer. ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

◆ EvaluateDistanceAtIndex()

template<typename TInputImage , typename TCoordRep = float>

virtual double itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::EvaluateDistanceAtIndex ( const IndexType & index ) const

virtual

Returns the actual value of the MahalanobisDistance at that index. The point is assumed to lie within the image buffer. ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

◆ GetCovariance()

template<typename TInputImage , typename TCoordRep = float>

virtual const CovarianceMatrixType& itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::GetCovariance ( ) const

virtual

Get the covariance matrix. The covariance matrix set on the membership function matches this value.

◆ GetMean()

template<typename TInputImage , typename TCoordRep = float>

virtual const MeanVectorType& itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::GetMean ( ) const

virtual

Get the mean. The mean set on the membership function matches this value.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = float>

virtual const char* itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, bool, TCoordRep >.

◆ GetThreshold()

template<typename TInputImage , typename TCoordRep = float>

virtual const double& itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::GetThreshold ( ) const

virtual

Get the lower threshold value.

◆ New()

template<typename TInputImage , typename TCoordRep = float>

static Pointer itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TCoordRep = float>

void itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

Get the lower threshold value.

Reimplemented from itk::Object.

◆ SetCovariance()

template<typename TInputImage , typename TCoordRep = float>

void itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::SetCovariance ( const CovarianceMatrixType & covariance )

Set the covariance matrix. Set this covariance matrix to the membership function.

◆ SetMean()

template<typename TInputImage , typename TCoordRep = float>

void itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::SetMean ( const MeanVectorType & mean )

Set the mean. Set this mean value to the membership function.

◆ SetThreshold()

template<typename TInputImage , typename TCoordRep = float>

virtual void itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::SetThreshold ( double _arg )

virtual

Get the lower threshold value.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = float>

constexpr unsigned int itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Dimension underlying input image.

Definition at line 74 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ m_Covariance

template<typename TInputImage , typename TCoordRep = float>

CovarianceMatrixType itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::m_Covariance

private

Get the lower threshold value.

Definition at line 180 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ m_MahalanobisDistanceMembershipFunction

template<typename TInputImage , typename TCoordRep = float>

MahalanobisDistanceFunctionPointer itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::m_MahalanobisDistanceMembershipFunction

private

Get the lower threshold value.

Definition at line 174 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ m_Mean

template<typename TInputImage , typename TCoordRep = float>

MeanVectorType itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::m_Mean

private

Get the lower threshold value.

Definition at line 179 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ m_Threshold

template<typename TInputImage , typename TCoordRep = float>

double itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >::m_Threshold

private

Get the lower threshold value.

Definition at line 168 of file itkMahalanobisDistanceThresholdImageFunction.h.

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

itkMahalanobisDistanceThresholdImageFunction.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

template<typename TInputImage, typename TCoordRep = float> class itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >

Member Typedef Documentation

◆ ConstPointer

◆ ContinuousIndexType

◆ CovarianceMatrixType

◆ IndexType

◆ InputImageType

◆ MahalanobisDistanceFunctionPointer

◆ MahalanobisDistanceFunctionType

◆ MeanVectorType

◆ PixelType

◆ Pointer

◆ PointType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ MahalanobisDistanceThresholdImageFunction()

◆ ~MahalanobisDistanceThresholdImageFunction()

Member Function Documentation

◆ CreateAnother()

◆ Evaluate()

◆ EvaluateAtContinuousIndex()

◆ EvaluateAtIndex()

◆ EvaluateDistance()

◆ EvaluateDistanceAtIndex()

◆ GetCovariance()

◆ GetMean()

◆ GetNameOfClass()

◆ GetThreshold()

◆ New()

◆ PrintSelf()

◆ SetCovariance()

◆ SetMean()

◆ SetThreshold()

Member Data Documentation

◆ ImageDimension

◆ m_Covariance

◆ m_MahalanobisDistanceMembershipFunction

◆ m_Mean

◆ m_Threshold

template<typename TInputImage, typename TCoordRep = float>
class itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordRep >