ITK  4.13.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::ScatterMatrixImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <itkScatterMatrixImageFunction.h>

+ Inheritance diagram for itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >:
+ Collaboration diagram for itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >:

Detailed Description

template<typename TInputImage, typename TCoordRep = float>
class itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >

Calculate the scatter matrix in the neighborhood of a pixel in a Vector image.

Calculate the covariance matrix over the standard 8, 26, etc. connected neighborhood. This calculation uses a ZeroFluxNeumannBoundaryCondition.

If called with a ContinuousIndex or Point, the calculation is performed at the nearest neighbor.

This class is templated over the input image type and the coordinate representation type (e.g. float or double).

See Also
VectorMeanImageFunction

Definition at line 45 of file itkScatterMatrixImageFunction.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
Superclass::ContinuousIndexType 
ContinuousIndexType
 
typedef Superclass::IndexType IndexType
 
typedef TInputImage InputImageType
 
typedef Superclass::OutputType OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef vnl_matrix< typename
NumericTraits< typename
InputImageType::PixelType::ValueType >
::RealType
RealType
 
typedef ScatterMatrixImageFunction Self
 
typedef ImageFunction
< TInputImage, vnl_matrix
< typename NumericTraits
< typename
TInputImage::PixelType::ValueType >
::RealType >, TCoordRep > 
Superclass
 
- Public Types inherited from itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, TCoordRep >
typedef SmartPointer< const SelfConstPointer
 
typedef ContinuousIndex
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
ContinuousIndexType
 
typedef TCoordRep CoordRepType
 
typedef InputImageType::IndexType IndexType
 
typedef
InputImageType::IndexValueType 
IndexValueType
 
typedef
InputImageType::ConstPointer 
InputImageConstPointer
 
typedef TInputImage InputImageType
 
typedef InputImageType::PixelType InputPixelType
 
typedef vnl_matrix
< NumericTraits
< TInputImage::PixelType::ValueType >
::RealType > 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef Point< TCoordRep,
itkGetStaticConstMacro(ImageDimension) > 
PointType
 
typedef ImageFunction Self
 
typedef FunctionBase< Point
< TCoordRep,
itkGetStaticConstMacro(ImageDimension) >
, vnl_matrix< NumericTraits
< TInputImage::PixelType::ValueType >
::RealType > > 
Superclass
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType > >
typedef SmartPointer< const SelfConstPointer
 
typedef Point< TCoordRep,
TInputImage::ImageDimension > 
InputType
 
typedef vnl_matrix
< NumericTraits
< TInputImage::PixelType::ValueType >
::RealType > 
OutputType
 
typedef SmartPointer< SelfPointer
 
typedef FunctionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual RealType Evaluate (const PointType &point) const override
 
virtual RealType EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
 
virtual RealType EvaluateAtIndex (const IndexType &index) const override
 
virtual const char * GetNameOfClass () const
 
virtual void SetNeighborhoodRadius (unsigned int _arg)
 
virtual const unsigned int & GetNeighborhoodRadius () const
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, TCoordRep >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
virtual vnl_matrix
< NumericTraits
< TInputImage::PixelType::ValueType >
::RealType > 
Evaluate (const PointType &point) const override=0
 
virtual vnl_matrix
< NumericTraits
< TInputImage::PixelType::ValueType >
::RealType > 
EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
 
virtual vnl_matrix
< NumericTraits
< TInputImage::PixelType::ValueType >
::RealType > 
EvaluateAtIndex (const IndexType &index) const =0
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
const InputImageTypeGetInputImage () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const IndexTypeGetStartIndex () const
 
virtual void SetInputImage (const InputImageType *ptr)
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
virtual bool IsInsideBuffer (const PointType &point) const
 
- Public Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType > >
virtual OutputType Evaluate (const InputType &input) const =0
 
- 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
 
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 = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, TCoordRep >
static const unsigned int ImageDimension
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 ScatterMatrixImageFunction ()
 
 ~ScatterMatrixImageFunction () override
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, TCoordRep >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFunction () override
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType > >
 FunctionBase ()
 
 ~FunctionBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~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

unsigned int m_NeighborhoodRadius
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, TCoordRep >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInputImage , typename TCoordRep = float>
typedef SmartPointer< const Self > itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::ConstPointer

Definition at line 61 of file itkScatterMatrixImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef Superclass::ContinuousIndexType itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::ContinuousIndexType

ContinuousIndex typedef support.

Definition at line 79 of file itkScatterMatrixImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef Superclass::IndexType itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::IndexType

Index typedef support.

Definition at line 76 of file itkScatterMatrixImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef TInputImage itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::InputImageType

InputImageType typedef support.

Definition at line 67 of file itkScatterMatrixImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef Superclass::OutputType itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::OutputType

OutputType typdef support.

Definition at line 73 of file itkScatterMatrixImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef SmartPointer< Self > itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::Pointer

Definition at line 60 of file itkScatterMatrixImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef Superclass::PointType itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::PointType

Point typedef support.

Definition at line 82 of file itkScatterMatrixImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef vnl_matrix< typename NumericTraits< typename InputImageType::PixelType::ValueType >::RealType > itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::RealType

Datatype used for the covariance matrix

Definition at line 91 of file itkScatterMatrixImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef ScatterMatrixImageFunction itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::Self

Standard class typedefs.

Definition at line 54 of file itkScatterMatrixImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
typedef ImageFunction< TInputImage, vnl_matrix< typename NumericTraits< typename TInputImage::PixelType::ValueType >::RealType >, TCoordRep > itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::Superclass

Definition at line 58 of file itkScatterMatrixImageFunction.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TCoordRep = float>
itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::ScatterMatrixImageFunction ( )
protected
template<typename TInputImage , typename TCoordRep = float>
itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::~ScatterMatrixImageFunction ( )
inlineoverrideprotected

Definition at line 122 of file itkScatterMatrixImageFunction.h.

Member Function Documentation

template<typename TInputImage , typename TCoordRep = float>
virtual::itk::LightObject::Pointer itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::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 TCoordRep = float>
virtual RealType itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType point) const
inlineoverridevirtual

Evaluate the function at non-integer positions

Definition at line 97 of file itkScatterMatrixImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
virtual RealType itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType cindex) const
inlineoverridevirtual

Definition at line 105 of file itkScatterMatrixImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
virtual RealType itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType index) const
overridevirtual

Evalulate the function at specified index

template<typename TInputImage , typename TCoordRep = float>
virtual const char* itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual
template<typename TInputImage , typename TCoordRep = float>
virtual const unsigned int& itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::GetNeighborhoodRadius ( ) const
virtual

Get/Set the radius of the neighborhood over which the statistics are evaluated

template<typename TInputImage , typename TCoordRep = float>
static Pointer itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage , typename TCoordRep = float>
void itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::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 TCoordRep = float>
virtual void itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::SetNeighborhoodRadius ( unsigned int  _arg)
virtual

Get/Set the radius of the neighborhood over which the statistics are evaluated

Member Data Documentation

template<typename TInputImage , typename TCoordRep = float>
const unsigned int itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::ImageDimension = InputImageType::ImageDimension
static

Dimension of the underlying image.

Definition at line 86 of file itkScatterMatrixImageFunction.h.

template<typename TInputImage , typename TCoordRep = float>
unsigned int itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::m_NeighborhoodRadius
private

Definition at line 126 of file itkScatterMatrixImageFunction.h.


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