calculates sample mean More...

#include <itkMeanCalculator.h>

Inheritance diagram for itk::Statistics::MeanCalculator< TSample >:

Collaboration diagram for itk::Statistics::MeanCalculator< TSample >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef TSample	InputSampleType
typedef Superclass::MeasurementVectorSizeType	MeasurementVectorSizeType
typedef Superclass::MeasurementVectorType	MeasurementVectorType
typedef Array< double >	OutputType
typedef SmartPointer< Self >	Pointer
typedef MeanCalculator	Self
typedef SampleAlgorithmBase < TSample >	Superclass
Public Member Functions
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 TSample *	GetInputSample () const
virtual MeasurementVectorSizeType	GetMeasurementVectorSize () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
OutputType *	GetOutput ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
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
virtual void	SetMeasurementVectorSize (MeasurementVectorSizeType _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
void	Update ()


void	SetInputSample (const TSample *sample)


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


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


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


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

virtual const char *	GetNameOfClass () const
static Pointer	New ()

Detailed Description

template<class TSample>
class itk::Statistics::MeanCalculator< TSample >

calculates sample mean

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

The return value that the GetOutput method $= \frac{1}{n}\sum^{n}_{i=1}x_{i}$ where $n$ is the number of measurement vectors in the target

Recent API changes: The static const macro to get the length of a measurement vector, 'MeasurementVectorSize' has been removed to allow the length of a measurement vector to be specified at run time. It is now obtained from the input sample. Please use the function GetMeasurementVectorSize() to obtain the length. The mean output is an Array rather than a Vector.

Definition at line 47 of file itkMeanCalculator.h.

Member Typedef Documentation

template<class TSample >

typedef SmartPointer<const Self> itk::Statistics::MeanCalculator< TSample >::ConstPointer

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Definition at line 55 of file itkMeanCalculator.h.

typedef TSample itk::Statistics::SampleAlgorithmBase< TSample >::InputSampleType [inherited]

Sample typedefs alias

Reimplemented in itk::Statistics::NeighborhoodSampler< TSample >, and itk::Statistics::SampleMeanShiftBlurringFilter< TSample >.

Definition at line 59 of file itkSampleAlgorithmBase.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

template<class TSample >

typedef Superclass::MeasurementVectorSizeType itk::Statistics::MeanCalculator< TSample >::MeasurementVectorSizeType

Length of a measurement vector

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Definition at line 59 of file itkMeanCalculator.h.

template<class TSample >

typedef Superclass::MeasurementVectorType itk::Statistics::MeanCalculator< TSample >::MeasurementVectorType

Measurement vector type

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Definition at line 66 of file itkMeanCalculator.h.

template<class TSample >

typedef Array< double > itk::Statistics::MeanCalculator< TSample >::OutputType

Typedef for the mean output

Definition at line 69 of file itkMeanCalculator.h.

template<class TSample >

typedef SmartPointer<Self> itk::Statistics::MeanCalculator< TSample >::Pointer

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Definition at line 54 of file itkMeanCalculator.h.

template<class TSample >

typedef MeanCalculator itk::Statistics::MeanCalculator< TSample >::Self

Standard class typedefs.

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Definition at line 52 of file itkMeanCalculator.h.

template<class TSample >

typedef SampleAlgorithmBase< TSample > itk::Statistics::MeanCalculator< TSample >::Superclass

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

Definition at line 53 of file itkMeanCalculator.h.

Constructor & Destructor Documentation

template<class TSample >

itk::Statistics::MeanCalculator< TSample >::MeanCalculator ( ) [protected]

template<class TSample >

virtual itk::Statistics::MeanCalculator< TSample >::~MeanCalculator ( ) [inline, protected, virtual]

Definition at line 76 of file itkMeanCalculator.h.

Member Function Documentation

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

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[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.

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.

template<class TSample >

void itk::Statistics::MeanCalculator< TSample >::GenerateData ( ) [protected, virtual]

Calculates the mean and save it

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

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 TSample * itk::Statistics::SampleAlgorithmBase< TSample >::GetInputSample ( ) const [inline, inherited]

Definition at line 82 of file itkSampleAlgorithmBase.h.

virtual MeasurementVectorSizeType itk::Statistics::SampleAlgorithmBase< TSample >::GetMeasurementVectorSize ( ) const [virtual, inherited]

Get Macro to get the length of a measurement vector. This is equal to the length of each measurement vector contained in the samples that are plugged in as input to this class. GetMeasurementVectorSize() will return zero until the SetInputSample() method has been called

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 TSample >

virtual const char* itk::Statistics::MeanCalculator< TSample >::GetNameOfClass ( ) const [virtual]

Standard Macros

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

template<class TSample >

OutputType* itk::Statistics::MeanCalculator< TSample >::GetOutput ( )

Returns the mean vector

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 & ) [inherited]

Call Execute on all the Commands observing this event id.

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.

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, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TSample >

static Pointer itk::Statistics::MeanCalculator< TSample >::New ( ) [static]

Standard Macros

Reimplemented from itk::Statistics::SampleAlgorithmBase< TSample >.

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 TSample >

void itk::Statistics::MeanCalculator< TSample >::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::Statistics::SampleAlgorithmBase< TSample >.

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

void itk::Statistics::SampleAlgorithmBase< TSample >::SetInputSample ( const TSample * sample ) [inline, inherited]

Stores the sample pointer

Definition at line 63 of file itkSampleAlgorithmBase.h.

virtual void itk::Statistics::SampleAlgorithmBase< TSample >::SetMeasurementVectorSize ( MeasurementVectorSizeType _arg ) [virtual, inherited]

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

Returns:: Set the MetaDataDictionary

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.

void itk::Statistics::SampleAlgorithmBase< TSample >::Update ( void ) [inline, inherited]

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

Definition at line 88 of file itkSampleAlgorithmBase.h.

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 file:

itkMeanCalculator.h

itk::Statistics::MeanCalculator< TSample > Class Template Reference

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

template<class TSample> class itk::Statistics::MeanCalculator< TSample >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TSample>
class itk::Statistics::MeanCalculator< TSample >