#include <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, TOutput >
using	ConstPointer = SmartPointer< const Self >

using	DecoratedOutputType = SimpleDataObjectDecorator< OutputType >

using	HistogramType = THistogram

using	OutputType = TOutput

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
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::HistogramThresholdCalculator< THistogram, TOutput >
const HistogramType *	GetInput () const

DecoratedOutputType *	GetOutput ()

const OutputType &	GetThreshold ()

DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType) override

void	SetInput (const HistogramType *input)

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

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 void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

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	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

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

unsigned long	AddObserver (const EventObject &event, Command *) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) 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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

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::HistogramThresholdCalculator< THistogram, TOutput >
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 ()

OtsuMultipleThresholdsCalculator< THistogram >::Pointer	m_OtsuMultipleThresholdsCalculator

bool	m_ReturnBinMidpoint { false }

virtual void	SetReturnBinMidpoint (bool _arg)

virtual const bool &	GetReturnBinMidpoint () const

virtual void	ReturnBinMidpointOn ()

virtual void	ReturnBinMidpointOff ()

void	Compute ()

	OtsuThresholdCalculator ()

	~OtsuThresholdCalculator () override=default

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

void	GenerateData () override

Additional Inherited Members
Protected Member Functions inherited from itk::HistogramThresholdCalculator< THistogram, TOutput >
	HistogramThresholdCalculator ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

	~HistogramThresholdCalculator () override=default

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

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	PushBackInput (const DataObject *input)

virtual void	PopBackInput ()

virtual void	PushFrontInput (const DataObject *input)

virtual void	PopFrontInput ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

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

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	VerifyInputInformation () ITKv5_CONST

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	GenerateOutputInformation ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::ProcessObject
bool	m_Updating

TimeStamp	m_OutputInformationMTime

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

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.

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

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

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

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

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.

◆ CreateAnother()

template<typename THistogram , typename TOutput = double>

virtual::itk::LightObject::Pointer itk::OtsuThresholdCalculator< THistogram, TOutput >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::HistogramThresholdCalculator< THistogram, TOutput >.

◆ GenerateData()

template<typename THistogram , typename TOutput = double>

void itk::OtsuThresholdCalculator< THistogram, TOutput >::GenerateData ( )

overrideprotectedvirtual

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

Reimplemented from itk::ProcessObject.

◆ GetNameOfClass()

template<typename THistogram , typename TOutput = double>

virtual const char* itk::OtsuThresholdCalculator< THistogram, TOutput >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::HistogramThresholdCalculator< THistogram, TOutput >.

◆ 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.

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

◆ PrintSelf()

template<typename THistogram , typename TOutput = double>

void itk::OtsuThresholdCalculator< THistogram, TOutput >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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

Reimplemented from itk::ProcessObject.

◆ ReturnBinMidpointOff()

template<typename THistogram , typename TOutput = double>

virtual void itk::OtsuThresholdCalculator< THistogram, TOutput >::ReturnBinMidpointOff ( )

virtual

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

◆ 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.

Member Data Documentation

◆ m_OtsuMultipleThresholdsCalculator

template<typename THistogram , typename TOutput = double>

OtsuMultipleThresholdsCalculator<THistogram>::Pointer itk::OtsuThresholdCalculator< THistogram, TOutput >::m_OtsuMultipleThresholdsCalculator

private

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

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

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

Definition at line 97 of file itkOtsuThresholdCalculator.h.

The documentation for this class was generated from the following file:

itkOtsuThresholdCalculator.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ HistogramType

◆ OutputType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ OtsuThresholdCalculator()

◆ ~OtsuThresholdCalculator()

Member Function Documentation

◆ Compute()

◆ CreateAnother()

◆ GenerateData()

◆ GetNameOfClass()

◆ GetReturnBinMidpoint()

◆ New()

◆ PrintSelf()

◆ ReturnBinMidpointOff()

◆ ReturnBinMidpointOn()

◆ SetReturnBinMidpoint()

Member Data Documentation

◆ m_OtsuMultipleThresholdsCalculator

◆ m_ReturnBinMidpoint

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