ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::OtsuThresholdCalculator< THistogram, TOutput > Class Template Reference
Data Processing Objects » Operators | Group Filtering » Module ITKThresholding

#include <itkOtsuThresholdCalculator.h>

Detailed Description

template<typename THistogram, typename TOutput = double>
class itk::OtsuThresholdCalculator< THistogram, TOutput >

Computes the Otsu's threshold for an image.

This calculator computes the Otsu's threshold which separates an image into foreground and background components. The method relies on a histogram of image intensities. The basic idea is to maximize the between-class variance.

This class is templated over the input histogram type.

Warning
This calculator assumes that the input histogram has only one dimension.

Definition at line 45 of file itkOtsuThresholdCalculator.h.

+ Inheritance diagram for itk::OtsuThresholdCalculator< THistogram, TOutput >:
+ Collaboration diagram for itk::OtsuThresholdCalculator< THistogram, TOutput >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using HistogramType = THistogram
 
using OutputType = TOutput
 
using Pointer = SmartPointer< Self >
 
using Self = OtsuThresholdCalculator
 
using Superclass = HistogramThresholdCalculator< THistogram, TOutput >
 
- Public Types inherited from itk::HistogramThresholdCalculator< THistogram, double >
using ConstPointer = SmartPointer< const Self >
 
using DecoratedOutputType = SimpleDataObjectDecorator< OutputType >
 
using HistogramType = THistogram
 
using OutputType = double
 
using Pointer = SmartPointer< Self >
 
using Self = HistogramThresholdCalculator
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
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
 
virtual void SetReturnBinMidpoint (bool _arg)
 
virtual const bool & GetReturnBinMidpoint () const
 
virtual void ReturnBinMidpointOn ()
 
- Public Member Functions inherited from itk::HistogramThresholdCalculator< THistogram, double >
const HistogramType * GetInput () const
 
const char * GetNameOfClass () const override
 
DecoratedOutputType * GetOutput ()
 
const OutputType & GetThreshold ()
 
DataObject::Pointer MakeOutput (DataObjectPointerArraySizeType) override
 
void SetInput (const HistogramType *input)
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
const char * GetNameOfClass () const override
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () 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::HistogramThresholdCalculator< THistogram, double >
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 ()
 

Protected Member Functions

void GenerateData () override
 
 OtsuThresholdCalculator ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~OtsuThresholdCalculator () override=default
 
- Protected Member Functions inherited from itk::HistogramThresholdCalculator< THistogram, double >
 HistogramThresholdCalculator ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
 ~HistogramThresholdCalculator () override=default
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeType & GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- 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

OtsuMultipleThresholdsCalculator< THistogram >::Pointer m_OtsuMultipleThresholdsCalculator {}
 
bool m_ReturnBinMidpoint { false }
 

Additional Inherited Members

- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Member Typedef Documentation

◆ ConstPointer

template<typename THistogram , typename TOutput = double>
using itk::OtsuThresholdCalculator< THistogram, TOutput >::ConstPointer = SmartPointer<const Self>

Definition at line 54 of file itkOtsuThresholdCalculator.h.

◆ HistogramType

template<typename THistogram , typename TOutput = double>
using itk::OtsuThresholdCalculator< THistogram, TOutput >::HistogramType = THistogram

Type definition for the input image.

Definition at line 63 of file itkOtsuThresholdCalculator.h.

◆ OutputType

template<typename THistogram , typename TOutput = double>
using itk::OtsuThresholdCalculator< THistogram, TOutput >::OutputType = TOutput

Definition at line 64 of file itkOtsuThresholdCalculator.h.

◆ Pointer

template<typename THistogram , typename TOutput = double>
using itk::OtsuThresholdCalculator< THistogram, TOutput >::Pointer = SmartPointer<Self>

Definition at line 53 of file itkOtsuThresholdCalculator.h.

◆ Self

template<typename THistogram , typename TOutput = double>
using itk::OtsuThresholdCalculator< THistogram, TOutput >::Self = OtsuThresholdCalculator

Standard class type aliases.

Definition at line 51 of file itkOtsuThresholdCalculator.h.

◆ Superclass

template<typename THistogram , typename TOutput = double>
using itk::OtsuThresholdCalculator< THistogram, TOutput >::Superclass = HistogramThresholdCalculator<THistogram, TOutput>

Definition at line 52 of file itkOtsuThresholdCalculator.h.

Constructor & Destructor Documentation

◆ OtsuThresholdCalculator()

template<typename THistogram , typename TOutput = double>
itk::OtsuThresholdCalculator< THistogram, TOutput >::OtsuThresholdCalculator ( )
inlineprotected

Definition at line 81 of file itkOtsuThresholdCalculator.h.

References itk::OtsuMultipleThresholdsCalculator< TInputHistogram >::New().

◆ ~OtsuThresholdCalculator()

template<typename THistogram , typename TOutput = double>
itk::OtsuThresholdCalculator< THistogram, TOutput >::~OtsuThresholdCalculator ( )
overrideprotecteddefault

Member Function Documentation

◆ Compute()

template<typename THistogram , typename TOutput = double>
void itk::OtsuThresholdCalculator< THistogram, TOutput >::Compute ( )
inline

for backward compatibility. Update() should be preferred.

Definition at line 75 of file itkOtsuThresholdCalculator.h.

◆ GenerateData()

template<typename THistogram , typename TOutput = double>
void itk::OtsuThresholdCalculator< THistogram, TOutput >::GenerateData ( )
overrideprotectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

◆ GetNameOfClass()

template<typename THistogram , typename TOutput = double>
const char * itk::OtsuThresholdCalculator< THistogram, TOutput >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::ProcessObject.

◆ GetReturnBinMidpoint()

template<typename THistogram , typename TOutput = double>
virtual const bool & itk::OtsuThresholdCalculator< THistogram, TOutput >::GetReturnBinMidpoint ( ) const
virtual

Should the threshold value be mid-point of the bin or the maximum? Default is to return bin maximum.

◆ New()

template<typename THistogram , typename TOutput = double>
static Pointer itk::OtsuThresholdCalculator< THistogram, TOutput >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename THistogram , typename TOutput = double>
void itk::OtsuThresholdCalculator< THistogram, TOutput >::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::ProcessObject.

◆ ReturnBinMidpointOn()

template<typename THistogram , typename TOutput = double>
virtual void itk::OtsuThresholdCalculator< THistogram, TOutput >::ReturnBinMidpointOn ( )
virtual

Should the threshold value be mid-point of the bin or the maximum? Default is to return bin maximum.

◆ SetReturnBinMidpoint()

template<typename THistogram , typename TOutput = double>
virtual void itk::OtsuThresholdCalculator< THistogram, TOutput >::SetReturnBinMidpoint ( bool  _arg)
virtual

Should the threshold value be mid-point of the bin or the maximum? Default is to return bin maximum.

Referenced by itk::OtsuThresholdImageFilter< TInputImage, TOutputImage, TMaskImage >::GenerateData().

Member Data Documentation

◆ m_OtsuMultipleThresholdsCalculator

template<typename THistogram , typename TOutput = double>
OtsuMultipleThresholdsCalculator<THistogram>::Pointer itk::OtsuThresholdCalculator< THistogram, TOutput >::m_OtsuMultipleThresholdsCalculator {}
private

Definition at line 93 of file itkOtsuThresholdCalculator.h.

◆ m_ReturnBinMidpoint

template<typename THistogram , typename TOutput = double>
bool itk::OtsuThresholdCalculator< THistogram, TOutput >::m_ReturnBinMidpoint { false }
private

Definition at line 94 of file itkOtsuThresholdCalculator.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.9.3