itkImageRegionMomentsCalculator.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkImageRegionMomentsCalculator.h,v $
  Language:  C++
  Date:      $Date: 2008-10-06 08:54:43 $
  Version:   $Revision: 1.39 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef itkImageRegionMomentsCalculator_h
#define itkImageRegionMomentsCalculator_h

#include "itkAffineTransform.h"
#include "itkMacro.h"
#include "itkImage.h"
#include "itkSpatialObject.h"

#include "vnl/vnl_vector_fixed.h"
#include "vnl/vnl_matrix_fixed.h"
#include "vnl/vnl_diag_matrix.h"

namespace itk
{

template <class TImage>
class ImageRegionMomentsCalculator : public Object
{
public:
  typedef ImageRegionMomentsCalculator<TImage> Self;
  typedef Object                               Superclass;
  typedef SmartPointer<Self>                   Pointer;
  typedef SmartPointer<const Self>             ConstPointer;

  itkNewMacro(Self);

  itkTypeMacro(ImageRegionMomentsCalculator, Object);

  itkStaticConstMacro(ImageDimension, unsigned int,
                      TImage::ImageDimension);

  typedef double ScalarType;

  typedef typename TImage::PointType PointType;

  typedef Vector<ScalarType, itkGetStaticConstMacro(ImageDimension)> VectorType;

  typedef SpatialObject<itkGetStaticConstMacro(ImageDimension)> SpatialObjectType;

  typedef typename SpatialObjectType::Pointer      SpatialObjectPointer;
  typedef typename SpatialObjectType::ConstPointer SpatialObjectConstPointer;

  typedef Matrix<ScalarType,
                 itkGetStaticConstMacro(ImageDimension),
                 itkGetStaticConstMacro(ImageDimension)>   MatrixType;

  typedef TImage ImageType;

  typedef typename ImageType::Pointer      ImagePointer;
  typedef typename ImageType::ConstPointer ImageConstPointer;

  typedef AffineTransform<double, itkGetStaticConstMacro(ImageDimension)> AffineTransformType;
  typedef typename AffineTransformType::Pointer                           AffineTransformPointer;

  virtual void SetImage( const ImageType * image )
  {
    if( m_Image != image )
      {
      m_Image = image;
      this->Modified();
      m_Valid = false;
      }
  }

  virtual void SetSpatialObjectMask( const SpatialObject<itkGetStaticConstMacro( ImageDimension )> * so )
  {
    if( m_SpatialObjectMask != so )
      {
      m_SpatialObjectMask = so;
      this->Modified();
      m_Valid = false;
      }
  }

  itkSetMacro(UseRegionOfInterest, bool);
  itkGetMacro(UseRegionOfInterest, bool);
  virtual void SetRegionOfInterest( const PointType & point1, const PointType & point2 )
  {
    if( m_RegionOfInterestPoint1 != point1 || m_RegionOfInterestPoint2 != point2 )
      {
      m_RegionOfInterestPoint1 = point1;
      m_RegionOfInterestPoint2 = point2;
      this->Modified();
      m_Valid = false;
      }
  }

  itkGetMacro(RegionOfInterestPoint1, PointType);
  itkGetMacro(RegionOfInterestPoint2, PointType);

  void Compute( void );

  ScalarType GetTotalMass() const;

  VectorType GetFirstMoments() const;

  MatrixType GetSecondMoments() const;

  VectorType GetCenterOfGravity() const;

  MatrixType GetCentralMoments() const;

  VectorType GetPrincipalMoments() const;

  MatrixType GetPrincipalAxes() const;

  AffineTransformPointer GetPrincipalAxesToPhysicalAxesTransform(void) const;

  AffineTransformPointer GetPhysicalAxesToPrincipalAxesTransform(void) const;

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

private:
  ImageRegionMomentsCalculator(const Self &); // purposely not implemented
  void operator=(const Self &);               // purposely not implemented

  bool       m_Valid;                // Have moments been computed yet?
  ScalarType m_M0;                   // Zeroth moment
  VectorType m_M1;                   // First moments about origin
  MatrixType m_M2;                   // Second moments about origin
  VectorType m_Cg;                   // Center of gravity (physical units)
  MatrixType m_Cm;                   // Second central moments (physical)
  VectorType m_Pm;                   // Principal moments (physical)
  MatrixType m_Pa;                   // Principal axes (physical)

  bool      m_UseRegionOfInterest;
  PointType m_RegionOfInterestPoint1;
  PointType m_RegionOfInterestPoint2;

  ImageConstPointer         m_Image;
  SpatialObjectConstPointer m_SpatialObjectMask;

};  // class ImageRegionMomentsCalculator

} // end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkImageRegionMomentsCalculator.txx"
#endif

#endif /* itkImageRegionMomentsCalculator_h */