itk::ImageRegionMomentsCalculator< TImage > Class Template Reference

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

#include <itkImageRegionMomentsCalculator.h>

Inheritance diagram for itk::ImageRegionMomentsCalculator< TImage >:
Object

List of all members.

Public Types

typedef
AffineTransformType::Pointer 
AffineTransformPointer
typedef AffineTransform
< double,
itkGetStaticConstMacro(ImageDimension)> 
AffineTransformType
typedef SmartPointer< const SelfConstPointer
typedef ImageType::ConstPointer ImageConstPointer
typedef ImageType::Pointer ImagePointer
typedef TImage ImageType
typedef Matrix< ScalarType,
itkGetStaticConstMacro(ImageDimension),
itkGetStaticConstMacro(ImageDimension)> 
MatrixType
typedef SmartPointer< SelfPointer
typedef TImage::PointType PointType
typedef double ScalarType
typedef
ImageRegionMomentsCalculator
< TImage > 
Self
typedef
SpatialObjectType::ConstPointer 
SpatialObjectConstPointer
typedef SpatialObjectType::Pointer SpatialObjectPointer
typedef SpatialObject
< itkGetStaticConstMacro(ImageDimension) > 
SpatialObjectType
typedef Object Superclass
typedef Vector< ScalarType,
itkGetStaticConstMacro(ImageDimension)> 
VectorType

Public Member Functions

void Compute (void)
VectorType GetCenterOfGravity () const
MatrixType GetCentralMoments () const
VectorType GetFirstMoments () const
AffineTransformPointer GetPhysicalAxesToPrincipalAxesTransform (void) const
MatrixType GetPrincipalAxes () const
AffineTransformPointer GetPrincipalAxesToPhysicalAxesTransform (void) const
VectorType GetPrincipalMoments () const
MatrixType GetSecondMoments () const
ScalarType GetTotalMass () const
 itkGetMacro (RegionOfInterestPoint2, PointType)
 itkGetMacro (RegionOfInterestPoint1, PointType)
 itkGetMacro (UseRegionOfInterest, bool)
 itkNewMacro (Self)
 itkSetMacro (UseRegionOfInterest, bool)
 itkStaticConstMacro (ImageDimension, unsigned int, TImage::ImageDimension)
 itkTypeMacro (ImageRegionMomentsCalculator, Object)
virtual void SetImage (const ImageType *image)
virtual void SetRegionOfInterest (const PointType &point1, const PointType &point2)
virtual void SetSpatialObjectMask (const SpatialObject< itkGetStaticConstMacro(ImageDimension) > *so)

Protected Member Functions

 ImageRegionMomentsCalculator ()
void PrintSelf (std::ostream &os, Indent indent) const
virtual ~ImageRegionMomentsCalculator ()

Private Member Functions

 ImageRegionMomentsCalculator (const Self &)
void operator= (const Self &)

Private Attributes

VectorType m_Cg
MatrixType m_Cm
ImageConstPointer m_Image
ScalarType m_M0
VectorType m_M1
MatrixType m_M2
MatrixType m_Pa
VectorType m_Pm
PointType m_RegionOfInterestPoint1
PointType m_RegionOfInterestPoint2
SpatialObjectConstPointer m_SpatialObjectMask
bool m_UseRegionOfInterest
bool m_Valid

Detailed Description

template<class TImage>
class itk::ImageRegionMomentsCalculator< 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 ImageRegionMomentsCalculator 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.

Member Typedef Documentation

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

Affine transform for mapping to and from principal axis

template<class TImage >
typedef SmartPointer<const Self> itk::ImageRegionMomentsCalculator< TImage >::ConstPointer
template<class TImage >
typedef ImageType::ConstPointer itk::ImageRegionMomentsCalculator< TImage >::ImageConstPointer
template<class TImage >
typedef ImageType::Pointer itk::ImageRegionMomentsCalculator< TImage >::ImagePointer

Standard image type pointer within this class.

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

Standard image type within this class.

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

Standard matrix type within this class.

template<class TImage >
typedef SmartPointer<Self> itk::ImageRegionMomentsCalculator< TImage >::Pointer
template<class TImage >
typedef TImage::PointType itk::ImageRegionMomentsCalculator< TImage >::PointType
template<class TImage >
typedef double itk::ImageRegionMomentsCalculator< TImage >::ScalarType

Standard scalar type within this class.

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

Standard class typedefs.

template<class TImage >
typedef SpatialObjectType::ConstPointer itk::ImageRegionMomentsCalculator< TImage >::SpatialObjectConstPointer
template<class TImage >
typedef SpatialObjectType::Pointer itk::ImageRegionMomentsCalculator< TImage >::SpatialObjectPointer

Spatial Object member types used within this class.

template<class TImage >
typedef SpatialObject< itkGetStaticConstMacro(ImageDimension) > itk::ImageRegionMomentsCalculator< TImage >::SpatialObjectType

Spatial Object type within this class.

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

Standard vector type within this class.


Constructor & Destructor Documentation

template<class TImage >
itk::ImageRegionMomentsCalculator< TImage >::ImageRegionMomentsCalculator (  )  [protected]
template<class TImage >
virtual itk::ImageRegionMomentsCalculator< TImage >::~ImageRegionMomentsCalculator (  )  [protected, virtual]
template<class TImage >
itk::ImageRegionMomentsCalculator< TImage >::ImageRegionMomentsCalculator ( const Self  )  [private]

Member Function Documentation

template<class TImage >
void itk::ImageRegionMomentsCalculator< 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::ImageRegionMomentsCalculator< 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::ImageRegionMomentsCalculator< 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::ImageRegionMomentsCalculator< 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 >
AffineTransformPointer itk::ImageRegionMomentsCalculator< 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::ImageRegionMomentsCalculator< 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::ImageRegionMomentsCalculator< 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::ImageRegionMomentsCalculator< 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::ImageRegionMomentsCalculator< 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::ImageRegionMomentsCalculator< 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::ImageRegionMomentsCalculator< TImage >::itkGetMacro ( RegionOfInterestPoint2  ,
PointType   
)
template<class TImage >
itk::ImageRegionMomentsCalculator< TImage >::itkGetMacro ( RegionOfInterestPoint1  ,
PointType   
)
template<class TImage >
itk::ImageRegionMomentsCalculator< TImage >::itkGetMacro ( UseRegionOfInterest  ,
bool   
)
template<class TImage >
itk::ImageRegionMomentsCalculator< TImage >::itkNewMacro ( Self   ) 

Method for creation through the object factory.

template<class TImage >
itk::ImageRegionMomentsCalculator< TImage >::itkSetMacro ( UseRegionOfInterest  ,
bool   
)

Method for controlling the region of interest that optionally limits the spatial extent of the computations

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

Extract the dimension of the image.

template<class TImage >
itk::ImageRegionMomentsCalculator< TImage >::itkTypeMacro ( ImageRegionMomentsCalculator< TImage >  ,
Object   
)

Run-time type information (and related methods).

template<class TImage >
void itk::ImageRegionMomentsCalculator< TImage >::operator= ( const Self  )  [private]
template<class TImage >
void itk::ImageRegionMomentsCalculator< TImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected]
template<class TImage >
virtual void itk::ImageRegionMomentsCalculator< TImage >::SetImage ( const ImageType image  )  [inline, virtual]

Set the input image.

References FW::Actions::Modified.

template<class TImage >
virtual void itk::ImageRegionMomentsCalculator< TImage >::SetRegionOfInterest ( const PointType point1,
const PointType point2 
) [inline, virtual]

References FW::Actions::Modified.

template<class TImage >
virtual void itk::ImageRegionMomentsCalculator< TImage >::SetSpatialObjectMask ( const SpatialObject< itkGetStaticConstMacro(ImageDimension) > *  so  )  [inline, virtual]

Set the spatial object mask.

References FW::Actions::Modified.


Member Data Documentation

template<class TImage >
VectorType itk::ImageRegionMomentsCalculator< TImage >::m_Cg [private]
template<class TImage >
MatrixType itk::ImageRegionMomentsCalculator< TImage >::m_Cm [private]
template<class TImage >
ImageConstPointer itk::ImageRegionMomentsCalculator< TImage >::m_Image [private]
template<class TImage >
ScalarType itk::ImageRegionMomentsCalculator< TImage >::m_M0 [private]
template<class TImage >
VectorType itk::ImageRegionMomentsCalculator< TImage >::m_M1 [private]
template<class TImage >
MatrixType itk::ImageRegionMomentsCalculator< TImage >::m_M2 [private]
template<class TImage >
MatrixType itk::ImageRegionMomentsCalculator< TImage >::m_Pa [private]
template<class TImage >
VectorType itk::ImageRegionMomentsCalculator< TImage >::m_Pm [private]
template<class TImage >
PointType itk::ImageRegionMomentsCalculator< TImage >::m_RegionOfInterestPoint1 [private]
template<class TImage >
PointType itk::ImageRegionMomentsCalculator< TImage >::m_RegionOfInterestPoint2 [private]
template<class TImage >
bool itk::ImageRegionMomentsCalculator< TImage >::m_UseRegionOfInterest [private]
template<class TImage >
bool itk::ImageRegionMomentsCalculator< TImage >::m_Valid [private]

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

Generated on 6 Apr 2011 for Slicer3 by  doxygen 1.6.1