#include <itkExtrapolateImageFunction.h>

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	ContinuousIndexType = typename Superclass::ContinuousIndexType

using	IndexType = typename Superclass::IndexType

using	InputImageType = typename Superclass::InputImageType

using	OutputType = typename Superclass::OutputType

using	Pointer = SmartPointer< Self >

using	PointType = typename Superclass::PointType

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, 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

OutputType	EvaluateAtIndex (const IndexType &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 InputImageType *	GetInputImage () 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 IndexType &	GetStartIndex () const

virtual const IndexType &	GetEndIndex () const

virtual const ContinuousIndexType &	GetStartContinuousIndex () const

virtual const ContinuousIndexType &	GetEndContinuousIndex () 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

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

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)

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 void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Static Public Attributes
static constexpr unsigned int	ImageDimension = Superclass::ImageDimension

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

Protected Member Functions
	ExtrapolateImageFunction ()=default

void	PrintSelf (std::ostream &os, Indent indent) const override

	~ExtrapolateImageFunction () 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 &timeStamp)

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

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, 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::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.

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.

◆ ContinuousIndexType

template<typename TInputImage , typename TCoordRep = float>

using itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::ContinuousIndexType = typename Superclass::ContinuousIndexType

ContinuousIndex type alias support

Definition at line 76 of file itkExtrapolateImageFunction.h.

◆ IndexType

template<typename TInputImage , typename TCoordRep = float>

using itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::IndexType = typename Superclass::IndexType

Index type alias support

Definition at line 73 of file itkExtrapolateImageFunction.h.

◆ InputImageType

template<typename TInputImage , typename TCoordRep = float>

using itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::InputImageType = typename Superclass::InputImageType

InputImageType type alias support

Definition at line 64 of file itkExtrapolateImageFunction.h.

◆ OutputType

template<typename TInputImage , typename TCoordRep = float>

using itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::OutputType = typename Superclass::OutputType

OutputType type alias support

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

◆ PointType

template<typename TInputImage , typename TCoordRep = float>

using itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::PointType = typename Superclass::PointType

Point type alias support

Definition at line 70 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 53 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

inlineoverride

Extrapolate the image at a point position

Returns the extrapolated image intensity at a specified point position.

Definition at line 87 of file itkExtrapolateImageFunction.h.

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

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

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.

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

◆ GetNameOfClass()

template<typename TInputImage , typename TCoordRep = float>

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageFunction< TInputImage, NumericTraits< TInputImage::PixelType >::RealType, TCoordRep >.

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

◆ PrintSelf()

template<typename TInputImage , typename TCoordRep = float>

void itk::ExtrapolateImageFunction< TInputImage, TCoordRep >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

inlineoverrideprotectedvirtual

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.

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

Definition at line 115 of file itkExtrapolateImageFunction.h.

References itk::ImageFunction< TInputImage, TOutput, TCoordRep >::PrintSelf().

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

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

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ ConstPointer

◆ ContinuousIndexType

◆ IndexType

◆ InputImageType

◆ OutputType

◆ Pointer

◆ PointType

◆ RealType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ ExtrapolateImageFunction()

◆ ~ExtrapolateImageFunction()

Member Function Documentation

◆ Evaluate()

◆ EvaluateAtContinuousIndex()

◆ EvaluateAtIndex()

◆ GetNameOfClass()

◆ PrintSelf()

Member Data Documentation

◆ ImageDimension

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