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

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

template<class TImageType >

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

Triggers the Computation of the histogram

template<class TImageType >

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

Triggers the Computation of the histogram

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

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 >

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 >

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

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TImageType >

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

standard New() method support

Reimplemented from itk::Object.

template<class TImageType >

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

standard New() method support

Reimplemented from itk::Object.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

template<class TImageType >

void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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 >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

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.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

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 >::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 >::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 >::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 >::SetMarginalScale ( double marginalScale )

Set marginal scale value to be passed to the histogram generator

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

template<class TImageType >

void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetNumberOfBins ( unsigned int numberOfBins )

Set number of histogram bins

template<class TImageType >

void itk::Statistics::ScalarImageToHistogramGenerator< TImageType >::SetNumberOfBins ( unsigned int numberOfBins )

Set number of histogram bins

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

Member Data Documentation

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

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


Public Types
typedef AdaptorType::Pointer	AdaptorPointer
typedef AdaptorType::Pointer	AdaptorPointer
typedef itk::Statistics::ImageToListSampleAdaptor < ImageType >	AdaptorType
typedef itk::Statistics::ScalarImageToListAdaptor < ImageType >	AdaptorType
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< const Self >	ConstPointer
typedef GeneratorType::Pointer	GeneratorPointer
typedef GeneratorType::Pointer	GeneratorPointer
typedef itk::Statistics::SampleToHistogramFilter < AdaptorType, HistogramType >	GeneratorType
typedef itk::Statistics::ListSampleToHistogramGenerator < AdaptorType, RealPixelType, DenseFrequencyContainer >	GeneratorType
typedef HistogramType::ConstPointer	HistogramConstPointer
typedef HistogramType::ConstPointer	HistogramConstPointer
typedef HistogramType::Pointer	HistogramPointer
typedef HistogramType::Pointer	HistogramPointer
typedef itk::Statistics::Histogram < double >	HistogramType
typedef GeneratorType::HistogramType	HistogramType
typedef TImageType	ImageType
typedef TImageType	ImageType
typedef ImageType::PixelType	PixelType
typedef ImageType::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< Self >	Pointer
typedef NumericTraits < PixelType >::RealType	RealPixelType
typedef NumericTraits < PixelType >::RealType	RealPixelType
typedef ScalarImageToHistogramGenerator	Self
typedef ScalarImageToHistogramGenerator	Self
typedef Object	Superclass
typedef Object	Superclass
Public Member Functions
void	Compute (void)
void	Compute (void)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual const char *	GetNameOfClass () const
const HistogramType *	GetOutput () const
const HistogramType *	GetOutput () const
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetHistogramMax (RealPixelType maximumValue)
void	SetHistogramMax (RealPixelType maximumValue)
void	SetHistogramMin (RealPixelType minimumValue)
void	SetHistogramMin (RealPixelType minimumValue)
void	SetInput (const ImageType *)
void	SetInput (const ImageType *)
void	SetMarginalScale (double marginalScale)
void	SetMarginalScale (double marginalScale)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetNumberOfBins (unsigned int numberOfBins)
void	SetNumberOfBins (unsigned int numberOfBins)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Types

typedef int	InternalReferenceCountType
Protected Member Functions
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
	ScalarImageToHistogramGenerator ()
	ScalarImageToHistogramGenerator ()
virtual	~ScalarImageToHistogramGenerator ()
virtual	~ScalarImageToHistogramGenerator ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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