ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public 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 >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = typename Superclass::ContinuousIndexType
 
using IndexType = typename Superclass::IndexType
 
using InputImageType = TInputImage
 
using OutputType = typename Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename Superclass::PointType
 
using RealType = vnl_matrix< typename NumericTraits< typename InputImageType::PixelType::ValueType >::RealType >
 
using Self = ScatterMatrixImageFunction
 
using Superclass = ImageFunction< TInputImage, vnl_matrix< typename NumericTraits< typename TInputImage::PixelType::ValueType >::RealType >, TCoordRep >
 
- Public Types inherited from itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, TCoordRep >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< TCoordRep, Self::ImageDimension >
 
using CoordRepType = TCoordRep
 
using IndexType = typename InputImageType::IndexType
 
using IndexValueType = typename InputImageType::IndexValueType
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImageType = TInputImage
 
using InputPixelType = typename InputImageType::PixelType
 
using OutputType = vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< TCoordRep, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType > >
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType > >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TCoordRep, TInputImage::ImageDimension >
 
using OutputType = vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >
 
using Pointer = SmartPointer< Self >
 
using Self = FunctionBase
 
using Superclass = Object
 
- 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
 
RealType Evaluate (const PointType &point) const override
 
RealType EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
 
RealType EvaluateAtIndex (const IndexType &index) const override
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, TCoordRep >
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
 
const InputImageTypeGetInputImage () 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
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
virtual const IndexTypeGetStartIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () 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 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 = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, TCoordRep >
static constexpr unsigned int ImageDimension
 
unsigned int m_NeighborhoodRadius
 
virtual void SetNeighborhoodRadius (unsigned int _arg)
 
virtual const unsigned int & GetNeighborhoodRadius () const
 
 ScatterMatrixImageFunction ()
 
 ~ScatterMatrixImageFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, TCoordRep >
 ImageFunction ()
 
 ~ImageFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType > >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- 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::ImageFunction< TInputImage, vnl_matrix< NumericTraits< TInputImage::PixelType::ValueType >::RealType >, TCoordRep >
InputImageConstPointer m_Image
 
IndexType m_StartIndex
 
IndexType m_EndIndex
 
ContinuousIndexType m_StartContinuousIndex
 
ContinuousIndexType m_EndContinuousIndex
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 61 of file itkScatterMatrixImageFunction.h.

◆ ContinuousIndexType

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

ContinuousIndex type alias support

Definition at line 79 of file itkScatterMatrixImageFunction.h.

◆ IndexType

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

Index type alias support

Definition at line 76 of file itkScatterMatrixImageFunction.h.

◆ InputImageType

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

InputImageType type alias support

Definition at line 70 of file itkScatterMatrixImageFunction.h.

◆ OutputType

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

OutputType typdef support.

Definition at line 73 of file itkScatterMatrixImageFunction.h.

◆ Pointer

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

Definition at line 60 of file itkScatterMatrixImageFunction.h.

◆ PointType

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

Point type alias support

Definition at line 82 of file itkScatterMatrixImageFunction.h.

◆ RealType

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

Datatype used for the covariance matrix

Definition at line 88 of file itkScatterMatrixImageFunction.h.

◆ Self

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

Standard class type aliases.

Definition at line 54 of file itkScatterMatrixImageFunction.h.

◆ Superclass

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

Definition at line 58 of file itkScatterMatrixImageFunction.h.

Constructor & Destructor Documentation

◆ ScatterMatrixImageFunction()

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

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

◆ ~ScatterMatrixImageFunction()

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

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

Member Function Documentation

◆ CreateAnother()

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.

◆ Evaluate()

template<typename TInputImage , typename TCoordRep = float>
RealType itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType point) const
inlineoverride

Evaluate the function at non-integer positions

Definition at line 96 of file itkScatterMatrixImageFunction.h.

◆ EvaluateAtContinuousIndex()

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

Definition at line 105 of file itkScatterMatrixImageFunction.h.

◆ EvaluateAtIndex()

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

Evalulate the function at specified index

◆ GetNameOfClass()

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

◆ GetNeighborhoodRadius()

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

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TCoordRep = float>
void itk::ScatterMatrixImageFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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

Reimplemented from itk::Object.

◆ SetNeighborhoodRadius()

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

◆ ImageDimension

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

Dimension of the underlying image.

Definition at line 85 of file itkScatterMatrixImageFunction.h.

◆ m_NeighborhoodRadius

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

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

Definition at line 126 of file itkScatterMatrixImageFunction.h.


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