ITK  4.3.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::HistogramAlgorithmBase< TInputHistogram > Class Template Referenceabstract

#include <itkHistogramAlgorithmBase.h>

+ Inheritance diagram for itk::HistogramAlgorithmBase< TInputHistogram >:
+ Collaboration diagram for itk::HistogramAlgorithmBase< TInputHistogram >:

Detailed Description

template<class TInputHistogram>
class itk::HistogramAlgorithmBase< TInputHistogram >

base class for algorithms operating on histograms

You plug in the target sample data using SetInputHistogram method. Then call the GenerateData method to run the alogithm.

Definition at line 37 of file itkHistogramAlgorithmBase.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef TInputHistogram InputHistogramType
 
typedef SmartPointer< SelfPointer
 
typedef HistogramAlgorithmBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

const TInputHistogram * GetInputHistogram () const
 
virtual const char * GetNameOfClass () const
 
void Update ()
 
void SetInputHistogram (const TInputHistogram *histogram)
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
 

Protected Member Functions

virtual void GenerateData ()=0
 
 HistogramAlgorithmBase ()
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual ~HistogramAlgorithmBase ()
 
- 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 Attributes

TInputHistogram::ConstPointer m_InputHistogram
 

Additional Inherited Members

- 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)
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Member Typedef Documentation

template<class TInputHistogram >
typedef SmartPointer< const Self > itk::HistogramAlgorithmBase< TInputHistogram >::ConstPointer

Definition at line 44 of file itkHistogramAlgorithmBase.h.

template<class TInputHistogram >
typedef TInputHistogram itk::HistogramAlgorithmBase< TInputHistogram >::InputHistogramType

Histogram typedefs alias

Definition at line 47 of file itkHistogramAlgorithmBase.h.

template<class TInputHistogram >
typedef SmartPointer< Self > itk::HistogramAlgorithmBase< TInputHistogram >::Pointer

Definition at line 43 of file itkHistogramAlgorithmBase.h.

template<class TInputHistogram >
typedef HistogramAlgorithmBase itk::HistogramAlgorithmBase< TInputHistogram >::Self

Standard class typedefs.

Definition at line 41 of file itkHistogramAlgorithmBase.h.

template<class TInputHistogram >
typedef Object itk::HistogramAlgorithmBase< TInputHistogram >::Superclass

Definition at line 42 of file itkHistogramAlgorithmBase.h.

Constructor & Destructor Documentation

template<class TInputHistogram >
itk::HistogramAlgorithmBase< TInputHistogram >::HistogramAlgorithmBase ( )
protected
template<class TInputHistogram >
virtual itk::HistogramAlgorithmBase< TInputHistogram >::~HistogramAlgorithmBase ( )
inlineprotectedvirtual

Definition at line 75 of file itkHistogramAlgorithmBase.h.

Member Function Documentation

template<class TInputHistogram >
virtual void itk::HistogramAlgorithmBase< TInputHistogram >::GenerateData ( )
protectedpure virtual
template<class TInputHistogram >
const TInputHistogram* itk::HistogramAlgorithmBase< TInputHistogram >::GetInputHistogram ( ) const
inline

Returns the histogram const pointer

Definition at line 64 of file itkHistogramAlgorithmBase.h.

template<class TInputHistogram >
virtual const char* itk::HistogramAlgorithmBase< TInputHistogram >::GetNameOfClass ( ) const
virtual

Standard Macros

Reimplemented from itk::Object.

Reimplemented in itk::OtsuMultipleThresholdsCalculator< TInputHistogram >.

template<class TInputHistogram >
void itk::HistogramAlgorithmBase< TInputHistogram >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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::Object.

Reimplemented in itk::OtsuMultipleThresholdsCalculator< TInputHistogram >.

template<class TInputHistogram >
void itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram ( const TInputHistogram *  histogram)
inline

Stores the histogram pointer

Definition at line 53 of file itkHistogramAlgorithmBase.h.

template<class TInputHistogram >
void itk::HistogramAlgorithmBase< TInputHistogram >::Update ( void  )
inline

dummy function that calls the GenerateData() function to generate output. It exists for future compatibility with ProcessObject without streaming

Definition at line 70 of file itkHistogramAlgorithmBase.h.

Member Data Documentation

template<class TInputHistogram >
TInputHistogram::ConstPointer itk::HistogramAlgorithmBase< TInputHistogram >::m_InputHistogram
private

Target histogram data pointer

Definition at line 82 of file itkHistogramAlgorithmBase.h.


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