Slicer  4.11
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Protected Member Functions
itk::ImageRegionMomentsCalculator< TImage > Class Template Reference

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

#include <Modules/CLI/ExpertAutomatedRegistration/ITKRegistrationHelper/itkImageRegionMomentsCalculator.h>

Inheritance diagram for itk::ImageRegionMomentsCalculator< TImage >:
Inheritance graph
[legend]
Collaboration diagram for itk::ImageRegionMomentsCalculator< TImage >:
Collaboration graph
[legend]

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 (UseRegionOfInterest, bool)
 
 itkGetMacro (RegionOfInterestPoint1, PointType)
 
 itkGetMacro (RegionOfInterestPoint2, PointType)
 
 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 override
 
 ~ImageRegionMomentsCalculator () override
 

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.

Definition at line 60 of file itkImageRegionMomentsCalculator.h.

Member Typedef Documentation

◆ AffineTransformPointer

template<class TImage >
typedef AffineTransformType::Pointer itk::ImageRegionMomentsCalculator< TImage >::AffineTransformPointer

Definition at line 108 of file itkImageRegionMomentsCalculator.h.

◆ AffineTransformType

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

Affine transform for mapping to and from principal axis

Definition at line 107 of file itkImageRegionMomentsCalculator.h.

◆ ConstPointer

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

Definition at line 67 of file itkImageRegionMomentsCalculator.h.

◆ ImageConstPointer

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

Definition at line 104 of file itkImageRegionMomentsCalculator.h.

◆ ImagePointer

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

Standard image type pointer within this class.

Definition at line 103 of file itkImageRegionMomentsCalculator.h.

◆ ImageType

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

Standard image type within this class.

Definition at line 100 of file itkImageRegionMomentsCalculator.h.

◆ MatrixType

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

Standard matrix type within this class.

Definition at line 97 of file itkImageRegionMomentsCalculator.h.

◆ Pointer

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

Definition at line 66 of file itkImageRegionMomentsCalculator.h.

◆ PointType

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

Definition at line 82 of file itkImageRegionMomentsCalculator.h.

◆ ScalarType

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

Standard scalar type within this class.

Definition at line 80 of file itkImageRegionMomentsCalculator.h.

◆ Self

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

Standard class typedefs.

Definition at line 64 of file itkImageRegionMomentsCalculator.h.

◆ SpatialObjectConstPointer

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

Definition at line 92 of file itkImageRegionMomentsCalculator.h.

◆ SpatialObjectPointer

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

Spatial Object member types used within this class.

Definition at line 91 of file itkImageRegionMomentsCalculator.h.

◆ SpatialObjectType

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

Spatial Object type within this class.

Definition at line 88 of file itkImageRegionMomentsCalculator.h.

◆ Superclass

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

Definition at line 65 of file itkImageRegionMomentsCalculator.h.

◆ VectorType

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

Standard vector type within this class.

Definition at line 85 of file itkImageRegionMomentsCalculator.h.

Constructor & Destructor Documentation

◆ ImageRegionMomentsCalculator()

template<class TImage >
itk::ImageRegionMomentsCalculator< TImage >::ImageRegionMomentsCalculator ( )
protected

◆ ~ImageRegionMomentsCalculator()

template<class TImage >
itk::ImageRegionMomentsCalculator< TImage >::~ImageRegionMomentsCalculator ( )
overrideprotected

Member Function Documentation

◆ Compute()

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.

◆ GetCenterOfGravity()

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.

◆ GetCentralMoments()

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.

◆ GetFirstMoments()

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.

◆ GetPhysicalAxesToPrincipalAxesTransform()

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.

◆ GetPrincipalAxes()

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.

◆ GetPrincipalAxesToPhysicalAxesTransform()

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.

◆ GetPrincipalMoments()

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.

◆ GetSecondMoments()

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.

◆ GetTotalMass()

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.

◆ itkGetMacro() [1/3]

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

◆ itkGetMacro() [2/3]

template<class TImage >
itk::ImageRegionMomentsCalculator< TImage >::itkGetMacro ( RegionOfInterestPoint1  ,
PointType   
)

◆ itkGetMacro() [3/3]

template<class TImage >
itk::ImageRegionMomentsCalculator< TImage >::itkGetMacro ( RegionOfInterestPoint2  ,
PointType   
)

◆ itkNewMacro()

template<class TImage >
itk::ImageRegionMomentsCalculator< TImage >::itkNewMacro ( Self  )

Method for creation through the object factory.

◆ itkSetMacro()

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

◆ itkStaticConstMacro()

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

Extract the dimension of the image.

◆ itkTypeMacro()

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

Run-time type information (and related methods).

◆ PrintSelf()

template<class TImage >
void itk::ImageRegionMomentsCalculator< TImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotected

◆ SetImage()

template<class TImage >
virtual void itk::ImageRegionMomentsCalculator< TImage >::SetImage ( const ImageType image)
inlinevirtual

Set the input image.

Definition at line 111 of file itkImageRegionMomentsCalculator.h.

◆ SetRegionOfInterest()

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

Definition at line 136 of file itkImageRegionMomentsCalculator.h.

◆ SetSpatialObjectMask()

template<class TImage >
virtual void itk::ImageRegionMomentsCalculator< TImage >::SetSpatialObjectMask ( const SpatialObject< itkGetStaticConstMacro(ImageDimension)> *  so)
inlinevirtual

Set the spatial object mask.

Definition at line 122 of file itkImageRegionMomentsCalculator.h.


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