#include <itkKappaSigmaThresholdImageCalculator.h>

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://doi.org/10.54294/39qekn

Definition at line 52 of file itkKappaSigmaThresholdImageCalculator.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageType = TInputImage

using	InputPixelType = typename InputImageType::PixelType

using	MaskImageConstPointer = typename MaskImageType::ConstPointer

using	MaskImagePointer = typename MaskImageType::Pointer

using	MaskImageType = TMaskImage

using	MaskPixelType = typename MaskImageType::PixelType

using	Pointer = SmartPointer< Self >

using	Self = KappaSigmaThresholdImageCalculator

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

const char *	GetNameOfClass () const override

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 *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 = TInputImage::ImageDimension

Protected Member Functions
	KappaSigmaThresholdImageCalculator ()

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

	~KappaSigmaThresholdImageCalculator () 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 Attributes
InputImageConstPointer	m_Image {}

MaskImageConstPointer	m_Mask {}

MaskPixelType	m_MaskValue {}

unsigned int	m_NumberOfIterations { 2 }

InputPixelType	m_Output {}

double	m_SigmaFactor { 2 }

bool	m_Valid { false }

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}