ITK  6.0.0
Insight Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType > Class Template Reference
Data Processing Objects » Functions » Image Functions | Group Core » Module ITKImageFunction

#include <itkCentralDifferenceImageFunction.h>

Detailed Description

template<typename TInputImage, typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
class itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >

Calculate the derivative by central differencing.

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

This class supports both scalar and vector pixel types for the input image, including VectorImage types.

For vector-pixel image types, the TOutputType template parameter must be set to a vector of appropriate size, to accommodate a result for each pixel component in each dimension. The output is packed by pixel component, i.e.

[C0D0, C0D1, ..., C0DN, C1D0, ...]

where C = pixel component, and D = image dimension.

The output type can be, for example: 

\code CovariantVector<double, numberOfPixelComponents * ImageDimension> \endcode

or

Matrix<double, numberOfPixelComponents, ImageDimension>

Possible improvements:

1) speed performance: The template-specialization of the Evaluate*() methods (needed to support vector-pixel types) incur a performance penalty for the scalar-pixel case, when compared with previous scalar-only versions of the code. On MacOS (2.4GHz Core 2 Duo, gcc 4.2) the penalty is 0.5-2%, depending on the method. To recover this loss, the specialization of the methods would have to be done such that a nested subroutine need not be called, ie the specialization is performed on the Evaluate* methods directly. At the moment is seems this can't be done without requiring a template parameter on the methods.

2) the use of Neighborhood operators may improve efficiency.

Definition at line 76 of file itkCentralDifferenceImageFunction.h.

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

Classes

struct  OutputTypeSpecializationStructType
 

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputImageType = TInputImage
 
using InputPixelConvertType = DefaultConvertPixelTraits< InputPixelType >
 
using InputPixelType = typename InputImageType::PixelType
 
using InterpolatorPointer = typename InterpolatorType::Pointer
 
using InterpolatorType = InterpolateImageFunction< TInputImage, TCoordRep >
 
using OutputConvertType = DefaultConvertPixelTraits< OutputType >
 
using OutputValueType = typename OutputConvertType::ComponentType
 
using Pointer = SmartPointer< Self >
 
using ScalarDerivativeType = CovariantVector< OutputValueType, Self::ImageDimension >
 
using Self = CentralDifferenceImageFunction
 
using SpacingType = typename TInputImage::SpacingType
 
using Superclass = ImageFunction< TInputImage, TOutputType, TCoordRep >
 
- Public Types inherited from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, float >
using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = ContinuousIndex< float, Self::ImageDimension >
 
using CoordRepType = float
 
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 = CovariantVector< double, TInputImage::ImageDimension >
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< float, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< float, Self::ImageDimension >, CovariantVector< double, TInputImage::ImageDimension > >
 
- Public Types inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, CovariantVector< double, TInputImage::ImageDimension > >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< float, TInputImage::ImageDimension >
 
using OutputType = CovariantVector< double, 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

OutputType Evaluate (const PointType &point) const override
 
OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &cindex) const override
 
OutputType EvaluateAtIndex (const IndexType &index) const override
 
virtual InterpolatorType * GetModifiableInterpolator ()
 
const char * GetNameOfClass () const override
 
void SetInputImage (const TInputImage *inputData) override
 
virtual void SetInterpolator (InterpolatorType *interpolator)
 
virtual void SetUseImageDirection (bool _arg)
 
virtual bool GetUseImageDirection () const
 
virtual void UseImageDirectionOn ()
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, float >
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
OutputType Evaluate (const PointType &point) const override=0
 
virtual CovariantVector< double, TInputImage::ImageDimension > EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0
 
virtual CovariantVector< double, TInputImage::ImageDimension > EvaluateAtIndex (const IndexType &index) const=0
 
virtual const ContinuousIndexType & GetEndContinuousIndex () const
 
virtual const IndexType & GetEndIndex () const
 
const InputImageType * GetInputImage () const
 
const char * GetNameOfClass () const override
 
virtual const ContinuousIndexType & GetStartContinuousIndex () const
 
virtual const IndexType & GetStartIndex () 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
 
virtual OutputType Evaluate (const InputType &input) const=0
 
const char * GetNameOfClass () const override
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () 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) const
 
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
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, float >
static constexpr unsigned int ImageDimension
 

Protected Member Functions

 CentralDifferenceImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~CentralDifferenceImageFunction () override=default
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, float >
 ImageFunction ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageFunction () override=default
 
- Protected Member Functions inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, CovariantVector< double, TInputImage::ImageDimension > >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~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 PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Member Functions

template<typename Type >
void EvaluateAtContinuousIndexSpecialized (const ContinuousIndexType &cindex, OutputType &derivative, OutputTypeSpecializationStructType< Type >) const
 
template<typename Type >
void EvaluateAtContinuousIndexSpecialized (const ContinuousIndexType &cindex, OutputType &orientedDerivative, OutputTypeSpecializationStructType< OutputType >) const
 
template<typename Type >
void EvaluateAtIndexSpecialized (const IndexType &index, OutputType &derivative, OutputTypeSpecializationStructType< Type >) const
 
template<typename Type >
void EvaluateAtIndexSpecialized (const IndexType &index, OutputType &orientedDerivative, OutputTypeSpecializationStructType< OutputType >) const
 
template<typename Type >
void EvaluateSpecialized (const PointType &point, OutputType &derivative, OutputTypeSpecializationStructType< Type >) const
 
template<typename Type >
void EvaluateSpecialized (const PointType &point, OutputType &orientedDerivative, OutputTypeSpecializationStructType< OutputType >) const
 

Private Attributes

InterpolatorPointer m_Interpolator {}
 
bool m_UseImageDirection { true }
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, float >
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

◆ ConstPointer

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::ConstPointer = SmartPointer<const Self>

Definition at line 88 of file itkCentralDifferenceImageFunction.h.

◆ InputImageType

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::InputImageType = TInputImage

InputImageType type alias support

Definition at line 97 of file itkCentralDifferenceImageFunction.h.

◆ InputPixelConvertType

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::InputPixelConvertType = DefaultConvertPixelTraits<InputPixelType>

InputPixelConvert type alias support

Definition at line 103 of file itkCentralDifferenceImageFunction.h.

◆ InputPixelType

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::InputPixelType = typename InputImageType::PixelType

InputPixelType type alias support

Definition at line 100 of file itkCentralDifferenceImageFunction.h.

◆ InterpolatorPointer

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::InterpolatorPointer = typename InterpolatorType::Pointer

Definition at line 131 of file itkCentralDifferenceImageFunction.h.

◆ InterpolatorType

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::InterpolatorType = InterpolateImageFunction<TInputImage, TCoordRep>

Interpolator type alias support

Definition at line 130 of file itkCentralDifferenceImageFunction.h.

◆ OutputConvertType

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::OutputConvertType = DefaultConvertPixelTraits<OutputType>

Output convert type alias support

Definition at line 109 of file itkCentralDifferenceImageFunction.h.

◆ OutputValueType

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::OutputValueType = typename OutputConvertType::ComponentType

Output value type alias support

Definition at line 112 of file itkCentralDifferenceImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::Pointer = SmartPointer<Self>

Definition at line 87 of file itkCentralDifferenceImageFunction.h.

◆ ScalarDerivativeType

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::ScalarDerivativeType = CovariantVector<OutputValueType, Self::ImageDimension>

Scalar derivative type alias support

Definition at line 115 of file itkCentralDifferenceImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::Self = CentralDifferenceImageFunction

Standard class type aliases.

Definition at line 85 of file itkCentralDifferenceImageFunction.h.

◆ SpacingType

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::SpacingType = typename TInputImage::SpacingType

Spacing type alias support

Definition at line 127 of file itkCentralDifferenceImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
using itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::Superclass = ImageFunction<TInputImage, TOutputType, TCoordRep>

Definition at line 86 of file itkCentralDifferenceImageFunction.h.

Constructor & Destructor Documentation

◆ CentralDifferenceImageFunction()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::CentralDifferenceImageFunction ( )
protected

◆ ~CentralDifferenceImageFunction()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::~CentralDifferenceImageFunction ( )
overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
OutputType itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::Evaluate ( const PointType &  point) const
overridevirtual

Evaluate the image derivative by central differencing at non-integer point.

No bounds checking is done. The point is assumed to lie within the image buffer. If not, 0 is returned for the derivative without any error return, because of bounds-checking performed on the neighboring points.

If point lies on a boundary in a given dimension, 0 is returned for that dimension. Note that points are centered on the voxel.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Implements itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, float >.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
OutputType itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateAtContinuousIndex ( const ContinuousIndexType &  cindex) const
overridevirtual

Evaluate the image derivative by central differencing at non-integer index.

No bounds checking is done. The point is assumed to lie within the image buffer.

If cindex lies on a boundary in a given dimension, 0 is returned for that dimension.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Implements itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, float >.

◆ EvaluateAtContinuousIndexSpecialized() [1/2]

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
template<typename Type >
void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateAtContinuousIndexSpecialized ( const ContinuousIndexType &  cindex,
OutputType &  derivative,
OutputTypeSpecializationStructType< Type >   
) const
inlineprivate

Specialized version of EvaluateAtContinuousIndex() method to handle vector pixel types.

◆ EvaluateAtContinuousIndexSpecialized() [2/2]

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
template<typename Type >
void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateAtContinuousIndexSpecialized ( const ContinuousIndexType &  cindex,
OutputType &  orientedDerivative,
OutputTypeSpecializationStructType< OutputType >   
) const
inlineprivate

Specialized version of EvaluateAtContinuousIndex() method to handle scalar pixel types.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
OutputType itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateAtIndex ( const IndexType &  index) const
overridevirtual

Evaluate the image derivative by central differencing at specified index.

No bounds checking is done. The point is assumed to lie within the image buffer.

If index lies on a boundary in a given dimension, 0 is returned for that dimension.

ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Implements itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, float >.

◆ EvaluateAtIndexSpecialized() [1/2]

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
template<typename Type >
void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateAtIndexSpecialized ( const IndexType &  index,
OutputType &  derivative,
OutputTypeSpecializationStructType< Type >   
) const
inlineprivate

Specialized version of EvaluateAtIndex() method to handle vector pixel types.

◆ EvaluateAtIndexSpecialized() [2/2]

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
template<typename Type >
void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateAtIndexSpecialized ( const IndexType &  index,
OutputType &  orientedDerivative,
OutputTypeSpecializationStructType< OutputType >   
) const
inlineprivate

Specialized version of EvaluateAtIndex() method to handle scalar pixel types.

◆ EvaluateSpecialized() [1/2]

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
template<typename Type >
void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateSpecialized ( const PointType &  point,
OutputType &  derivative,
OutputTypeSpecializationStructType< Type >   
) const
private

Specialized version of Evaluate() method to handle vector pixel types.

◆ EvaluateSpecialized() [2/2]

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
template<typename Type >
void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::EvaluateSpecialized ( const PointType &  point,
OutputType &  orientedDerivative,
OutputTypeSpecializationStructType< OutputType >   
) const
private

Specialized version of Evaluate() method to handle scalar pixel types.

◆ GetModifiableInterpolator()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
virtual InterpolatorType * itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::GetModifiableInterpolator ( )
virtual

Get the interpolator.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
const char * itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ GetUseImageDirection()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
virtual bool itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::GetUseImageDirection ( ) const
virtual

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. For EvaluateAtIndex and EvaluateAtContinuousIndex, the flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. For Evaluate, the opposite is true: the flag OFF will ignore the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is ON. The default value of this flag is On.

◆ New()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
static Pointer itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::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.

◆ SetInputImage()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::SetInputImage ( const TInputImage *  inputData)
overridevirtual

Set the input image. This must be set by the user.

Reimplemented from itk::ImageFunction< TInputImage, CovariantVector< double, TInputImage::ImageDimension >, float >.

◆ SetInterpolator()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
virtual void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::SetInterpolator ( InterpolatorType *  interpolator)
virtual

Set interpolator. The interpolator is used in the methods Evaluate and EvaluateAtContinuousIndex.

◆ SetUseImageDirection()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
virtual void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::SetUseImageDirection ( bool  _arg)
virtual

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. For EvaluateAtIndex and EvaluateAtContinuousIndex, the flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. For Evaluate, the opposite is true: the flag OFF will ignore the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is ON. The default value of this flag is On.

◆ UseImageDirectionOn()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
virtual void itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::UseImageDirectionOn ( )
virtual

The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. For EvaluateAtIndex and EvaluateAtContinuousIndex, the flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. For Evaluate, the opposite is true: the flag OFF will ignore the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is ON. The default value of this flag is On.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
constexpr unsigned int itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

Dimension underlying input image.

Definition at line 82 of file itkCentralDifferenceImageFunction.h.

◆ m_Interpolator

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
InterpolatorPointer itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::m_Interpolator {}
private

Definition at line 267 of file itkCentralDifferenceImageFunction.h.

◆ m_UseImageDirection

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
bool itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::m_UseImageDirection { true }
private

Definition at line 264 of file itkCentralDifferenceImageFunction.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3