ITK  4.4.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
itk::HistogramThresholdCalculator< THistogram, TOutput > Class Template Reference
Operators | Module ITKThresholding

#include <itkHistogramThresholdCalculator.h>

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

Detailed Description

template<class THistogram, class 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 (void) const
 
const HistogramType * GetInput () const
 
virtual const char * GetNameOfClass () 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 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
 
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

 HistogramThresholdCalculator ()
 
virtual ~HistogramThresholdCalculator ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual const
DataObjectPointerArraySizeType & 		GetNumberOfRequiredOutputs ()
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (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
 
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)
 
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 SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (const DataObjectIdentifierType &key) const
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const
DataObjectPointerArraySizeType & 		GetNumberOfRequiredInputs ()
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
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 &)
 
void operator= (const Self &)
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 

Member Typedef Documentation

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

Definition at line 53 of file itkHistogramThresholdCalculator.h.

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

Definition at line 66 of file itkHistogramThresholdCalculator.h.

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

Type definition for the input histogram.

Definition at line 59 of file itkHistogramThresholdCalculator.h.

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

output object type

Definition at line 65 of file itkHistogramThresholdCalculator.h.

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

Definition at line 52 of file itkHistogramThresholdCalculator.h.

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

Standard class typedefs.

Definition at line 50 of file itkHistogramThresholdCalculator.h.

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

Definition at line 51 of file itkHistogramThresholdCalculator.h.

Constructor & Destructor Documentation

template<class THistogram , class TOutput >
itk::HistogramThresholdCalculator< THistogram, TOutput >::HistogramThresholdCalculator ( )
inlineprotected

Definition at line 108 of file itkHistogramThresholdCalculator.h.

References itk::ProcessObject::SetNthOutput(), and itk::ProcessObject::SetNumberOfRequiredOutputs().

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

Definition at line 113 of file itkHistogramThresholdCalculator.h.

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

Member Function Documentation

template<class THistogram , class TOutput >
virtual::itk::LightObject::Pointer itk::HistogramThresholdCalculator< 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::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<class THistogram , class TOutput >
const HistogramType* itk::HistogramThresholdCalculator< THistogram, TOutput >::GetInput ( void  ) const
inline

Definition at line 74 of file itkHistogramThresholdCalculator.h.

References itk::ProcessObject::GetInput().

template<class THistogram , class 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<class THistogram , class TOutput >
DecoratedOutputType* itk::HistogramThresholdCalculator< THistogram, TOutput >::GetOutput ( void  )
inline

Definition at line 83 of file itkHistogramThresholdCalculator.h.

References itk::ProcessObject::GetOutput().

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

Definition at line 98 of file itkHistogramThresholdCalculator.h.

References itk::ProcessObject::GetOutput().

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

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

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

Method for creation through the object factory.

template<class THistogram , class TOutput >
void itk::HistogramThresholdCalculator< THistogram, TOutput >::operator= ( const Self &  )
private
template<class THistogram , class 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:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Mon May 13 2013 01:32:11 for ITK by   doxygen 1.8.3.1