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

#include <itkVectorInterpolateImageFunction.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = typename Superclass::ContinuousIndexType
 
using CoordRepType = TCoordRep
 
using IndexType = typename Superclass::IndexType
 
using InputImageType = typename Superclass::InputImageType
 
using OutputType = typename Superclass::OutputType
 
using PixelType = typename InputImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename Superclass::PointType
 
using RealType = typename NumericTraits< ValueType >::RealType
 
using Self = VectorInterpolateImageFunction
 
using Superclass = ImageFunction< TInputImage, typename NumericTraits< typename TInputImage::PixelType >::RealType, TCoordRep >
 
using ValueType = typename PixelType::ValueType
 
- 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

OutputType Evaluate (const PointType &point) const override
 
OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0
 
virtual const char * GetNameOfClass () const
 
- 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
 
LightObject::Pointer CreateAnother () const override
 
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 Attributes

static constexpr unsigned int Dimension = TInputImage::PixelType::Dimension
 
static constexpr unsigned int ImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
static constexpr unsigned int ImageDimension
 
OutputType EvaluateAtIndex (const IndexType &index) const override
 
 VectorInterpolateImageFunction ()=default
 
 ~VectorInterpolateImageFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 

Additional Inherited Members

- 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 ()
 
- 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 ()
 
- 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 = double>
class itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >

Base class for all vector image interpolators.

VectorInterpolateImageFunction is the base for all ImageFunctions that interpolates image with vector pixel types. This function outputs a return value of type Vector<double,Dimension>.

This class is templated input image type and the coordinate representation type.

Warning
This hierarchy of functions work only for images with Vector-based pixel types. For scalar images use InterpolateImageFunction.
See also
InterpolateImageFunction

Definition at line 47 of file itkVectorInterpolateImageFunction.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TCoordRep = double>
using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::ConstPointer = SmartPointer<const Self>

Definition at line 65 of file itkVectorInterpolateImageFunction.h.

◆ ContinuousIndexType

template<typename TInputImage , typename TCoordRep = double>
using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::ContinuousIndexType = typename Superclass::ContinuousIndexType

ContinuousIndex type alias support

Definition at line 83 of file itkVectorInterpolateImageFunction.h.

◆ CoordRepType

template<typename TInputImage , typename TCoordRep = double>
using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::CoordRepType = TCoordRep

CoordRep type alias support

Definition at line 89 of file itkVectorInterpolateImageFunction.h.

◆ IndexType

template<typename TInputImage , typename TCoordRep = double>
using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::IndexType = typename Superclass::IndexType

Index type alias support

Definition at line 80 of file itkVectorInterpolateImageFunction.h.

◆ InputImageType

template<typename TInputImage , typename TCoordRep = double>
using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::InputImageType = typename Superclass::InputImageType

InputImageType type alias support

Definition at line 71 of file itkVectorInterpolateImageFunction.h.

◆ OutputType

template<typename TInputImage , typename TCoordRep = double>
using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::OutputType = typename Superclass::OutputType

Output type is RealType of TInputImage::PixelType.

Definition at line 86 of file itkVectorInterpolateImageFunction.h.

◆ PixelType

template<typename TInputImage , typename TCoordRep = double>
using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::PixelType = typename InputImageType::PixelType

Definition at line 72 of file itkVectorInterpolateImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = double>
using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::Pointer = SmartPointer<Self>

Definition at line 64 of file itkVectorInterpolateImageFunction.h.

◆ PointType

template<typename TInputImage , typename TCoordRep = double>
using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::PointType = typename Superclass::PointType

Point type alias support

Definition at line 77 of file itkVectorInterpolateImageFunction.h.

◆ RealType

template<typename TInputImage , typename TCoordRep = double>
using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::RealType = typename NumericTraits<ValueType>::RealType

Definition at line 74 of file itkVectorInterpolateImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordRep = double>
using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::Self = VectorInterpolateImageFunction

Standard class type aliases.

Definition at line 60 of file itkVectorInterpolateImageFunction.h.

◆ Superclass

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

Definition at line 62 of file itkVectorInterpolateImageFunction.h.

◆ ValueType

template<typename TInputImage , typename TCoordRep = double>
using itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::ValueType = typename PixelType::ValueType

Definition at line 73 of file itkVectorInterpolateImageFunction.h.

Constructor & Destructor Documentation

◆ VectorInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double>
itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::VectorInterpolateImageFunction ( )
protecteddefault

Interpolate the image at an index position. Simply returns the image value at the specified index position. No bounds checking is done. The point is assume to lie within the image buffer.

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

◆ ~VectorInterpolateImageFunction()

template<typename TInputImage , typename TCoordRep = double>
itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::~VectorInterpolateImageFunction ( )
overrideprotecteddefault

Interpolate the image at an index position. Simply returns the image value at the specified index position. No bounds checking is done. The point is assume to lie within the image buffer.

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

Member Function Documentation

◆ Evaluate()

template<typename TInputImage , typename TCoordRep = double>
OutputType itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType point) const
inlineoverride

Returns the interpolated image intensity at a specified point position. No bounds checking is done. The point is assume to lie within the image buffer. ImageFunction::IsInsideBuffer() can be used to check bounds before calling the method.

Definition at line 97 of file itkVectorInterpolateImageFunction.h.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = double>
OutputType itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType index) const
overridepure virtual

Interpolate the image at a continuous index position

Returns the interpolated image intensity at a specified index position. No bounds checking is done. The point is assume to lie within the image buffer.

Subclasses must override this method.

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

Implemented in itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >, and itk::VectorNearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordRep = double>
OutputType itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType index) const
inlineoverride

Interpolate the image at an index position. Simply returns the image value at the specified index position. No bounds checking is done. The point is assume to lie within the image buffer.

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

Definition at line 126 of file itkVectorInterpolateImageFunction.h.

◆ GetNameOfClass()

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

◆ PrintSelf()

template<typename TInputImage , typename TCoordRep = double>
void itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual

Interpolate the image at an index position. Simply returns the image value at the specified index position. No bounds checking is done. The point is assume to lie within the image buffer.

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

Reimplemented from itk::Object.

Reimplemented in itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >, itk::VectorNearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >, and itk::VectorLinearInterpolateImageFunction< TInputImage, TCoordRep >.

Definition at line 143 of file itkVectorInterpolateImageFunction.h.

Referenced by itk::VectorNearestNeighborInterpolateImageFunction< TInputImage, TCoordRep >::PrintSelf().

Member Data Documentation

◆ Dimension

template<typename TInputImage , typename TCoordRep = double>
constexpr unsigned int itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::Dimension = TInputImage::PixelType::Dimension
staticconstexpr

Extract the vector dimension from the pixel template parameter.

Definition at line 54 of file itkVectorInterpolateImageFunction.h.

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = double>
constexpr unsigned int itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >::ImageDimension = TInputImage::ImageDimension
staticconstexpr

Dimension underlying input image.

Definition at line 57 of file itkVectorInterpolateImageFunction.h.


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