itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension > Class Template Reference
[Operators]

#include <itkSpatialObjectToImageStatisticsCalculator.h>

Inheritance diagram for itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >:

[legend]Collaboration diagram for itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >:

[legend]List of all members.

---

Detailed Description

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1>
class itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >

This calculator computes the mean and the covariance matrice of a certain region of an image specified by a spatial object.

Definition at line 34 of file itkSpatialObjectToImageStatisticsCalculator.h.

Public Types
typedef NumericTraits< PixelType >::AccumulateType	AccumulateType
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage::ConstPointer	ImageConstPointer
typedef TInputImage::Pointer	ImagePointer
typedef TInputImage	ImageType
typedef TInputImage::IndexType	IndexType
typedef itk::FloodFilledSpatialFunctionConditionalConstIterator< ImageType, SpatialObjectType >	IteratorType
typedef Matrix< double, TSampleDimension, TSampleDimension >	MatrixType
typedef TInputImage::PixelType	PixelType
typedef SmartPointer< Self >	Pointer
typedef SpatialObjectToImageStatisticsCalculator	Self
typedef SpatialObjectType::ConstPointer	SpatialObjectConstPointer
typedef SpatialObjectType::Pointer	SpatialObjectPointer
typedef TInputSpatialObject	SpatialObjectType
typedef Object	Superclass
typedef Vector< double, TSampleDimension >	VectorType
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
const MatrixType &	GetCovarianceMatrix () const
bool	GetDebug () const
const VectorType &	GetMean () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual unsigned long	GetNumberOfPixels () const
virtual int	GetReferenceCount () const
virtual unsigned int	GetSampleDirection ()
AccumulateType	GetSum () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (ObjectDimension, unsigned int, TInputSpatialObject::ObjectDimension)
	itkStaticConstMacro (SampleDimension, unsigned int, TSampleDimension)
	itkStaticConstMacro (ImageDimension, unsigned int, ImageType::ImageDimension)
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	SetImage (const ImageType *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
Set Get the direction of the sample *virtual void	SetSampleDirection (unsigned int _arg)
virtual void	SetSpatialObject (SpatialObjectType *_arg)
virtual void	UnRegister () const
void	Update (void)
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
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 unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Protected Member Functions
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	SpatialObjectToImageStatisticsCalculator ()
virtual	~SpatialObjectToImageStatisticsCalculator ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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 PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef NumericTraits< PixelType >::AccumulateType itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::AccumulateType

Definition at line 56 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef SmartPointer<const Self> itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::ConstPointer

Reimplemented from itk::Object. Definition at line 42 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef TInputImage::ConstPointer itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::ImageConstPointer

Definition at line 53 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef TInputImage::Pointer itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::ImagePointer

Definition at line 52 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef TInputImage itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::ImageType

Type definitions for the input image. Definition at line 48 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef TInputImage::IndexType itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::IndexType

Definition at line 55 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef itk::FloodFilledSpatialFunctionConditionalConstIterator<ImageType, SpatialObjectType> itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::IteratorType

Type definition of the flood fill iterator Definition at line 75 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef Matrix< double, TSampleDimension, TSampleDimension > itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::MatrixType

Definition at line 79 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef TInputImage::PixelType itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::PixelType

Definition at line 54 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef SmartPointer<Self> itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::Pointer

Reimplemented from itk::Object. Definition at line 41 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef SpatialObjectToImageStatisticsCalculator itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 39 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef SpatialObjectType::ConstPointer itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SpatialObjectConstPointer

Definition at line 71 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef SpatialObjectType::Pointer itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SpatialObjectPointer

Definition at line 70 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef TInputSpatialObject itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SpatialObjectType

Type definitions for the input spatial object. Definition at line 69 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef Object itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::Superclass

Reimplemented from itk::Object. Definition at line 40 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> typedef Vector< double, TSampleDimension> itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::VectorType

Vector and Matrix Type Definition at line 78 of file itkSpatialObjectToImageStatisticsCalculator.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SpatialObjectToImageStatisticsCalculator (   )  [protected]

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> virtual itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::~SpatialObjectToImageStatisticsCalculator (   )  [inline, protected, virtual]

Definition at line 109 of file itkSpatialObjectToImageStatisticsCalculator.h.

---

Member Function Documentation

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.

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.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> const MatrixType& itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::GetCovarianceMatrix (   )  const [inline]

Get the covariance matrix Definition at line 96 of file itkSpatialObjectToImageStatisticsCalculator.h.

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

Get the value of the debug flag.

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

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> const VectorType& itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::GetMean (   )  const [inline]

Get the mean Definition at line 93 of file itkSpatialObjectToImageStatisticsCalculator.h.

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. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> virtual const char* itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> virtual unsigned long itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::GetNumberOfPixels (   )  const [virtual]

Get the number of pixels inside the object

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

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> virtual unsigned int itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::GetSampleDirection (   )  [virtual]

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> AccumulateType itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::GetSum (   )  const [inline]

Get the sum of pixels Definition at line 99 of file itkSpatialObjectToImageStatisticsCalculator.h.

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

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

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

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.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::itkStaticConstMacro (  ObjectDimension  , unsigned  int, TInputSpatialObject::ObjectDimension  )

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::itkStaticConstMacro (  SampleDimension  , unsigned  int, TSampleDimension  )

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::itkStaticConstMacro (  ImageDimension  , unsigned  int, ImageType::ImageDimension  )

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::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> static Pointer itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

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

Cause the object to print itself out.

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

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> void itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::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]

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.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

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

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> virtual void itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SetImage (  const ImageType *  _arg  )  [virtual]

Set the input image.

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.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> Set Get the direction of the sample* virtual void itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SetSampleDirection (  unsigned int  _arg  )  [virtual]

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> virtual void itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SetSpatialObject (  SpatialObjectType *  _arg  )  [virtual]

Set the input spatial object.

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

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

template<class TInputImage, class TInputSpatialObject, unsigned int TSampleDimension = 1> void itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::Update (  void   )

Compute of the input image.

---

Member Data Documentation

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 unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

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

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

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

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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 PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

---

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

• itkSpatialObjectToImageStatisticsCalculator.h

---