#include <itkKappaSigmaThresholdImageCalculator.h>

Inheritance diagram for itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >:

Collaboration diagram for itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >:

Detailed Description

template<typename TInputImage, typename TMaskImage>
class itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >

Computes a Kappa-Sigma-Clipping threshold for an image.

When an image is mostly composed of background pixels, most of the automatic thresholding methods fail to produce a relevant threshold. This is mainly because one mode (e.g the background) is over-represented in the histogram. The basic idea of Kappa-Sigma-Clipping is to find the properties of the over-represented mode and re-compute a threshold with only the pre-thresholded pixels (thus rejecting significantly different pixels iteratively). This algorithm does not converge to a specific value, hence a number of iterations must be provided.

On each iteration, the new threshold [t_(i+1)] is computed as follows (using only pixels thresholded with [t_i]):

t_(i+1) = Mean_(i+1) + Kappa * Sigma_(i+1)

Author: Gaetan Lehmann

Note: This class was taken from the Insight Journal paper: https://hdl.handle.net/1926/367

Definition at line 51 of file itkKappaSigmaThresholdImageCalculator.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::Pointer	InputImagePointer

typedef TInputImage	InputImageType

typedef InputImageType::PixelType	InputPixelType

typedef MaskImageType::ConstPointer	MaskImageConstPointer

typedef MaskImageType::Pointer	MaskImagePointer

typedef TMaskImage	MaskImageType

typedef MaskImageType::PixelType	MaskPixelType

typedef SmartPointer< Self >	Pointer

typedef KappaSigmaThresholdImageCalculator	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
void	Compute ()

virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

const InputPixelType &	GetOutput () const

virtual void	SetImage (const InputImageType *_arg)

virtual void	SetMask (const MaskImageType *_arg)


virtual void	SetMaskValue (MaskPixelType _arg)

virtual MaskPixelType	GetMaskValue () const


virtual void	SetSigmaFactor (double _arg)

virtual double	GetSigmaFactor () const


virtual void	SetNumberOfIterations (unsigned int _arg)

virtual unsigned int	GetNumberOfIterations () const

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

unsigned long	AddObserver (const EventObject &event, Command *) 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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = TInputImage::ImageDimension

Protected Member Functions
	KappaSigmaThresholdImageCalculator ()

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

virtual	~KappaSigmaThresholdImageCalculator () override

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~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
InputImageConstPointer	m_Image

MaskImageConstPointer	m_Mask

MaskPixelType	m_MaskValue

unsigned int	m_NumberOfIterations

InputPixelType	m_Output

double	m_SigmaFactor

bool	m_Valid

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount