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

#include <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 ContinuousIndexType = typename Superclass::ContinuousIndexType
 
using IndexType = typename Superclass::IndexType
 
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 OutputType = typename Superclass::OutputType
 
using OutputValueType = typename OutputConvertType::ComponentType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename Superclass::PointType
 
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, TOutputType, 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 = TOutputType
 
using Pointer = SmartPointer< Self >
 
using PointType = Point< TCoordRep, Self::ImageDimension >
 
using Self = ImageFunction
 
using Superclass = FunctionBase< Point< TCoordRep, Self::ImageDimension >, TOutputType >
 
- Public Types inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, TOutputType >
using ConstPointer = SmartPointer< const Self >
 
using InputType = Point< TCoordRep, TInputImage::ImageDimension >
 
using OutputType = TOutputType
 
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 &cindex) const override
 
OutputType EvaluateAtIndex (const IndexType &index) const override
 
virtual const InterpolatorTypeGetInterpolator () const
 
virtual InterpolatorTypeGetModifiableInterpolator ()
 
virtual const char * GetNameOfClass () const
 
void SetInputImage (const TInputImage *inputData) override
 
virtual void SetInterpolator (InterpolatorType *interpolator)
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, TOutputType, TCoordRep >
TOutputType Evaluate (const PointType &point) const override=0
 
virtual TOutputType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0
 
virtual TOutputType EvaluateAtIndex (const IndexType &index) const=0
 
const InputImageTypeGetInputImage () const
 
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 = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, TOutputType, TCoordRep >
static constexpr unsigned int ImageDimension
 
bool m_UseImageDirection
 
InterpolatorPointer m_Interpolator
 
virtual void SetUseImageDirection (bool _arg)
 
virtual bool GetUseImageDirection () const
 
virtual void UseImageDirectionOn ()
 
virtual void UseImageDirectionOff ()
 
 CentralDifferenceImageFunction ()
 
 ~CentralDifferenceImageFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
template<typename Type >
void EvaluateAtIndexSpecialized (const IndexType &index, OutputType &derivative, OutputTypeSpecializationStructType< OutputType >) const
 
template<typename Type >
void EvaluateAtIndexSpecialized (const IndexType &index, OutputType &derivative, OutputTypeSpecializationStructType< Type >) const
 
template<typename Type >
void EvaluateAtContinuousIndexSpecialized (const ContinuousIndexType &index, OutputType &derivative, OutputTypeSpecializationStructType< OutputType >) const
 
template<typename Type >
void EvaluateAtContinuousIndexSpecialized (const ContinuousIndexType &index, OutputType &derivative, OutputTypeSpecializationStructType< Type >) const
 
template<typename Type >
void EvaluateSpecialized (const PointType &point, OutputType &derivative, OutputTypeSpecializationStructType< OutputType >) const
 
template<typename Type >
void EvaluateSpecialized (const PointType &point, OutputType &derivative, OutputTypeSpecializationStructType< Type >) const
 

Additional Inherited Members

- Protected Member Functions inherited from itk::ImageFunction< TInputImage, TOutputType, 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 >, TOutputType >
 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, TOutputType, 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, 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.

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.

◆ ContinuousIndexType

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

ContinuousIndex type alias support

Definition at line 121 of file itkCentralDifferenceImageFunction.h.

◆ IndexType

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

Index type alias support

Definition at line 118 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.

◆ OutputType

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

OutputType typdef support.

Definition at line 106 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.

◆ PointType

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

Point type alias support

Definition at line 124 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

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.

◆ ~CentralDifferenceImageFunction()

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

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 Function Documentation

◆ CreateAnother()

template<typename TInputImage , typename TCoordRep = float, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
virtual::itk::LightObject::Pointer itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::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, typename TOutputType = CovariantVector<double, TInputImage::ImageDimension>>
OutputType itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::Evaluate ( const PointType point) const
override

Evalulate 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.

◆ EvaluateAtContinuousIndex()

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

Evalulate 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.

◆ 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 index,
OutputType derivative,
OutputTypeSpecializationStructType< OutputType  
) const
inlineprivate

Specialized versions of EvaluteAtContinuousIndex() method to handle scalar or 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 index,
OutputType derivative,
OutputTypeSpecializationStructType< Type >   
) const
inlineprivate

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.

◆ EvaluateAtIndex()

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

Evalulate 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.

◆ 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< OutputType  
) const
inlineprivate

Specialized versions of EvaluteAtIndex() method to handle scalar or 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 derivative,
OutputTypeSpecializationStructType< Type >   
) const
inlineprivate

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.

◆ 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< OutputType  
) const
private

Specialized versions of Evalute() method to handle scalar or 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 derivative,
OutputTypeSpecializationStructType< Type >   
) const
private

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.

◆ GetInterpolator()

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

◆ 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>>
virtual const char* itk::CentralDifferenceImageFunction< TInputImage, TCoordRep, TOutputType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, TOutputType, TCoordRep >.

◆ 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

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.

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, TOutputType, TCoordRep >.

◆ 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.

◆ UseImageDirectionOff()

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

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.

Definition at line 264 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
private

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.

Definition at line 261 of file itkCentralDifferenceImageFunction.h.


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