ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::ImageMomentsCalculator< TImage > Class Template Reference

#include <itkImageMomentsCalculator.h>

+ Inheritance diagram for itk::ImageMomentsCalculator< TImage >:
+ Collaboration diagram for itk::ImageMomentsCalculator< TImage >:

Public Types

using AffineTransformPointer = typename AffineTransformType::Pointer
 
using AffineTransformType = AffineTransform< double, Self::ImageDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using ImageConstPointer = typename ImageType::ConstPointer
 
using ImagePointer = typename ImageType::Pointer
 
using ImageType = TImage
 
using MatrixType = Matrix< ScalarType, Self::ImageDimension, Self::ImageDimension >
 
using Pointer = SmartPointer< Self >
 
using ScalarType = double
 
using Self = ImageMomentsCalculator< TImage >
 
using SpatialObjectConstPointer = typename SpatialObjectType::ConstPointer
 
using SpatialObjectPointer = typename SpatialObjectType::Pointer
 
using SpatialObjectType = SpatialObject< Self::ImageDimension >
 
using Superclass = Object
 
using VectorType = Vector< ScalarType, Self::ImageDimension >
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
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 constexpr unsigned int ImageDimension = TImage::ImageDimension
 
bool m_Valid
 
ScalarType m_M0
 
VectorType m_M1
 
MatrixType m_M2
 
VectorType m_Cg
 
MatrixType m_Cm
 
VectorType m_Pm
 
MatrixType m_Pa
 
ImageConstPointer m_Image
 
SpatialObjectConstPointer m_SpatialObjectMask
 
virtual void SetImage (const ImageType *image)
 
virtual void SetSpatialObjectMask (const SpatialObject< Self::ImageDimension > *so)
 
void Compute ()
 
ScalarType GetTotalMass () const
 
VectorType GetFirstMoments () const
 
MatrixType GetSecondMoments () const
 
VectorType GetCenterOfGravity () const
 
MatrixType GetCentralMoments () const
 
VectorType GetPrincipalMoments () const
 
MatrixType GetPrincipalAxes () const
 
AffineTransformPointer GetPrincipalAxesToPhysicalAxesTransform () const
 
AffineTransformPointer GetPhysicalAxesToPrincipalAxesTransform () const
 
 ImageMomentsCalculator ()
 
 ~ImageMomentsCalculator () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.

Member Typedef Documentation

◆ AffineTransformPointer

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::AffineTransformPointer = typename AffineTransformType::Pointer

Definition at line 105 of file itkImageMomentsCalculator.h.

◆ AffineTransformType

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::AffineTransformType = AffineTransform<double, Self::ImageDimension>

Affine transform for mapping to and from principal axis

Definition at line 104 of file itkImageMomentsCalculator.h.

◆ ConstPointer

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::ConstPointer = SmartPointer<const Self>

Definition at line 69 of file itkImageMomentsCalculator.h.

◆ ImageConstPointer

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::ImageConstPointer = typename ImageType::ConstPointer

Definition at line 101 of file itkImageMomentsCalculator.h.

◆ ImagePointer

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::ImagePointer = typename ImageType::Pointer

Standard image type pointer within this class.

Definition at line 100 of file itkImageMomentsCalculator.h.

◆ ImageType

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::ImageType = TImage

Standard image type within this class.

Definition at line 97 of file itkImageMomentsCalculator.h.

◆ MatrixType

Standard matrix type within this class.

Definition at line 94 of file itkImageMomentsCalculator.h.

◆ Pointer

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::Pointer = SmartPointer<Self>

Definition at line 68 of file itkImageMomentsCalculator.h.

◆ ScalarType

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::ScalarType = double

Standard scalar type within this class.

Definition at line 81 of file itkImageMomentsCalculator.h.

◆ Self

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::Self = ImageMomentsCalculator<TImage>

Standard class type aliases.

Definition at line 66 of file itkImageMomentsCalculator.h.

◆ SpatialObjectConstPointer

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::SpatialObjectConstPointer = typename SpatialObjectType::ConstPointer

Definition at line 91 of file itkImageMomentsCalculator.h.

◆ SpatialObjectPointer

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::SpatialObjectPointer = typename SpatialObjectType::Pointer

Spatial Object member types used within this class.

Definition at line 90 of file itkImageMomentsCalculator.h.

◆ SpatialObjectType

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::SpatialObjectType = SpatialObject<Self::ImageDimension>

Spatial Object type within this class.

Definition at line 87 of file itkImageMomentsCalculator.h.

◆ Superclass

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::Superclass = Object

Definition at line 67 of file itkImageMomentsCalculator.h.

◆ VectorType

template<typename TImage >
using itk::ImageMomentsCalculator< TImage >::VectorType = Vector<ScalarType, Self::ImageDimension>

Standard vector type within this class.

Definition at line 84 of file itkImageMomentsCalculator.h.

Constructor & Destructor Documentation

◆ ImageMomentsCalculator()

template<typename TImage >
itk::ImageMomentsCalculator< TImage >::ImageMomentsCalculator ( )
protected

Set the input image.

◆ ~ImageMomentsCalculator()

template<typename TImage >
itk::ImageMomentsCalculator< TImage >::~ImageMomentsCalculator ( )
overrideprotecteddefault

Set the input image.

Member Function Documentation

◆ Compute()

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.

◆ CreateAnother()

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.

◆ GetCenterOfGravity()

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.

◆ GetCentralMoments()

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.

◆ GetFirstMoments()

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.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::Object.

◆ GetPhysicalAxesToPrincipalAxesTransform()

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.

◆ GetPrincipalAxes()

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.

◆ GetPrincipalAxesToPhysicalAxesTransform()

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.

◆ GetPrincipalMoments()

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.

◆ GetSecondMoments()

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.

◆ GetTotalMass()

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.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

Set the input image.

Reimplemented from itk::Object.

◆ SetImage()

template<typename TImage >
virtual void itk::ImageMomentsCalculator< TImage >::SetImage ( const ImageType image)
inlinevirtual

Set the input image.

Definition at line 109 of file itkImageMomentsCalculator.h.

◆ SetSpatialObjectMask()

template<typename TImage >
virtual void itk::ImageMomentsCalculator< TImage >::SetSpatialObjectMask ( const SpatialObject< Self::ImageDimension > *  so)
inlinevirtual

Set the spatial object mask.

Definition at line 122 of file itkImageMomentsCalculator.h.

Member Data Documentation

◆ ImageDimension

template<typename TImage >
constexpr unsigned int itk::ImageMomentsCalculator< TImage >::ImageDimension = TImage::ImageDimension
staticconstexpr

Extract the dimension of the image.

Definition at line 78 of file itkImageMomentsCalculator.h.

◆ m_Cg

template<typename TImage >
VectorType itk::ImageMomentsCalculator< TImage >::m_Cg
private

Set the input image.

Definition at line 227 of file itkImageMomentsCalculator.h.

◆ m_Cm

template<typename TImage >
MatrixType itk::ImageMomentsCalculator< TImage >::m_Cm
private

Set the input image.

Definition at line 228 of file itkImageMomentsCalculator.h.

◆ m_Image

template<typename TImage >
ImageConstPointer itk::ImageMomentsCalculator< TImage >::m_Image
private

Set the input image.

Definition at line 232 of file itkImageMomentsCalculator.h.

◆ m_M0

template<typename TImage >
ScalarType itk::ImageMomentsCalculator< TImage >::m_M0
private

Set the input image.

Definition at line 224 of file itkImageMomentsCalculator.h.

◆ m_M1

template<typename TImage >
VectorType itk::ImageMomentsCalculator< TImage >::m_M1
private

Set the input image.

Definition at line 225 of file itkImageMomentsCalculator.h.

◆ m_M2

template<typename TImage >
MatrixType itk::ImageMomentsCalculator< TImage >::m_M2
private

Set the input image.

Definition at line 226 of file itkImageMomentsCalculator.h.

◆ m_Pa

template<typename TImage >
MatrixType itk::ImageMomentsCalculator< TImage >::m_Pa
private

Set the input image.

Definition at line 230 of file itkImageMomentsCalculator.h.

◆ m_Pm

template<typename TImage >
VectorType itk::ImageMomentsCalculator< TImage >::m_Pm
private

Set the input image.

Definition at line 229 of file itkImageMomentsCalculator.h.

◆ m_SpatialObjectMask

template<typename TImage >
SpatialObjectConstPointer itk::ImageMomentsCalculator< TImage >::m_SpatialObjectMask
private

Set the input image.

Definition at line 233 of file itkImageMomentsCalculator.h.

◆ m_Valid

template<typename TImage >
bool itk::ImageMomentsCalculator< TImage >::m_Valid
private

Set the input image.

Definition at line 223 of file itkImageMomentsCalculator.h.


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