ITK
6.0.0
Insight Toolkit
|
#include <itkKappaSigmaThresholdImageCalculator.h>
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)
Definition at line 52 of file itkKappaSigmaThresholdImageCalculator.h.
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 |
const char * | GetNameOfClass () const override |
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 Pointer | CreateAnother () const |
virtual void | Delete () |
virtual const char * | GetNameOfClass () const |
virtual int | GetReferenceCount () const |
void | Print (std::ostream &os, Indent indent=0) const |
virtual void | Register () const |
virtual void | SetReferenceCount (int) |
virtual void | UnRegister () const noexcept |
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 |
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 | PrintSelf (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 {} |
using itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::ConstPointer = SmartPointer<const Self> |
Definition at line 61 of file itkKappaSigmaThresholdImageCalculator.h.
using itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::InputImageConstPointer = typename InputImageType::ConstPointer |
Definition at line 78 of file itkKappaSigmaThresholdImageCalculator.h.
using itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::InputImagePointer = typename InputImageType::Pointer |
Standard image type pointer within this class.
Definition at line 77 of file itkKappaSigmaThresholdImageCalculator.h.
using itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::InputImageType = TInputImage |
Standard image type within this class.
Definition at line 73 of file itkKappaSigmaThresholdImageCalculator.h.
using itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::InputPixelType = typename InputImageType::PixelType |
Definition at line 82 of file itkKappaSigmaThresholdImageCalculator.h.
using itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::MaskImageConstPointer = typename MaskImageType::ConstPointer |
Definition at line 80 of file itkKappaSigmaThresholdImageCalculator.h.
using itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::MaskImagePointer = typename MaskImageType::Pointer |
Definition at line 79 of file itkKappaSigmaThresholdImageCalculator.h.
using itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::MaskImageType = TMaskImage |
Definition at line 74 of file itkKappaSigmaThresholdImageCalculator.h.
using itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::MaskPixelType = typename MaskImageType::PixelType |
Definition at line 83 of file itkKappaSigmaThresholdImageCalculator.h.
using itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::Pointer = SmartPointer<Self> |
Definition at line 60 of file itkKappaSigmaThresholdImageCalculator.h.
using itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::Self = KappaSigmaThresholdImageCalculator |
Standard class type aliases.
Definition at line 58 of file itkKappaSigmaThresholdImageCalculator.h.
using itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::Superclass = Object |
Definition at line 59 of file itkKappaSigmaThresholdImageCalculator.h.
|
protected |
|
overrideprotecteddefault |
void itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::Compute | ( | ) |
Run and compute threshold.
|
virtual |
Set the mask value used to select which pixels will be considered in the computation (e.g. only pixels which satisfy (m_Mask->GetPixel(Index()) == m_MaskValue) are considered).
|
overridevirtual |
Reimplemented from itk::Object.
|
virtual |
Set the number of rejection passes.
const InputPixelType & itk::KappaSigmaThresholdImageCalculator< TInputImage, TMaskImage >::GetOutput | ( | ) | const |
Get the computed threshold.
|
virtual |
Set the Sigma multiplier (Kappa) to adjust the pixel rejection rate.
|
static |
Method for creation through the object factory.
|
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.
|
virtual |
Set the input image.
|
virtual |
Set an optional input mask to only consider in the computation pixels with a specific mask value (MaskValue). If no mask is set (default), the entire image will be considered.
|
virtual |
Set the mask value used to select which pixels will be considered in the computation (e.g. only pixels which satisfy (m_Mask->GetPixel(Index()) == m_MaskValue) are considered).
|
virtual |
Set the number of rejection passes.
|
virtual |
Set the Sigma multiplier (Kappa) to adjust the pixel rejection rate.
|
staticconstexpr |
Extract the dimension of the image.
Definition at line 70 of file itkKappaSigmaThresholdImageCalculator.h.
|
private |
Definition at line 131 of file itkKappaSigmaThresholdImageCalculator.h.
|
private |
Definition at line 132 of file itkKappaSigmaThresholdImageCalculator.h.
|
private |
Definition at line 126 of file itkKappaSigmaThresholdImageCalculator.h.
|
private |
Definition at line 128 of file itkKappaSigmaThresholdImageCalculator.h.
|
private |
Definition at line 129 of file itkKappaSigmaThresholdImageCalculator.h.
|
private |
Definition at line 127 of file itkKappaSigmaThresholdImageCalculator.h.
|
private |
Definition at line 125 of file itkKappaSigmaThresholdImageCalculator.h.