#include <itkImageMomentsCalculator.h>

Inheritance diagram for itk::ImageMomentsCalculator< TImage >:

Collaboration diagram for itk::ImageMomentsCalculator< TImage >:

Detailed Description

template<typename 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.

Examples:: Examples/RegistrationITKv4/MultiStageImageRegistration2.cxx.

Definition at line 60 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 SpatialObjectType::ConstPointer	SpatialObjectConstPointer

typedef SpatialObjectType::Pointer	SpatialObjectPointer

typedef SpatialObject < itkGetStaticConstMacro(ImageDimension) >	SpatialObjectType

typedef Object	Superclass

typedef Vector< ScalarType, itkGetStaticConstMacro(ImageDimension) >	VectorType

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
void	Compute ()

virtual ::itk::LightObject::Pointer	CreateAnother () const

VectorType	GetCenterOfGravity () const

MatrixType	GetCentralMoments () const

VectorType	GetFirstMoments () const

virtual const char *	GetNameOfClass () const

AffineTransformPointer	GetPhysicalAxesToPrincipalAxesTransform () const

AffineTransformPointer	GetPrincipalAxesToPhysicalAxesTransform () const

VectorType	GetPrincipalMoments () const

MatrixType	GetSecondMoments () const

ScalarType	GetTotalMass () const


virtual void	SetImage (const ImageType *image)


virtual void	SetSpatialObjectMask (const SpatialObject< itkGetStaticConstMacro(ImageDimension) > *so)


MatrixType	GetPrincipalAxes () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = TImage::ImageDimension

Protected Member Functions
	ImageMomentsCalculator ()

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

virtual	~ImageMomentsCalculator ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
	ImageMomentsCalculator (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

SpatialObjectConstPointer	m_SpatialObjectMask

bool	m_Valid

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Member Typedef Documentation

template<typename TImage >

typedef AffineTransformType::Pointer itk::ImageMomentsCalculator< TImage >::AffineTransformPointer

Definition at line 106 of file itkImageMomentsCalculator.h.

template<typename TImage >

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

Affine transform for mapping to and from principal axis

Definition at line 105 of file itkImageMomentsCalculator.h.

template<typename TImage >

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

Definition at line 67 of file itkImageMomentsCalculator.h.

template<typename TImage >

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

Definition at line 102 of file itkImageMomentsCalculator.h.

template<typename TImage >

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

Standard image type pointer within this class.

Definition at line 101 of file itkImageMomentsCalculator.h.

template<typename TImage >

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

Standard image type within this class.

Definition at line 98 of file itkImageMomentsCalculator.h.

template<typename TImage >

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

Standard matrix type within this class.

Definition at line 95 of file itkImageMomentsCalculator.h.

template<typename TImage >

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

Definition at line 66 of file itkImageMomentsCalculator.h.

template<typename TImage >

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

Standard scalar type within this class.

Definition at line 80 of file itkImageMomentsCalculator.h.

template<typename TImage >

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

Standard class typedefs.

Definition at line 64 of file itkImageMomentsCalculator.h.

template<typename TImage >

typedef SpatialObjectType::ConstPointer itk::ImageMomentsCalculator< TImage >::SpatialObjectConstPointer

Definition at line 90 of file itkImageMomentsCalculator.h.

template<typename TImage >

typedef SpatialObjectType::Pointer itk::ImageMomentsCalculator< TImage >::SpatialObjectPointer

Spatial Object member types used within this class.

Definition at line 89 of file itkImageMomentsCalculator.h.

template<typename TImage >

typedef SpatialObject< itkGetStaticConstMacro(ImageDimension) > itk::ImageMomentsCalculator< TImage >::SpatialObjectType

Spatial Object type within this class.

Definition at line 86 of file itkImageMomentsCalculator.h.

template<typename TImage >

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

Definition at line 65 of file itkImageMomentsCalculator.h.

template<typename TImage >

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

Standard vector type within this class.

Definition at line 83 of file itkImageMomentsCalculator.h.

Constructor & Destructor Documentation

template<typename TImage >

itk::ImageMomentsCalculator< TImage >::ImageMomentsCalculator ( )

protected

template<typename TImage >

virtual itk::ImageMomentsCalculator< TImage >::~ImageMomentsCalculator ( )

protectedvirtual

template<typename TImage >

itk::ImageMomentsCalculator< TImage >::ImageMomentsCalculator ( const Self & )

private

Member Function Documentation

template<typename TImage >

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

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<typename TImage >

virtual::itk::LightObject::Pointer itk::ImageMomentsCalculator< TImage >::CreateAnother ( ) const

virtual

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::Object.

template<typename 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<typename 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<typename 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<typename TImage >

virtual const char* itk::ImageMomentsCalculator< TImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<typename TImage >

AffineTransformPointer itk::ImageMomentsCalculator< TImage >::GetPhysicalAxesToPrincipalAxesTransform ( ) 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<typename 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<typename TImage >

AffineTransformPointer itk::ImageMomentsCalculator< TImage >::GetPrincipalAxesToPhysicalAxesTransform ( ) 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<typename 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<typename 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<typename 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<typename TImage >

static Pointer itk::ImageMomentsCalculator< TImage >::New ( )

static

Method for creation through the object factory.

template<typename TImage >

void itk::ImageMomentsCalculator< TImage >::operator= ( const Self & )

private

template<typename TImage >

virtual void itk::ImageMomentsCalculator< TImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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<typename TImage >

virtual void itk::ImageMomentsCalculator< TImage >::SetImage ( const ImageType * image )