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::GaussianDerivativeImageFunction< TInputImage, TOutput > Class Template Reference

#include <itkGaussianDerivativeImageFunction.h>

+ Inheritance diagram for itk::GaussianDerivativeImageFunction< TInputImage, TOutput >:
+ Collaboration diagram for itk::GaussianDerivativeImageFunction< TInputImage, TOutput >:

Detailed Description

template<typename TInputImage, typename TOutput = double>
class itk::GaussianDerivativeImageFunction< TInputImage, TOutput >

Compute the Gaussian derivatives of an the image at a specific location in space, i.e. point, index or continuous index.

Note
From ITK 5, the Evaluate member functions of this class are concurrent thread safe: It is safe to have multiple simultaneous Evaluate calls on a GaussianDerivativeImageFunction object.

This class is templated over the input image type.

See Also
NeighborhoodOperator
ImageFunction

Definition at line 50 of file itkGaussianDerivativeImageFunction.h.

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< SpacePrecisionType, Self::ImageDimension >
 
using GaussianDerivativeSpatialFunctionPointer = typename GaussianDerivativeSpatialFunctionType::Pointer
 
using GaussianDerivativeSpatialFunctionType = GaussianDerivativeSpatialFunction< TOutput, 1 >
 
using IndexType = typename InputImageType::IndexType
 
using InputImageType = TInputImage
 
using InputPixelType = typename InputImageType::PixelType
 
using NeighborhoodType = Neighborhood< InputPixelType, Self::ImageDimension >
 
using OperatorArrayType = FixedArray< OperatorNeighborhoodType, Self::ImageDimension >
 
using OperatorNeighborhoodType = Neighborhood< TOutput, Self::ImageDimension >
 
using OutputType = typename Superclass::OutputType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename InputImageType::PointType
 
using Self = GaussianDerivativeImageFunction
 
using Superclass = ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >
 
using VectorType = Vector< TOutput, Self::ImageDimension >
 
- Public Types inherited from itk::ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< TOutput, Self::ImageDimension >
 
using CoordRepType = TOutput
 
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 = Vector< TOutput, TInputImage::ImageDimension >
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< TOutput, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TOutput, Self::ImageDimension >, Vector< TOutput, TInputImage::ImageDimension > >
 
- Public Types inherited from itk::FunctionBase< Point< TOutput, TInputImage::ImageDimension >, Vector< TOutput, TInputImage::ImageDimension > >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TOutput, TInputImage::ImageDimension >
 
using OutputType = Vector< TOutput, TInputImage::ImageDimension >
 
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
 
OutputType Evaluate (const PointType &point) const override
 
OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override
 
OutputType EvaluateAtIndex (const IndexType &index) const override
 
const double * GetExtent () const
 
virtual const char * GetNameOfClass () const
 
const double * GetSigma () const
 
void SetExtent (const double *extent)
 
void SetExtent (const double extent)
 
void SetInputImage (const InputImageType *ptr) override
 
void SetSigma (const double *sigma)
 
void SetSigma (const double sigma)
 
void SetUseImageSpacing (const bool val)
 
virtual void UseImageSpacingOn ()
 
virtual void UseImageSpacingOff ()
 
virtual bool GetUseImageSpacing ()
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
Vector< TOutput,
TInputImage::ImageDimension > 
Evaluate (const PointType &point) const override=0
 
virtual Vector< TOutput,
TInputImage::ImageDimension > 
EvaluateAtContinuousIndex (const ContinuousIndexType &index) const =0
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
const InputImageTypeGetInputImage () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const IndexTypeGetStartIndex () const
 
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::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 = InputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >
static constexpr unsigned int ImageDimension
 

Protected Member Functions

 GaussianDerivativeImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void RecomputeGaussianKernel ()
 
 ~GaussianDerivativeImageFunction () override=default
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFunction () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TOutput, TInputImage::ImageDimension >, Vector< TOutput, TInputImage::ImageDimension > >
 FunctionBase ()=default
 
 ~FunctionBase () 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

double m_Extent [ImageDimension]
 
const
GaussianDerivativeSpatialFunctionPointer 
m_GaussianDerivativeSpatialFunction
 
std::vector< Offset
< ImageDimension > > 
m_ImageNeighborhoodOffsets [ImageDimension]
 
OperatorArrayType m_OperatorArray
 
double m_Sigma [ImageDimension]
 
bool m_UseImageSpacing { true }
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >
ContinuousIndexType m_EndContinuousIndex
 
IndexType m_EndIndex
 
InputImageConstPointer m_Image
 
ContinuousIndexType m_StartContinuousIndex
 
IndexType m_StartIndex
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::ConstPointer = SmartPointer< const Self >

Definition at line 64 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::ContinuousIndexType = ContinuousIndex< SpacePrecisionType, Self::ImageDimension >

Definition at line 85 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GaussianDerivativeSpatialFunctionPointer = typename GaussianDerivativeSpatialFunctionType::Pointer

Definition at line 95 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GaussianDerivativeSpatialFunctionType = GaussianDerivativeSpatialFunction< TOutput, 1 >

Definition at line 94 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::IndexType = typename InputImageType::IndexType

Definition at line 75 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::InputImageType = TInputImage

InputImageType type alias support

Definition at line 73 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::InputPixelType = typename InputImageType::PixelType

Definition at line 74 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::NeighborhoodType = Neighborhood< InputPixelType, Self::ImageDimension >

Definition at line 87 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::OperatorArrayType = FixedArray< OperatorNeighborhoodType, Self::ImageDimension >

Definition at line 92 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::OperatorNeighborhoodType = Neighborhood< TOutput, Self::ImageDimension >

Definition at line 88 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::OutputType = typename Superclass::OutputType

Definition at line 91 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::Pointer = SmartPointer< Self >

Definition at line 63 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::PointType = typename InputImageType::PointType

Point type alias support

Definition at line 104 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::Self = GaussianDerivativeImageFunction

Standard class type aliases.

Definition at line 59 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::Superclass = ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >

Definition at line 62 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
using itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::VectorType = Vector< TOutput, Self::ImageDimension >

Definition at line 90 of file itkGaussianDerivativeImageFunction.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutput = double>
itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GaussianDerivativeImageFunction ( )
protected
template<typename TInputImage , typename TOutput = double>
itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::~GaussianDerivativeImageFunction ( )
overrideprotecteddefault

Member Function Documentation

template<typename TInputImage , typename TOutput = double>
virtual::itk::LightObject::Pointer itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::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 TOutput = double>
OutputType itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::Evaluate ( const PointType point) const
override

Evaluate the function at the specified point.

template<typename TInputImage , typename TOutput = double>
OutputType itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::EvaluateAtContinuousIndex ( const ContinuousIndexType index) const
override

Evaluate the function at specified ContinuousIndex position.

template<typename TInputImage , typename TOutput = double>
OutputType itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::EvaluateAtIndex ( const IndexType index) const
overridevirtual
template<typename TInputImage , typename TOutput = double>
const double* itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GetExtent ( ) const
inline

Definition at line 148 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
virtual const char* itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >.

template<typename TInputImage , typename TOutput = double>
const double* itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GetSigma ( ) const
inline

Definition at line 141 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
virtual bool itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::GetUseImageSpacing ( )
virtual

UseImageSpacing controls the extent of the computations. Set UseImageSpacing to true to set the units to physical units of the image. Set UseImageSpacing to false to set the units of pixels.

template<typename TInputImage , typename TOutput = double>
static Pointer itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::New ( )
static

Method for creation through the object factory.

template<typename TInputImage , typename TOutput = double>
void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::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 TOutput = double>
void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel ( )
protected

Recompute the Gaussian kernel used to evaluate indexes. This should use a fastest Derivative Gaussian operator.

template<typename TInputImage , typename TOutput = double>
void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::SetExtent ( const double *  extent)

Set the extent of the discrete Gaussian kernel.

template<typename TInputImage , typename TOutput = double>
void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::SetExtent ( const double  extent)
template<typename TInputImage , typename TOutput = double>
void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::SetInputImage ( const InputImageType ptr)
overridevirtual

Set the input image.

Warning
this method caches BufferedRegion information. If the BufferedRegion has changed, user must call SetInputImage again to update cached values.

Reimplemented from itk::ImageFunction< TInputImage, Vector< TOutput, TInputImage::ImageDimension >, TOutput >.

template<typename TInputImage , typename TOutput = double>
void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::SetSigma ( const double *  sigma)

The variance for the discrete Gaussian kernel. Sets the variance independently for each dimension, but see also SetVariance(const double v). The default is 0.0 in each dimension. The extent of the kernel is controlled by UseImageSpacing.

template<typename TInputImage , typename TOutput = double>
void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::SetSigma ( const double  sigma)
template<typename TInputImage , typename TOutput = double>
void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::SetUseImageSpacing ( const bool  val)
inline

UseImageSpacing controls the extent of the computations. Set UseImageSpacing to true to set the units to physical units of the image. Set UseImageSpacing to false to set the units of pixels.

Definition at line 120 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
virtual void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::UseImageSpacingOff ( )
virtual

UseImageSpacing controls the extent of the computations. Set UseImageSpacing to true to set the units to physical units of the image. Set UseImageSpacing to false to set the units of pixels.

template<typename TInputImage , typename TOutput = double>
virtual void itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::UseImageSpacingOn ( )
virtual

UseImageSpacing controls the extent of the computations. Set UseImageSpacing to true to set the units to physical units of the image. Set UseImageSpacing to false to set the units of pixels.

Member Data Documentation

template<typename TInputImage , typename TOutput = double>
constexpr unsigned int itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::ImageDimension = InputImageType::ImageDimension
static

Dimension of the underlying image.

Definition at line 78 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
double itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::m_Extent[ImageDimension]
private

Definition at line 177 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
const GaussianDerivativeSpatialFunctionPointer itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::m_GaussianDerivativeSpatialFunction
private
template<typename TInputImage , typename TOutput = double>
std::vector<Offset<ImageDimension> > itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::m_ImageNeighborhoodOffsets[ImageDimension]
private

Definition at line 175 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
OperatorArrayType itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::m_OperatorArray
private

Array of 1D operators. Contains a derivative kernel for each dimension. Note: A future version of ITK could extend this array to include a Gaussian blurring kernel for each dimension.

Definition at line 173 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
double itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::m_Sigma[ImageDimension]
private

Definition at line 168 of file itkGaussianDerivativeImageFunction.h.

template<typename TInputImage , typename TOutput = double>
bool itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::m_UseImageSpacing { true }
private

Flag to indicate whether to use image spacing.

Definition at line 180 of file itkGaussianDerivativeImageFunction.h.


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