ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Types | Private Attributes | List of all members
itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate > Class Template Reference
Data Processing Objects » Functions » Image FunctionsGroup Core » | Module ITKImageFunction

#include <itkMahalanobisDistanceThresholdImageFunction.h>

Detailed Description

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

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.

+ Inheritance diagram for itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >:
+ Collaboration diagram for itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using CovarianceMatrixType = vnl_matrix< double >
 
using MeanVectorType = vnl_vector< double >
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = MahalanobisDistanceThresholdImageFunction
 
using Superclass = ImageFunction< TInputImage, bool, TCoordinate >
 
- Public Types inherited from itk::ImageFunction< TInputImage, bool, TCoordinate >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< TCoordinate, Self::ImageDimension >
 
using CoordinateType = TCoordinate
 
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< TCoordinate, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TCoordinate, Self::ImageDimension >, bool >
 
- Public Types inherited from itk::FunctionBase< Point< TCoordinate, TInputImage::ImageDimension >, bool >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TCoordinate, 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

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 CovarianceMatrixType & GetCovariance () const
 
virtual const MeanVectorType & GetMean () const
 
const char * GetNameOfClass () const override
 
void SetCovariance (const CovarianceMatrixType &covariance)
 
void SetMean (const MeanVectorType &mean)
 
virtual const double & GetThreshold () const
 
virtual void SetThreshold (double _arg)
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, bool, TCoordinate >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
virtual const ContinuousIndexType & GetEndContinuousIndex () const
 
virtual const IndexType & GetEndIndex () const
 
const InputImageType * GetInputImage () const
 
const char * GetNameOfClass () const override
 
virtual const ContinuousIndexType & GetStartContinuousIndex () const
 
virtual const IndexType & GetStartIndex () 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
 
- 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 ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, bool, TCoordinate >
static constexpr unsigned int ImageDimension
 

Protected Member Functions

 MahalanobisDistanceThresholdImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~MahalanobisDistanceThresholdImageFunction () override=default
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, bool, TCoordinate >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFunction () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordinate, TInputImage::ImageDimension >, bool >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
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 Types

using MahalanobisDistanceFunctionPointer = typename MahalanobisDistanceFunctionType::Pointer
 
using MahalanobisDistanceFunctionType = Statistics::MahalanobisDistanceMembershipFunction< PixelType >
 

Private Attributes

CovarianceMatrixType m_Covariance {}
 
MahalanobisDistanceFunctionPointer m_MahalanobisDistanceMembershipFunction {}
 
MeanVectorType m_Mean {}
 
double m_Threshold {}
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, bool, TCoordinate >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TCoordinate = float>
using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::ConstPointer = SmartPointer<const Self>

Definition at line 60 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ CovarianceMatrixType

template<typename TInputImage , typename TCoordinate = float>
using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::CovarianceMatrixType = vnl_matrix<double>

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

Definition at line 87 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ MahalanobisDistanceFunctionPointer

template<typename TInputImage , typename TCoordinate = float>
using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::MahalanobisDistanceFunctionPointer = typename MahalanobisDistanceFunctionType::Pointer
private

Definition at line 174 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ MahalanobisDistanceFunctionType

template<typename TInputImage , typename TCoordinate = float>
using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::MahalanobisDistanceFunctionType = Statistics::MahalanobisDistanceMembershipFunction<PixelType>
private

Definition at line 172 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ MeanVectorType

template<typename TInputImage , typename TCoordinate = float>
using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::MeanVectorType = vnl_vector<double>

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

Definition at line 90 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ PixelType

template<typename TInputImage , typename TCoordinate = float>
using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::PixelType = typename TInputImage::PixelType

Typedef to describe the type of pixel.

Definition at line 72 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordinate = float>
using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::Pointer = SmartPointer<Self>

Definition at line 59 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordinate = float>
using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::Self = MahalanobisDistanceThresholdImageFunction

Standard class type aliases.

Definition at line 57 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordinate = float>
using itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::Superclass = ImageFunction<TInputImage, bool, TCoordinate>

Definition at line 58 of file itkMahalanobisDistanceThresholdImageFunction.h.

Constructor & Destructor Documentation

◆ MahalanobisDistanceThresholdImageFunction()

template<typename TInputImage , typename TCoordinate = float>
itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::MahalanobisDistanceThresholdImageFunction ( )
protected

◆ ~MahalanobisDistanceThresholdImageFunction()

template<typename TInputImage , typename TCoordinate = float>
itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::~MahalanobisDistanceThresholdImageFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage , typename TCoordinate = float>
bool itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::Evaluate ( const PointType &  point) const
overridevirtual

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.

Implements itk::ImageFunction< TInputImage, bool, TCoordinate >.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordinate = float>
bool itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  index) const
overridevirtual

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.

Implements itk::ImageFunction< TInputImage, bool, TCoordinate >.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordinate = float>
bool itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::EvaluateAtIndex ( const IndexType &  index) const
overridevirtual

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.

Implements itk::ImageFunction< TInputImage, bool, TCoordinate >.

◆ EvaluateDistance()

template<typename TInputImage , typename TCoordinate = float>
virtual double itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::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 TCoordinate = float>
virtual double itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::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 TCoordinate = float>
virtual const CovarianceMatrixType& itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::GetCovariance ( ) const
virtual

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

◆ GetMean()

template<typename TInputImage , typename TCoordinate = float>
virtual const MeanVectorType& itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::GetMean ( ) const
virtual

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

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordinate = float>
const char* itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetThreshold()

template<typename TInputImage , typename TCoordinate = float>
virtual const double& itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::GetThreshold ( ) const
virtual

Get the lower threshold value.

◆ New()

template<typename TInputImage , typename TCoordinate = float>
static Pointer itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TCoordinate = float>
void itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::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::Object.

◆ SetCovariance()

template<typename TInputImage , typename TCoordinate = float>
void itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::SetCovariance ( const CovarianceMatrixType &  covariance)

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

◆ SetMean()

template<typename TInputImage , typename TCoordinate = float>
void itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::SetMean ( const MeanVectorType &  mean)

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

◆ SetThreshold()

template<typename TInputImage , typename TCoordinate = float>
virtual void itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::SetThreshold ( double  _arg)
virtual

Get the lower threshold value.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordinate = float>
constexpr unsigned int itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::ImageDimension = Superclass::ImageDimension
staticconstexpr

Dimension underlying input image.

Definition at line 75 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ m_Covariance

template<typename TInputImage , typename TCoordinate = float>
CovarianceMatrixType itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::m_Covariance {}
private

Definition at line 181 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ m_MahalanobisDistanceMembershipFunction

template<typename TInputImage , typename TCoordinate = float>
MahalanobisDistanceFunctionPointer itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::m_MahalanobisDistanceMembershipFunction {}
private

Definition at line 175 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ m_Mean

template<typename TInputImage , typename TCoordinate = float>
MeanVectorType itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::m_Mean {}
private

Definition at line 180 of file itkMahalanobisDistanceThresholdImageFunction.h.

◆ m_Threshold

template<typename TInputImage , typename TCoordinate = float>
double itk::MahalanobisDistanceThresholdImageFunction< TInputImage, TCoordinate >::m_Threshold {}
private

Definition at line 169 of file itkMahalanobisDistanceThresholdImageFunction.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.8.16