#include <itkExtrapolateImageFunction.h>

Detailed Description

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

Base class for all image extrapolaters.

ExtrapolateImageFunction is the base for all ImageFunctions that extrapolates image intensity at a non-integer pixel position outside the image buffer. This class is templated over the input image type and the coordinate representation type (e.g. float or double ).

Warning: This hierarchy of functions work only for images with scalar pixel types.

Definition at line 44 of file itkExtrapolateImageFunction.h.

Inheritance diagram for itk::ExtrapolateImageFunction< TInputImage, TCoordRep >:

Collaboration diagram for itk::ExtrapolateImageFunction< TInputImage, TCoordRep >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	RealType = typename NumericTraits< typename TInputImage::PixelType >::RealType

using	Self = ExtrapolateImageFunction

using	Superclass = ImageFunction< TInputImage, typename NumericTraits< typename TInputImage::PixelType >::RealType, TCoordRep >

Public Types inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, 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 = NumericTraits< TInputImage::PixelType >::RealType

using	Pointer = SmartPointer< Self >

using	PointType = Point< float, Self::ImageDimension >

using	Self = ImageFunction

using	Superclass = FunctionBase< Point< float, Self::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >

Public Types inherited from itk::FunctionBase< Point< float, TInputImage::ImageDimension >, NumericTraits< TInputImage::PixelType >::RealType >
using	ConstPointer = SmartPointer< const Self >

using	InputType = Point< float, 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	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const override=0

OutputType	EvaluateAtIndex (const IndexType &index) const override=0

const char *	GetNameOfClass () const override


OutputType	Evaluate (const PointType &point) const override

Public Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, 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 NumericTraits< TInputImage::PixelType >::RealType	EvaluateAtContinuousIndex (const ContinuousIndexType &index) const=0

virtual NumericTraits< TInputImage::PixelType >::RealType	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 Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, float >
static constexpr unsigned int	ImageDimension

Protected Member Functions
	ExtrapolateImageFunction ()=default

	~ExtrapolateImageFunction () override=default

Protected Member Functions inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, 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 >, NumericTraits< TInputImage::PixelType >::RealType >
	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 ()

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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Attributes inherited from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, 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>

using itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::ConstPointer = SmartPointer<const Self>

Definition at line 55 of file itkExtrapolateImageFunction.h.

◆ Pointer

template<typename TInputImage , typename TCoordRep = float>

using itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::Pointer = SmartPointer<Self>

Definition at line 54 of file itkExtrapolateImageFunction.h.

◆ RealType

template<typename TInputImage , typename TCoordRep = float>

using itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::RealType = typename NumericTraits<typename TInputImage::PixelType>::RealType

RealType type alias support

Definition at line 79 of file itkExtrapolateImageFunction.h.

◆ Self

template<typename TInputImage , typename TCoordRep = float>

using itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::Self = ExtrapolateImageFunction

Standard class type aliases.

Definition at line 51 of file itkExtrapolateImageFunction.h.

◆ Superclass

template<typename TInputImage , typename TCoordRep = float>

using itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::Superclass = ImageFunction<TInputImage, typename NumericTraits<typename TInputImage::PixelType>::RealType, TCoordRep>

Definition at line 52 of file itkExtrapolateImageFunction.h.

Constructor & Destructor Documentation

◆ ExtrapolateImageFunction()

template<typename TInputImage , typename TCoordRep = float>

itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::ExtrapolateImageFunction ( )

protecteddefault

◆ ~ExtrapolateImageFunction()

template<typename TInputImage , typename TCoordRep = float>

itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::~ExtrapolateImageFunction ( )

overrideprotecteddefault

Member Function Documentation

◆ Evaluate()

template<typename TInputImage , typename TCoordRep = float>

OutputType itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::Evaluate ( const PointType & point ) const

inlineoverridevirtual

Extrapolate the image at a point position

Returns the extrapolated image intensity at a
specified point position.

Implements itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, float >.

Definition at line 87 of file itkExtrapolateImageFunction.h.

References itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex(), itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, float >::GetInputImage(), and itk::point().

◆ EvaluateAtContinuousIndex()

template<typename TInputImage , typename TCoordRep = float>

OutputType itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::EvaluateAtContinuousIndex ( const ContinuousIndexType & index ) const

overridepure virtual

Extrapolate the image at a continuous index position

Returns the extrapolated image intensity at a specified point position.

Implements itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, float >.

Implemented in itk::NearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >.

Referenced by itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::Evaluate().

◆ EvaluateAtIndex()

template<typename TInputImage , typename TCoordRep = float>

OutputType itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::EvaluateAtIndex ( const IndexType & index ) const

overridepure virtual

Extrapolate the image at an index position.

Returns the extrapolated image intensity at a specified point position.

Implements itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, float >.

Implemented in itk::NearestNeighborExtrapolateImageFunction< TInputImage, TCoordRep >.

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = float>

const char * itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TCoordRep = float>

constexpr unsigned int itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::ImageDimension = Superclass::ImageDimension

staticconstexpr

Dimension underlying input image.

Definition at line 67 of file itkExtrapolateImageFunction.h.

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

itkExtrapolateImageFunction.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ Pointer

◆ RealType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ExtrapolateImageFunction()

◆ ~ExtrapolateImageFunction()

Member Function Documentation

◆ Evaluate()

◆ EvaluateAtContinuousIndex()

◆ EvaluateAtIndex()

◆ GetNameOfClass()

Member Data Documentation

◆ ImageDimension