ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension > Class Template Reference

#include <itkSpatialObjectToImageStatisticsCalculator.h>

+ Inheritance diagram for itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >:
+ Collaboration diagram for itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >:

Detailed Description

template<typename TInputImage, typename TInputSpatialObject, unsigned int TSampleDimension = 1>
class itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >

This calculator computes the mean and the covariance matrice of a certain region of an image specified by a spatial object.

Examples:
Examples/SpatialObjects/SpatialObjectToImageStatisticsCalculator.cxx.

Definition at line 36 of file itkSpatialObjectToImageStatisticsCalculator.h.

Public Types

using AccumulateType = typename NumericTraits< PixelType >::AccumulateType
 
using ConstPointer = SmartPointer< const Self >
 
using ImageConstPointer = typename TInputImage::ConstPointer
 
using ImagePointer = typename TInputImage::Pointer
 
using ImageType = TInputImage
 
using IndexType = typename TInputImage::IndexType
 
using MatrixType = Matrix< double, TSampleDimension, TSampleDimension >
 
using PixelType = typename TInputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename TInputImage::PointType
 
using RegionType = typename TInputImage::RegionType
 
using SampleType = itk::Statistics::ListSample< VectorType >
 
using Self = SpatialObjectToImageStatisticsCalculator
 
using SizeType = typename RegionType::SizeType
 
using SpatialObjectConstPointer = typename SpatialObjectType::ConstPointer
 
using SpatialObjectPointer = typename SpatialObjectType::Pointer
 
using SpatialObjectType = TInputSpatialObject
 
using Superclass = Object
 
using VectorType = Vector< double, TSampleDimension >
 
- 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
 
const MatrixTypeGetCovarianceMatrix () const
 
const VectorTypeGetMean () const
 
virtual const char * GetNameOfClass () const
 
virtual SizeValueType GetNumberOfPixels () const
 
AccumulateType GetSum () const
 
virtual void SetImage (const ImageType *_arg)
 
virtual void SetSpatialObject (SpatialObjectType *_arg)
 
void Update ()
 
virtual void SetSampleDirection (unsigned int _arg)
 
virtual unsigned int GetSampleDirection () 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
 
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 noexceptoverride
 
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 = ImageType::ImageDimension
 
static constexpr unsigned int ObjectDimension = TInputSpatialObject::ObjectDimension
 
static constexpr unsigned int SampleDimension = TSampleDimension
 

Protected Member Functions

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

MatrixType m_CovarianceMatrix
 
ImageConstPointer m_Image
 
ModifiedTimeType m_InternalImageTime
 
ModifiedTimeType m_InternalSpatialObjectTime
 
VectorType m_Mean
 
TimeStamp m_ModifiedTime
 
SizeValueType m_NumberOfPixels
 
SampleType::Pointer m_Sample
 
unsigned int m_SampleDirection
 
SpatialObjectPointer m_SpatialObject
 
AccumulateType m_Sum
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::AccumulateType = typename NumericTraits< PixelType >::AccumulateType
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::ConstPointer = SmartPointer< const Self >
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::ImageConstPointer = typename TInputImage::ConstPointer
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::ImagePointer = typename TInputImage::Pointer
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::ImageType = TInputImage

Type definitions for the input image.

Definition at line 54 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::IndexType = typename TInputImage::IndexType
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::MatrixType = Matrix< double, TSampleDimension, TSampleDimension >
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::PixelType = typename TInputImage::PixelType
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::Pointer = SmartPointer< Self >
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::PointType = typename TInputImage::PointType
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::RegionType = typename TInputImage::RegionType
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SampleType = itk::Statistics::ListSample< VectorType >

Type definitions for the samples

Definition at line 81 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::Self = SpatialObjectToImageStatisticsCalculator

Standard class type aliases.

Definition at line 42 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SizeType = typename RegionType::SizeType
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SpatialObjectConstPointer = typename SpatialObjectType::ConstPointer
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SpatialObjectPointer = typename SpatialObjectType::Pointer
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SpatialObjectType = TInputSpatialObject

Type definitions for the input spatial object.

Definition at line 72 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::Superclass = Object
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
using itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::VectorType = Vector< double, TSampleDimension >

Vector and Matrix Type

Definition at line 77 of file itkSpatialObjectToImageStatisticsCalculator.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SpatialObjectToImageStatisticsCalculator ( )
protected
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::~SpatialObjectToImageStatisticsCalculator ( )
overrideprotecteddefault

Member Function Documentation

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
bool itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::ComputeStatistics ( )
protected
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
virtual::itk::LightObject::Pointer itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::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 TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
const MatrixType& itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::GetCovarianceMatrix ( ) const
inline

Get the covariance matrix

Definition at line 98 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
const VectorType& itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::GetMean ( ) const
inline

Get the mean

Definition at line 95 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
virtual const char* itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::Object.

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
virtual SizeValueType itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::GetNumberOfPixels ( ) const
virtual

Get the number of pixels inside the object

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
virtual unsigned int itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::GetSampleDirection ( ) const
virtual

Set/Get the direction of the sample

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
AccumulateType itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::GetSum ( ) const
inline

Get the sum of pixels

Definition at line 101 of file itkSpatialObjectToImageStatisticsCalculator.h.

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
static Pointer itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
void itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::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 TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
virtual void itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SetImage ( const ImageType _arg)
virtual

Set the input image.

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
virtual void itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SetSampleDirection ( unsigned int  _arg)
virtual

Set/Get the direction of the sample

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
virtual void itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SetSpatialObject ( SpatialObjectType _arg)
virtual

Set the input spatial object.

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
void itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::Update ( )

Compute of the input image.

Member Data Documentation

template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
constexpr unsigned int itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::ImageDimension = ImageType::ImageDimension
static
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
MatrixType itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::m_CovarianceMatrix
private
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
ImageConstPointer itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::m_Image
private
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
ModifiedTimeType itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::m_InternalImageTime
private
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
ModifiedTimeType itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::m_InternalSpatialObjectTime
private
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
VectorType itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::m_Mean
private
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
TimeStamp itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::m_ModifiedTime
private
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
SizeValueType itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::m_NumberOfPixels
private
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
SampleType::Pointer itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::m_Sample
private
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
unsigned int itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::m_SampleDirection
private
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
SpatialObjectPointer itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::m_SpatialObject
private
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
AccumulateType itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::m_Sum
private
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
constexpr unsigned int itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::ObjectDimension = TInputSpatialObject::ObjectDimension
static
template<typename TInputImage , typename TInputSpatialObject , unsigned int TSampleDimension = 1>
constexpr unsigned int itk::SpatialObjectToImageStatisticsCalculator< TInputImage, TInputSpatialObject, TSampleDimension >::SampleDimension = TSampleDimension
static

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