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

Compute moments of an n-dimensional image. More...

#include <itkImageMomentsCalculator.h>

Inheritance diagram for itk::ImageMomentsCalculator< TImage >:

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

[legend]List of all members.

Public Types
typedef ImageMomentsCalculator< TImage >	Self
typedef Object	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef double	ScalarType
typedef Vector< ScalarType, itkGetStaticConstMacro(ImageDimension)	VectorType )
typedef Matrix< ScalarType, itkGetStaticConstMacro(ImageDimension), itkGetStaticConstMacro(ImageDimension)	MatrixType )
typedef TImage	ImageType
typedef ImageType::Pointer	ImagePointer
typedef ImageType::ConstPointer	ImageConstPointer
typedef AffineTransform< double, itkGetStaticConstMacro(ImageDimension)	AffineTransformType )
typedef AffineTransformType::Pointer	AffineTransformPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension)
void	Compute (void)
ScalarType	GetTotalMass () const
VectorType	GetFirstMoments () const
MatrixType	GetSecondMoments () const
VectorType	GetCenterOfGravity () const
MatrixType	GetCentralMoments () const
VectorType	GetPrincipalMoments () const
AffineTransformPointer	GetPrincipalAxesToPhysicalAxesTransform (void) const
AffineTransformPointer	GetPhysicalAxesToPrincipalAxesTransform (void) const
virtual void	SetImage (const ImageType *image)
MatrixType	GetPrincipalAxes () const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ImageMomentsCalculator ()
virtual	~ImageMomentsCalculator ()
void	PrintSelf (std::ostream &os, Indent indent) const

---

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.

---

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. Referenced by itk::ImageMomentsCalculator< TImage >::SetImage().

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

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.

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.

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.

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

Return principal axes, 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, each row of which corresponds to one principal moment; for example, the principal axis corresponding to the smallest principal moment is the vector m[0], where m is the value returned by this method. The matrix of principal axes is guaranteed to be a proper rotation; that is, to have determinant +1 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.

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.

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.

template<class TImage> itk::ImageMomentsCalculator< TImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TImage::ImageDimension  )

Extract the dimension of the image.

template<class TImage> Pointer itk::ImageMomentsCalculator< TImage >::New (   )  [static]

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

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.

template<class TImage> virtual void itk::ImageMomentsCalculator< TImage >::SetImage (  const ImageType *  image  )  [inline, virtual]

Set the input image. Definition at line 101 of file itkImageMomentsCalculator.h. References itk::ImageMomentsCalculator< TImage >::ImageType.

---

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

• itkImageMomentsCalculator.h

---