itk::OtsuThresholdCalculator< THistogram, TOutput > Class Template Reference

#include <itkOtsuThresholdCalculator.h>

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

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

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef THistogram	HistogramType
typedef TOutput	OutputType
typedef SmartPointer< Self >	Pointer
typedef OtsuThresholdCalculator	Self
typedef Object	Superclass
Public Types inherited from itk::HistogramThresholdCalculator< THistogram, TOutput >
typedef SimpleDataObjectDecorator < OutputType >	DecoratedOutputType
Public Types inherited from itk::ProcessObject
typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
void	Compute ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
Public Member Functions inherited from itk::HistogramThresholdCalculator< THistogram, TOutput >
const HistogramType *	GetInput () const
DecoratedOutputType *	GetOutput ()
const OutputType &	GetThreshold ()
virtual DataObject::Pointer	MakeOutput (DataObjectPointerArraySizeType)
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 ()
NameArray	GetInputNames () const
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
virtual const float &	GetProgress ()
NameArray	GetRequiredInputNames () const
bool	HasInput (const DataObjectIdentifierType &key) const
bool	HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)
virtual void	PrepareOutputs ()
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	SetProgress (float _arg)
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
DataObjectPointerArray	GetInputs ()
DataObjectPointerArray	GetOutputs ()
DataObjectPointerArray	GetIndexedInputs ()
DataObjectPointerArray	GetIndexedOutputs ()
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
virtual void	SetReleaseDataFlag (bool flag)
virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads ()
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 (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	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
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () 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 ()

Protected Member Functions
void	GenerateData (void)
	OtsuThresholdCalculator ()
virtual	~OtsuThresholdCalculator ()
Protected Member Functions inherited from itk::HistogramThresholdCalculator< THistogram, TOutput >
	HistogramThresholdCalculator ()
virtual	~HistogramThresholdCalculator ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
void	PrintSelf (std::ostream &os, Indent indent) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
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 num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyInputInformation ()
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	PushBackInput (const DataObject *input)
virtual void	PopBackInput ()
virtual void	PushFrontInput (const DataObject *input)
virtual void	PopFrontInput ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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 Member Functions
void	operator= (const Self &)
	OtsuThresholdCalculator (const Self &)

---

Detailed Description

template<class THistogram, class 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 43 of file itkOtsuThresholdCalculator.h.

---

Member Typedef Documentation

template<class THistogram , class TOutput = double>

typedef SmartPointer<const Self> itk::OtsuThresholdCalculator< THistogram, TOutput >::ConstPointer

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

Definition at line 50 of file itkOtsuThresholdCalculator.h.

template<class THistogram , class TOutput = double>

typedef THistogram itk::OtsuThresholdCalculator< THistogram, TOutput >::HistogramType

Type definition for the input image.

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

Definition at line 56 of file itkOtsuThresholdCalculator.h.

template<class THistogram , class TOutput = double>

typedef TOutput itk::OtsuThresholdCalculator< THistogram, TOutput >::OutputType

output object type

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

Definition at line 60 of file itkOtsuThresholdCalculator.h.

template<class THistogram , class TOutput = double>

typedef SmartPointer<Self> itk::OtsuThresholdCalculator< THistogram, TOutput >::Pointer

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

Definition at line 49 of file itkOtsuThresholdCalculator.h.

template<class THistogram , class TOutput = double>

typedef OtsuThresholdCalculator itk::OtsuThresholdCalculator< THistogram, TOutput >::Self

Standard class typedefs.

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

Definition at line 47 of file itkOtsuThresholdCalculator.h.

template<class THistogram , class TOutput = double>

typedef Object itk::OtsuThresholdCalculator< THistogram, TOutput >::Superclass

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

Definition at line 48 of file itkOtsuThresholdCalculator.h.

---

Constructor & Destructor Documentation

template<class THistogram , class TOutput = double>

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

inlineprotected

Definition at line 69 of file itkOtsuThresholdCalculator.h.

template<class THistogram , class TOutput = double>

virtual itk::OtsuThresholdCalculator< THistogram, TOutput >::~OtsuThresholdCalculator ( )

inlineprotectedvirtual

Definition at line 70 of file itkOtsuThresholdCalculator.h.

template<class THistogram , class TOutput = double>

itk::OtsuThresholdCalculator< THistogram, TOutput >::OtsuThresholdCalculator ( const Self &  )

private

---

Member Function Documentation

template<class THistogram , class TOutput = double>

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

inline

for backward compatibility. Update() should be preferred.

Definition at line 63 of file itkOtsuThresholdCalculator.h.

template<class THistogram , class TOutput = double>

virtual::itk::LightObject::Pointer itk::OtsuThresholdCalculator< THistogram, TOutput >::CreateAnother ( void  ) 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 >.

template<class THistogram , class TOutput = double>

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

protectedvirtual

This method causes the filter to generate its output.

Reimplemented from itk::ProcessObject.

template<class THistogram , class 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 >.

template<class THistogram , class TOutput = double>

static Pointer itk::OtsuThresholdCalculator< THistogram, TOutput >::New ( )

static

Method for creation through the object factory.

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

template<class THistogram , class TOutput = double>

void itk::OtsuThresholdCalculator< THistogram, TOutput >::operator= ( const Self &  )

private

Time when GenerateOutputInformation was last called.

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

---

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

• itkOtsuThresholdCalculator.h