ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | 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 >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputHistogramType = TInputHistogram
 
using Pointer = SmartPointer< Self >
 
using Self = HistogramAlgorithmBase
 
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 const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () 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
 
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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
TInputHistogram::ConstPointer m_InputHistogram
 
void SetInputHistogram (const TInputHistogram *histogram)
 
const TInputHistogram * GetInputHistogram () const
 
 HistogramAlgorithmBase ()
 
 ~HistogramAlgorithmBase () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void Compute ()=0
 

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)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename 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 Compute() method to run the algorithm.

Definition at line 37 of file itkHistogramAlgorithmBase.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputHistogram>
using itk::HistogramAlgorithmBase< TInputHistogram >::ConstPointer = SmartPointer<const Self>

Definition at line 44 of file itkHistogramAlgorithmBase.h.

◆ InputHistogramType

template<typename TInputHistogram>
using itk::HistogramAlgorithmBase< TInputHistogram >::InputHistogramType = TInputHistogram

Histogram type alias alias

Definition at line 50 of file itkHistogramAlgorithmBase.h.

◆ Pointer

template<typename TInputHistogram>
using itk::HistogramAlgorithmBase< TInputHistogram >::Pointer = SmartPointer<Self>

Definition at line 43 of file itkHistogramAlgorithmBase.h.

◆ Self

template<typename TInputHistogram>
using itk::HistogramAlgorithmBase< TInputHistogram >::Self = HistogramAlgorithmBase

Standard class type aliases.

Definition at line 41 of file itkHistogramAlgorithmBase.h.

◆ Superclass

template<typename TInputHistogram>
using itk::HistogramAlgorithmBase< TInputHistogram >::Superclass = Object

Definition at line 42 of file itkHistogramAlgorithmBase.h.

Constructor & Destructor Documentation

◆ HistogramAlgorithmBase()

template<typename TInputHistogram>
itk::HistogramAlgorithmBase< TInputHistogram >::HistogramAlgorithmBase ( )
protected
Deprecated:
Update() is deprecated because classes that do not derive from ProcessObject are not part of the pipeline and should therefore not have an Update() method. It is included for backwards compatibility.

◆ ~HistogramAlgorithmBase()

template<typename TInputHistogram>
itk::HistogramAlgorithmBase< TInputHistogram >::~HistogramAlgorithmBase ( )
overrideprotecteddefault

Target histogram data pointer

Member Function Documentation

◆ Compute()

template<typename TInputHistogram>
virtual void itk::HistogramAlgorithmBase< TInputHistogram >::Compute ( )
protectedpure virtual

◆ GetInputHistogram()

template<typename TInputHistogram>
const TInputHistogram* itk::HistogramAlgorithmBase< TInputHistogram >::GetInputHistogram ( ) const
inline

Returns the histogram const pointer

Definition at line 66 of file itkHistogramAlgorithmBase.h.

◆ GetNameOfClass()

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

◆ PrintSelf()

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

◆ SetInputHistogram()

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

Stores the histogram pointer

Definition at line 54 of file itkHistogramAlgorithmBase.h.

Member Data Documentation

◆ m_InputHistogram

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

Target histogram data pointer

Definition at line 95 of file itkHistogramAlgorithmBase.h.


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