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

#include <itkHistogramThresholdCalculator.h>

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

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

Detailed Description

template<typename THistogram, typename TOutput>
class itk::HistogramThresholdCalculator< THistogram, TOutput >

Base class to compute a threshold value based on the histogram of an image.

Author

Richard Beare. Department of Medicine, Monash University, Melbourne, Australia.

Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France.

This implementation was taken from the Insight Journal paper: http://hdl.handle.net/10380/3279 or http://www.insight-journal.org/browse/publication/811

Definition at line 46 of file itkHistogramThresholdCalculator.h.

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

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
const HistogramType *	GetInput () const
virtual const char *	GetNameOfClass () const
DecoratedOutputType *	GetOutput ()
const OutputType &	GetThreshold ()
virtual 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 ()
MultiThreader *	GetMultiThreader () const
DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
NameArray	GetOutputNames () const
DataObjectPointerArray	GetOutputs ()
virtual const float &	GetProgress () const
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	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float progress)
void	SetProgress (float progress)
virtual void	SetReleaseDataFlag (bool flag)
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	SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdType &	GetNumberOfThreads () const
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 ()
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
virtual void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int) override
virtual void	UnRegister () const noexceptoverride
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () 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 ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Member Functions
	HistogramThresholdCalculator ()
virtual	~HistogramThresholdCalculator ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
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
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
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 ()
virtual 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 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 (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName (void) const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName (void) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
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
	HistogramThresholdCalculator (const Self &) ITK_DELETE_FUNCTION
void	operator= (const Self &) ITK_DELETE_FUNCTION

Additional Inherited Members
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename THistogram , typename TOutput >

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

Definition at line 53 of file itkHistogramThresholdCalculator.h.

template<typename THistogram , typename TOutput >

typedef SimpleDataObjectDecorator<OutputType> itk::HistogramThresholdCalculator< THistogram, TOutput >::DecoratedOutputType

Definition at line 66 of file itkHistogramThresholdCalculator.h.

template<typename THistogram , typename TOutput >

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

Type definition for the input histogram.

Definition at line 59 of file itkHistogramThresholdCalculator.h.

template<typename THistogram , typename TOutput >

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

output object type

Definition at line 65 of file itkHistogramThresholdCalculator.h.

template<typename THistogram , typename TOutput >

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

Definition at line 52 of file itkHistogramThresholdCalculator.h.

template<typename THistogram , typename TOutput >

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

Standard class typedefs.

Definition at line 50 of file itkHistogramThresholdCalculator.h.

template<typename THistogram , typename TOutput >

typedef ProcessObject itk::HistogramThresholdCalculator< THistogram, TOutput >::Superclass

Definition at line 51 of file itkHistogramThresholdCalculator.h.

Constructor & Destructor Documentation

template<typename THistogram , typename TOutput >

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

inlineprotected

Definition at line 108 of file itkHistogramThresholdCalculator.h.

References itk::HistogramThresholdCalculator< THistogram, TOutput >::MakeOutput(), itk::ProcessObject::SetNthOutput(), and itk::ProcessObject::SetNumberOfRequiredOutputs().

template<typename THistogram , typename TOutput >

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

inlineprotectedvirtual

Definition at line 113 of file itkHistogramThresholdCalculator.h.

template<typename THistogram , typename TOutput >

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

private

Member Function Documentation

template<typename THistogram , typename TOutput >

virtual::itk::LightObject::Pointer itk::HistogramThresholdCalculator< 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::Object.

Reimplemented in itk::IntermodesThresholdCalculator< THistogram, TOutput >, itk::LiThresholdCalculator< THistogram, TOutput >, itk::YenThresholdCalculator< THistogram, TOutput >, itk::IsoDataThresholdCalculator< THistogram, TOutput >, itk::HuangThresholdCalculator< THistogram, TOutput >, itk::MaximumEntropyThresholdCalculator< THistogram, TOutput >, itk::TriangleThresholdCalculator< THistogram, TOutput >, itk::KittlerIllingworthThresholdCalculator< THistogram, TOutput >, itk::RenyiEntropyThresholdCalculator< THistogram, TOutput >, itk::MomentsThresholdCalculator< THistogram, TOutput >, itk::ShanbhagThresholdCalculator< THistogram, TOutput >, and itk::OtsuThresholdCalculator< THistogram, TOutput >.

template<typename THistogram , typename TOutput >

const HistogramType* itk::HistogramThresholdCalculator< THistogram, TOutput >::GetInput ( ) const

inline

Definition at line 74 of file itkHistogramThresholdCalculator.h.

References itk::ProcessObject::GetInput(), and itk::ProcessObject::GetNumberOfInputs().

template<typename THistogram , typename TOutput >

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

Reimplemented in itk::IntermodesThresholdCalculator< THistogram, TOutput >, itk::LiThresholdCalculator< THistogram, TOutput >, itk::YenThresholdCalculator< THistogram, TOutput >, itk::IsoDataThresholdCalculator< THistogram, TOutput >, itk::HuangThresholdCalculator< THistogram, TOutput >, itk::MaximumEntropyThresholdCalculator< THistogram, TOutput >, itk::TriangleThresholdCalculator< THistogram, TOutput >, itk::KittlerIllingworthThresholdCalculator< THistogram, TOutput >, itk::RenyiEntropyThresholdCalculator< THistogram, TOutput >, itk::MomentsThresholdCalculator< THistogram, TOutput >, itk::ShanbhagThresholdCalculator< THistogram, TOutput >, and itk::OtsuThresholdCalculator< THistogram, TOutput >.

template<typename THistogram , typename TOutput >

DecoratedOutputType* itk::HistogramThresholdCalculator< THistogram, TOutput >::GetOutput ( )

inline

Definition at line 83 of file itkHistogramThresholdCalculator.h.

References itk::ProcessObject::GetNumberOfOutputs(), and itk::ProcessObject::GetOutput().

template<typename THistogram , typename TOutput >

const OutputType& itk::HistogramThresholdCalculator< THistogram, TOutput >::GetThreshold ( )

inline

Definition at line 98 of file itkHistogramThresholdCalculator.h.

References itk::ProcessObject::GetNumberOfOutputs(), and itk::ProcessObject::GetOutput().

template<typename THistogram , typename TOutput >

virtual DataObject::Pointer itk::HistogramThresholdCalculator< THistogram, TOutput >::MakeOutput ( DataObjectPointerArraySizeType  idx )

inlineoverridevirtual

Make a DataObject of the correct type to used as the specified output.

Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

Definition at line 93 of file itkHistogramThresholdCalculator.h.

References itk::SmartPointer< TObjectType >::GetPointer(), and itk::SimpleDataObjectDecorator< T >::New().

Referenced by itk::HistogramThresholdCalculator< THistogram, TOutput >::HistogramThresholdCalculator().

template<typename THistogram , typename TOutput >

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

static

Method for creation through the object factory.

template<typename THistogram , typename TOutput >

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

private

template<typename THistogram , typename TOutput >

void itk::HistogramThresholdCalculator< THistogram, TOutput >::SetInput ( const HistogramType *  input )

inline

Definition at line 68 of file itkHistogramThresholdCalculator.h.

References itk::ProcessObject::SetNthInput().

---

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

• itkHistogramThresholdCalculator.h