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

#include <itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using ContinuousIndexType = typename Superclass::ContinuousIndexType
 
using IndexType = typename Superclass::IndexType
 
using IndexValueType = typename Superclass::IndexValueType
 
using InputImageType = typename Superclass::InputImageType
 
using OutputType = typename Superclass::OutputType
 
using PixelType = typename Superclass::PixelType
 
using Pointer = SmartPointer< Self >
 
using PointType = typename Superclass::PointType
 
using RealType = typename Superclass::RealType
 
using Self = VectorLinearInterpolateNearestNeighborExtrapolateImageFunction
 
using Superclass = VectorInterpolateImageFunction< TInputImage, TCoordRep >
 
using ValueType = typename Superclass::ValueType
 
- Public Types inherited from itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >
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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
OutputType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override
 
OutputType EvaluateAtIndex (const IndexType &index) const override
 
virtual const char * GetNameOfClass () const
 
bool IsInsideBuffer (const ContinuousIndexType &) const override
 
bool IsInsideBuffer (const IndexType &) const override
 
bool IsInsideBuffer (const PointType &) const override
 
- Public Member Functions inherited from itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >
OutputType Evaluate (const PointType &point) const override
 
OutputType EvaluateAtIndex (const IndexType &index) const override
 
- Public Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
NumericTraits< TInputImage::PixelType >::RealType Evaluate (const PointType &point) const override=0
 
virtual NumericTraits< TInputImage::PixelType >::RealType EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0
 
virtual NumericTraits< TInputImage::PixelType >::RealType EvaluateAtIndex (const IndexType &index) const=0
 
const InputImageTypeGetInputImage () const
 
virtual void SetInputImage (const InputImageType *ptr)
 
virtual bool IsInsideBuffer (const IndexType &index) const
 
virtual bool IsInsideBuffer (const ContinuousIndexType &index) const
 
virtual bool IsInsideBuffer (const PointType &point) const
 
void ConvertPointToNearestIndex (const PointType &point, IndexType &index) const
 
void ConvertPointToContinuousIndex (const PointType &point, ContinuousIndexType &cindex) const
 
void ConvertContinuousIndexToNearestIndex (const ContinuousIndexType &cindex, IndexType &index) const
 
virtual const IndexTypeGetStartIndex () const
 
virtual const IndexTypeGetEndIndex () const
 
virtual const ContinuousIndexTypeGetStartContinuousIndex () const
 
virtual const ContinuousIndexTypeGetEndContinuousIndex () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >
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
 

Protected Member Functions

void PrintSelf (std::ostream &os, Indent indent) const override
 
 VectorLinearInterpolateNearestNeighborExtrapolateImageFunction ()=default
 
 ~VectorLinearInterpolateNearestNeighborExtrapolateImageFunction () override=default
 
- Protected Member Functions inherited from itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >
 VectorInterpolateImageFunction ()=default
 
 ~VectorInterpolateImageFunction () override=default
 
- Protected Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
 ImageFunction ()
 
 ~ImageFunction () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::FunctionBase< Point< TCoordRep, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
 FunctionBase ()=default
 
 ~FunctionBase () override=default
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Static Private Attributes

static const unsigned int m_Neighbors
 

Additional Inherited Members

- Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >
InputImageConstPointer m_Image
 
IndexType m_StartIndex
 
IndexType m_EndIndex
 
ContinuousIndexType m_StartContinuousIndex
 
ContinuousIndexType m_EndContinuousIndex
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TInputImage, typename TCoordRep = float>
class itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >

Linearly interpolate or NN extrapolate a vector image at specified positions.

VectorLinearInterpolateNearestNeighborExtrapolateImageFunction linearly interpolates (or NN extrapolates) a vector image intensity non-integer pixel position. This class is templated over the input image type and the coordinate representation type.

This class is designed to work as a VectorInterpolateImageFunction, hence the IsInsideBuffer(PointType p) is overridden to always answer true

This function works for N-dimensional images.

Author
Tom Vercauteren, INRIA & Mauna Kea Technologies
Warning
This function work only for Vector images. For scalar images use LinearInterpolateImageFunction.

This paper was contributed in the Insight Journal paper: https://hdl.handle.net/1926/510

Definition at line 54 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

Member Typedef Documentation

◆ ConstPointer

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

◆ ContinuousIndexType

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

◆ IndexType

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

Index type alias support

Definition at line 87 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

◆ IndexValueType

template<typename TInputImage , typename TCoordRep = float>
using itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::IndexValueType = typename Superclass::IndexValueType

◆ InputImageType

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

InputImageType type alias support

Definition at line 73 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

◆ OutputType

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

Output type is Vector<double,Dimension>

Definition at line 94 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

◆ PixelType

template<typename TInputImage , typename TCoordRep = float>
using itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::PixelType = typename Superclass::PixelType

◆ Pointer

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

◆ PointType

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

◆ RealType

template<typename TInputImage , typename TCoordRep = float>
using itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::RealType = typename Superclass::RealType

◆ Self

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

Standard class type aliases.

Definition at line 61 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = float>
using itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::Superclass = VectorInterpolateImageFunction<TInputImage, TCoordRep>

◆ ValueType

template<typename TInputImage , typename TCoordRep = float>
using itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::ValueType = typename Superclass::ValueType

Constructor & Destructor Documentation

◆ VectorLinearInterpolateNearestNeighborExtrapolateImageFunction()

template<typename TInputImage , typename TCoordRep = float>
itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction ( )
protecteddefault

◆ ~VectorLinearInterpolateNearestNeighborExtrapolateImageFunction()

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

Member Function Documentation

◆ CreateAnother()

template<typename TInputImage , typename TCoordRep = float>
virtual::itk::LightObject::Pointer itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = float>
OutputType itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType index) const
overridevirtual

Evaluate the function at a ContinuousIndex position

Returns the linearly interpolated image intensity at a specified point position. If the point does not lie within the image buffer a nearest neighbor interpolation is done.

Implements itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >.

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordRep = float>
OutputType itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType index) const
override

Evaluate the function at an index position

Simply returns the image value at the specified index position. If the index does not lie within the image buffer a nearest neighbor interpolation is done.

◆ GetNameOfClass()

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

Run-time type information (and related methods).

Reimplemented from itk::VectorInterpolateImageFunction< TInputImage, TCoordRep >.

◆ IsInsideBuffer() [1/3]

template<typename TInputImage , typename TCoordRep = float>
bool itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::IsInsideBuffer ( const ContinuousIndexType ) const
inlineoverride

Should check if a continuous index is inside the image buffer, however we require that it answers true to use the extrapolation possibility.

Definition at line 115 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

◆ IsInsideBuffer() [2/3]

template<typename TInputImage , typename TCoordRep = float>
bool itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::IsInsideBuffer ( const IndexType ) const
inlineoverride

Should check if an index is inside the image buffer, however we require that it answers true to use the extrapolation possibility.

Definition at line 99 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

◆ IsInsideBuffer() [3/3]

template<typename TInputImage , typename TCoordRep = float>
bool itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::IsInsideBuffer ( const PointType ) const
inlineoverride

Should check if a point is inside the image buffer, however we require that it answers true to use the extrapolation possibility.

Definition at line 107 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TCoordRep = float>
void itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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::VectorInterpolateImageFunction< TInputImage, TCoordRep >.

Member Data Documentation

◆ ImageDimension

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

Grab the vector dimension from the superclass. Dimension underlying input image.

Definition at line 84 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.

◆ m_Neighbors

template<typename TInputImage , typename TCoordRep = float>
const unsigned int itk::VectorLinearInterpolateNearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >::m_Neighbors
staticprivate

Number of neighbors used in the interpolation

Definition at line 145 of file itkVectorLinearInterpolateNearestNeighborExtrapolateImageFunction.h.


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