itk::Statistics::ScalarImageToHistogramGenerator< TImageType > Class Template Reference

#include <itkScalarImageToHistogramGenerator.h>

Inheritance diagram for itk::Statistics::ScalarImageToHistogramGenerator< TImageType >:

Collaboration diagram for itk::Statistics::ScalarImageToHistogramGenerator< TImageType >:

List of all members.

Public Types
typedef AdaptorType::Pointer	AdaptorPointer
typedef itk::Statistics::ImageToListSampleAdaptor < ImageType >	AdaptorType
typedef SmartPointer< const Self >	ConstPointer
typedef GeneratorType::Pointer	GeneratorPointer
typedef itk::Statistics::SampleToHistogramFilter < AdaptorType, HistogramType >	GeneratorType
typedef HistogramType::ConstPointer	HistogramConstPointer
typedef HistogramType::Pointer	HistogramPointer
typedef itk::Statistics::Histogram < double >	HistogramType
typedef TImageType	ImageType
typedef ImageType::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef NumericTraits < PixelType >::RealType	RealPixelType
typedef ScalarImageToHistogramGenerator	Self
typedef Object	Superclass
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
void	Compute (void)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
const HistogramType *	GetOutput () const
void	SetHistogramMax (RealPixelType maximumValue)
void	SetHistogramMin (RealPixelType minimumValue)
void	SetInput (const ImageType *)
void	SetMarginalScale (double marginalScale)
void	SetNumberOfBins (unsigned int numberOfBins)
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 ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
	ScalarImageToHistogramGenerator ()
virtual	~ScalarImageToHistogramGenerator ()
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 &)
	ScalarImageToHistogramGenerator (const Self &)

Private Attributes
GeneratorPointer	m_HistogramGenerator
AdaptorPointer	m_ImageToListSampleAdaptor

---

Detailed Description

template<class TImageType>
class itk::Statistics::ScalarImageToHistogramGenerator< TImageType >

TODO.

Definition at line 36 of file itkScalarImageToHistogramGenerator.h.

---

Member Typedef Documentation

template<class TImageType >

typedef AdaptorType::Pointer itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::AdaptorPointer

Definition at line 53 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef itk::Statistics::ImageToListSampleAdaptor< ImageType > itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::AdaptorType

Definition at line 52 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef SmartPointer< const Self > itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::ConstPointer

Reimplemented from itk::Object.

Definition at line 43 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef GeneratorType::Pointer itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::GeneratorPointer

Definition at line 60 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef itk::Statistics::SampleToHistogramFilter< AdaptorType, HistogramType > itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::GeneratorType

Definition at line 58 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef HistogramType::ConstPointer itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::HistogramConstPointer

Definition at line 63 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef HistogramType::Pointer itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::HistogramPointer

Definition at line 62 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef itk::Statistics::Histogram< double > itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::HistogramType

Definition at line 57 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef TImageType itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::ImageType

Definition at line 49 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef ImageType::PixelType itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::PixelType

Definition at line 54 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef SmartPointer< Self > itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::Pointer

Reimplemented from itk::Object.

Definition at line 42 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef NumericTraits< PixelType >::RealType itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::RealPixelType

Definition at line 55 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef ScalarImageToHistogramGenerator itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::Self

Standard typedefs

Reimplemented from itk::Object.

Definition at line 40 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

typedef Object itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::Superclass

Reimplemented from itk::Object.

Definition at line 41 of file itkScalarImageToHistogramGenerator.h.

---

Constructor & Destructor Documentation

template<class TImageType >

itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::ScalarImageToHistogramGenerator ( )

protected

template<class TImageType >

virtual itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::~ScalarImageToHistogramGenerator ( )

inlineprotectedvirtual

Definition at line 92 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::ScalarImageToHistogramGenerator ( const Self &  )

private

---

Member Function Documentation

template<class TImageType >

void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::Compute

(

void

)

Triggers the Computation of the histogram

template<class TImageType >

virtual::itk::LightObject::Pointer itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::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.

template<class TImageType >

virtual const char* itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<class TImageType >

const HistogramType* itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::GetOutput

(

)

const

Return the histogram. o

Warning:

This output is only valid after the Compute() method has been invoked

See also:

Compute

template<class TImageType >

static Pointer itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::New ( )

static

standard New() method support

Reimplemented from itk::Object.

template<class TImageType >

void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::operator= ( const Self &  )

private

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

template<class TImageType >

void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::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.

template<class TImageType >

void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetHistogramMax

(

RealPixelType

maximumValue

)

Set the maximum value from which the bins will be computed

template<class TImageType >

void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetHistogramMin

(

RealPixelType

minimumValue

)

Set the minimum value from which the bins will be computed

template<class TImageType >

void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetInput

(

const ImageType *

)

Connects the input image for which the histogram is going to be computed

template<class TImageType >

void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetMarginalScale

(

double

marginalScale

)

Set marginal scale value to be passed to the histogram generator

template<class TImageType >

void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetNumberOfBins

(

unsigned int

numberOfBins

)

Set number of histogram bins

---

Member Data Documentation

template<class TImageType >

GeneratorPointer itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::m_HistogramGenerator

private

Definition at line 99 of file itkScalarImageToHistogramGenerator.h.

template<class TImageType >

AdaptorPointer itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::m_ImageToListSampleAdaptor

private

Definition at line 97 of file itkScalarImageToHistogramGenerator.h.

---

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

• itkScalarImageToHistogramGenerator.h