itk::ImageMomentsCalculator< TImage > Class Template Reference
[Operators]

#include <itkImageMomentsCalculator.h>

Inheritance diagram for itk::ImageMomentsCalculator< TImage >:

[legend]Collaboration diagram for itk::ImageMomentsCalculator< TImage >:

[legend]List of all members.

---

Detailed Description

template<class TImage>
class itk::ImageMomentsCalculator< TImage >

Compute moments of an n-dimensional image.

This class provides methods for computing the moments and related properties of a single-echo image. Computing the (non-central) moments of a large image can easily take a million times longer than computing the various other values derived from them, so we compute the moments only on explicit request, and save their values (in an ImageMomentsCalculator object) for later retrieval by the user.

The non-central moments computed by this class are not really intended for general use and are therefore in index coordinates; that is, we pretend that the index that selects a particular pixel also equals its physical coordinates. The center of gravity, central moments, principal moments and principal axes are all more generally useful and are computed in the physical coordinates defined by the Origin and Spacing parameters of the image.

The methods that return values return the values themselves rather than references because the cost is small compared to the cost of computing the moments and doing so simplifies memory management for the caller.

Todo:

It's not yet clear how multi-echo images should be handled here.

Definition at line 59 of file itkImageMomentsCalculator.h.

Public Types
typedef AffineTransformType::Pointer	AffineTransformPointer
typedef AffineTransform< double, itkGetStaticConstMacro(ImageDimension)	AffineTransformType )
typedef SmartPointer< const Self >	ConstPointer
typedef ImageType::ConstPointer	ImageConstPointer
typedef ImageType::Pointer	ImagePointer
typedef TImage	ImageType
typedef Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension)	MatrixType )
typedef SmartPointer< Self >	Pointer
typedef double	ScalarType
typedef ImageMomentsCalculator< TImage >	Self
typedef Object	Superclass
typedef Vector< ScalarType, itkGetStaticConstMacro(ImageDimension)	VectorType )
Public Member Functions
void	Compute (void)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
VectorType	GetCenterOfGravity () const
MatrixType	GetCentralMoments () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
VectorType	GetFirstMoments () const
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
AffineTransformPointer	GetPhysicalAxesToPrincipalAxesTransform (void) const
AffineTransformPointer	GetPrincipalAxesToPhysicalAxesTransform (void) const
VectorType	GetPrincipalMoments () const
virtual int	GetReferenceCount () const
MatrixType	GetSecondMoments () const
ScalarType	GetTotalMass () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
	itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension)
virtual void	Modified () const
that to have determinant and to preserve	parity (Unless you *have foolishly made one or more of the spacing values negative;*in that case, _you_ get to figure out the consequences.) The *moments are computed in physical coordinates.*/MatrixType GetPrincipalAxes() 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
Set the input image *virtual void	SetImage (const ImageType *image)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
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
Return principal	axes
This is a global flag that controls whether any	debug
for	example
that *	is
for the principal axis *corresponding to the smallest principal moment is the vector *	m [0]
Return principal in physical coordinates *This method returns the principal axes of the image whose *moments were last computed by this object The moments are *returned as an orthogonal	matrix
Return principal in physical coordinates *This method returns the principal axes of the image whose *moments were last computed by this object The moments are *returned as an orthogonal each row of which corresponds *to one principal	moment
for the principal axis *corresponding to the smallest principal moment is the vector where m is the value returned by this method The matrix *of principal axes is guaranteed to be a proper	rotation
Protected Member Functions
	ImageMomentsCalculator ()
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
virtual	~ImageMomentsCalculator ()
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 TImage> typedef AffineTransformType::Pointer itk::ImageMomentsCalculator< TImage >::AffineTransformPointer

Definition at line 98 of file itkImageMomentsCalculator.h.

template<class TImage> typedef AffineTransform<double,itkGetStaticConstMacro(ImageDimension) itk::ImageMomentsCalculator< TImage >::AffineTransformType)

Affine transform for mapping to and from principal axis Definition at line 97 of file itkImageMomentsCalculator.h.

template<class TImage> typedef SmartPointer<const Self> itk::ImageMomentsCalculator< TImage >::ConstPointer

Reimplemented from itk::Object. Definition at line 66 of file itkImageMomentsCalculator.h.

template<class TImage> typedef ImageType::ConstPointer itk::ImageMomentsCalculator< TImage >::ImageConstPointer

Definition at line 94 of file itkImageMomentsCalculator.h.

template<class TImage> typedef ImageType::Pointer itk::ImageMomentsCalculator< TImage >::ImagePointer

Standard image type pointer within this class. Definition at line 93 of file itkImageMomentsCalculator.h.

template<class TImage> typedef TImage itk::ImageMomentsCalculator< TImage >::ImageType

Standard image type within this class. Definition at line 90 of file itkImageMomentsCalculator.h.

template<class TImage> typedef Matrix<ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension) itk::ImageMomentsCalculator< TImage >::MatrixType)

Standard matrix type within this class. Definition at line 87 of file itkImageMomentsCalculator.h.

template<class TImage> typedef SmartPointer<Self> itk::ImageMomentsCalculator< TImage >::Pointer

Reimplemented from itk::Object. Definition at line 65 of file itkImageMomentsCalculator.h.

template<class TImage> typedef double itk::ImageMomentsCalculator< TImage >::ScalarType

Standard scalar type within this class. Definition at line 79 of file itkImageMomentsCalculator.h.

template<class TImage> typedef ImageMomentsCalculator<TImage> itk::ImageMomentsCalculator< TImage >::Self

Standard class typedefs. Reimplemented from itk::Object. Definition at line 63 of file itkImageMomentsCalculator.h.

template<class TImage> typedef Object itk::ImageMomentsCalculator< TImage >::Superclass

Reimplemented from itk::Object. Definition at line 64 of file itkImageMomentsCalculator.h.

template<class TImage> typedef Vector<ScalarType,itkGetStaticConstMacro(ImageDimension) itk::ImageMomentsCalculator< TImage >::VectorType)

Standard vector type within this class. Definition at line 82 of file itkImageMomentsCalculator.h.

---

Constructor & Destructor Documentation

template<class TImage> itk::ImageMomentsCalculator< TImage >::ImageMomentsCalculator (   )  [protected]

template<class TImage> virtual itk::ImageMomentsCalculator< TImage >::~ImageMomentsCalculator (   )  [protected, virtual]

---

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.

template<class TImage> void itk::ImageMomentsCalculator< TImage >::Compute (  void   )

Compute moments of a new or modified image. This method computes the moments of the image given as a parameter and stores them in the object. The values of these moments and related parameters can then be retrieved by using other methods of this object.

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 TImage> VectorType itk::ImageMomentsCalculator< TImage >::GetCenterOfGravity (   )  const

Return center of gravity, in physical coordinates. This method returns the center of gravity of the image whose moments were last computed by this object. The center of gravity is computed in physical coordinates.

template<class TImage> MatrixType itk::ImageMomentsCalculator< TImage >::GetCentralMoments (   )  const

Return second central moments, in physical coordinates. This method returns the central second moments of the image whose moments were last computed by this object. The central moments are computed in physical coordinates.

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.

template<class TImage> VectorType itk::ImageMomentsCalculator< TImage >::GetFirstMoments (   )  const

Return first moments about origin, in index coordinates. This method returns the first moments around the origin of the image whose moments were last computed by this object. For simplicity, these moments are computed in index coordinates rather than physical coordinates.

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

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 TImage> virtual const char* itk::ImageMomentsCalculator< TImage >::GetNameOfClass (   )  const [virtual]

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

template<class TImage> AffineTransformPointer itk::ImageMomentsCalculator< TImage >::GetPhysicalAxesToPrincipalAxesTransform (  void   )  const

Get the affine transform from physical axes to principal axes This method returns an affine transform which transforms from the physical coordinate system to the principal axes coordinate system.

template<class TImage> AffineTransformPointer itk::ImageMomentsCalculator< TImage >::GetPrincipalAxesToPhysicalAxesTransform (  void   )  const

Get the affine transform from principal axes to physical axes This method returns an affine transform which transforms from the principal axes coordinate system to physical coordinates.

template<class TImage> VectorType itk::ImageMomentsCalculator< TImage >::GetPrincipalMoments (   )  const

Return principal moments, in physical coordinates. This method returns the principal moments of the image whose moments were last computed by this object. The moments are returned as a vector, with the principal moments ordered from smallest to largest. The moments are computed in physical coordinates.

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 TImage> MatrixType itk::ImageMomentsCalculator< TImage >::GetSecondMoments (   )  const

Return second moments about origin, in index coordinates. This method returns the second moments around the origin of the image whose moments were last computed by this object. For simplicity, these moments are computed in index coordinates rather than physical coordinates.

template<class TImage> ScalarType itk::ImageMomentsCalculator< TImage >::GetTotalMass (   )  const

Return the total mass (or zeroth moment) of an image. This method returns the sum of pixel intensities (also known as the zeroth moment or the total mass) of the image whose moments were last computed by this object.

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 TImage> itk::ImageMomentsCalculator< TImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TImage::ImageDimension  )

Extract the dimension of the image.

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 TImage> static Pointer itk::ImageMomentsCalculator< TImage >::New (   )  [static]

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

template<class TImage> that to have determinant and to preserve itk::ImageMomentsCalculator< TImage >::parity (  Unless you *have foolishly made one or more of the spacing values negative;*in that  case, _you_ get to figure out the  consequences. )  const

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 TImage> void itk::ImageMomentsCalculator< TImage >::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 TImage> Set the input image* virtual void itk::ImageMomentsCalculator< TImage >::SetImage (  const ImageType *  image  )  [inline, virtual]

Definition at line 101 of file itkImageMomentsCalculator.h.

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.

---

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]

template<class TImage> Return principal itk::ImageMomentsCalculator< TImage >::axes

Definition at line 159 of file itkImageMomentsCalculator.h.

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

Definition at line 94 of file itkObject.h.

template<class TImage> for itk::ImageMomentsCalculator< TImage >::example

Definition at line 163 of file itkImageMomentsCalculator.h.

template<class TImage> that* itk::ImageMomentsCalculator< TImage >::is

Definition at line 167 of file itkImageMomentsCalculator.h.

template<class TImage> for the principal axis* corresponding to the smallest principal moment is the vector* itk::ImageMomentsCalculator< TImage >::m[0]

Definition at line 163 of file itkImageMomentsCalculator.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.

template<class TImage> Return principal in physical coordinates* This method returns the principal axes of the image whose* moments were last computed by this object The moments are* returned as an orthogonal itk::ImageMomentsCalculator< TImage >::matrix

Definition at line 159 of file itkImageMomentsCalculator.h.

template<class TImage> Return principal in physical coordinates* This method returns the principal axes of the image whose* moments were last computed by this object The moments are* returned as an orthogonal each row of which corresponds* to one principal itk::ImageMomentsCalculator< TImage >::moment

Definition at line 159 of file itkImageMomentsCalculator.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]

template<class TImage> for the principal axis* corresponding to the smallest principal moment is the vector where m is the value returned by this method The matrix* of principal axes is guaranteed to be a proper itk::ImageMomentsCalculator< TImage >::rotation

Definition at line 163 of file itkImageMomentsCalculator.h.

---

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

• itkImageMomentsCalculator.h

---