ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
itk::SumOfSquaresImageFunction< TInputImage, TCoordRep > Class Template Reference

#include <itkSumOfSquaresImageFunction.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = typename Superclass::ContinuousIndexType
 
using ImageSizeType = typename InputImageType::SizeType
 
using IndexType = typename Superclass::IndexType
 
using InputImageType = TInputImage
 
using OutputType = typename Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename Superclass::PointType
 
using RealType = typename NumericTraits< typename InputImageType::PixelType >::RealType
 
using Self = SumOfSquaresImageFunction
 
using Superclass = ImageFunction< TInputImage, typename NumericTraits< typename TInputImage::PixelType >::RealType, TCoordRep >
 
- Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::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 = NumericTraits< TInputImage::PixelType >::RealType
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< TCoordRep, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TCoordRep, TInputImage::ImageDimension >
 
using OutputType = NumericTraits< TInputImage::PixelType >::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
 
virtual const unsigned int & GetNeighborhoodRadius () const
 
virtual const unsigned int & GetNeighborhoodSize () const
 
void SetNeighborhoodRadius (unsigned int radius)
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
NumericTraits< TInputImage::PixelType >::RealType Evaluate (const PointType &point) const override=0
 
virtual NumericTraits< TInputImage::PixelType >::RealType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0
 
virtual NumericTraits< TInputImage::PixelType >::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
 
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 = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
static constexpr unsigned int ImageDimension
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 SumOfSquaresImageFunction ()
 
 ~SumOfSquaresImageFunction () override=default
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::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 >, NumericTraits< TInputImage::PixelType >::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 ()
 

Private Attributes

std::vector< Offset< ImageDimension > > m_NeighborhoodOffsets
 
unsigned int m_NeighborhoodRadius
 
unsigned int m_NeighborhoodSize
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::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::SumOfSquaresImageFunction< TInputImage, TCoordRep >

Calculate the sum of squares in the neighborhood of a pixel.

Calculate the sum of squares of the pixel values 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 ).

Definition at line 47 of file itkSumOfSquaresImageFunction.h.

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 59 of file itkSumOfSquaresImageFunction.h.

◆ ContinuousIndexType

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

ContinuousIndex type alias support

Definition at line 80 of file itkSumOfSquaresImageFunction.h.

◆ ImageSizeType

template<typename TInputImage , typename TCoordRep = float>
using itk::SumOfSquaresImageFunction< TInputImage, TCoordRep >::ImageSizeType = typename InputImageType::SizeType

Size type of the underlying image.

Definition at line 86 of file itkSumOfSquaresImageFunction.h.

◆ IndexType

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

Index type alias support

Definition at line 77 of file itkSumOfSquaresImageFunction.h.

◆ InputImageType

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

InputImageType type alias support

Definition at line 68 of file itkSumOfSquaresImageFunction.h.

◆ OutputType

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

OutputType typdef support.

Definition at line 74 of file itkSumOfSquaresImageFunction.h.

◆ Pointer

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

Definition at line 58 of file itkSumOfSquaresImageFunction.h.

◆ PointType

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

Point type alias support

Definition at line 83 of file itkSumOfSquaresImageFunction.h.

◆ RealType

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

Datatype used for the variance

Definition at line 92 of file itkSumOfSquaresImageFunction.h.

◆ Self

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

Standard class type aliases.

Definition at line 54 of file itkSumOfSquaresImageFunction.h.

◆ Superclass

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

Definition at line 56 of file itkSumOfSquaresImageFunction.h.

Constructor & Destructor Documentation

◆ SumOfSquaresImageFunction()

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

◆ ~SumOfSquaresImageFunction()

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

Member Function Documentation

◆ CreateAnother()

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

Evaluate the function at non-integer positions

Definition at line 100 of file itkSumOfSquaresImageFunction.h.

◆ EvaluateAtContinuousIndex()

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

Definition at line 109 of file itkSumOfSquaresImageFunction.h.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordRep = float>
RealType itk::SumOfSquaresImageFunction< 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::SumOfSquaresImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >.

◆ GetNeighborhoodRadius()

template<typename TInputImage , typename TCoordRep = float>
virtual const unsigned int& itk::SumOfSquaresImageFunction< TInputImage, TCoordRep >::GetNeighborhoodRadius ( ) const
virtual

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

◆ GetNeighborhoodSize()

template<typename TInputImage , typename TCoordRep = float>
virtual const unsigned int& itk::SumOfSquaresImageFunction< TInputImage, TCoordRep >::GetNeighborhoodSize ( ) const
virtual

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TCoordRep = float>
void itk::SumOfSquaresImageFunction< 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.

◆ SetNeighborhoodRadius()

template<typename TInputImage , typename TCoordRep = float>
void itk::SumOfSquaresImageFunction< TInputImage, TCoordRep >::SetNeighborhoodRadius ( unsigned int  radius)
inline

Member Data Documentation

◆ ImageDimension

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

Dimension of the underlying image.

Definition at line 89 of file itkSumOfSquaresImageFunction.h.

◆ m_NeighborhoodOffsets

template<typename TInputImage , typename TCoordRep = float>
std::vector<Offset<ImageDimension> > itk::SumOfSquaresImageFunction< TInputImage, TCoordRep >::m_NeighborhoodOffsets
private
Initial value:
ImageSizeType::Filled(1)) }

Definition at line 141 of file itkSumOfSquaresImageFunction.h.

◆ m_NeighborhoodRadius

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

Definition at line 138 of file itkSumOfSquaresImageFunction.h.

◆ m_NeighborhoodSize

template<typename TInputImage , typename TCoordRep = float>
unsigned int itk::SumOfSquaresImageFunction< TInputImage, TCoordRep >::m_NeighborhoodSize
private

Definition at line 139 of file itkSumOfSquaresImageFunction.h.


The documentation for this class was generated from the following file:
itk::GenerateRectangularImageNeighborhoodOffsets
std::vector< Offset< VImageDimension > > GenerateRectangularImageNeighborhoodOffsets(const Size< VImageDimension > &radius)
Definition: itkImageNeighborhoodOffsets.h:43