aims::Interpolator Class Reference

#include <aims/resampling/linearInterpolator.h>

Inheritance diagram for aims::Interpolator:

Collaboration diagram for aims::Interpolator:

Public Types
typedef float	Coordinate_t
typedef Point3df	Point_t
typedef double	Scalar_t
Public Types inherited from carto::RCObject
typedef int	RefCounterType

Public Member Functions
virtual	~Interpolator ()
virtual bool	isValid (Coordinate_t x, Coordinate_t y, Coordinate_t z) const =0
	Return true if point ( x, y, z ) can be used for interpolation. More...
bool	isValid (const Interpolator::Point_t &point) const
	Return true if point can be used for interpolation. More...
Scalar_t	operator() (Coordinate_t x, Coordinate_t y, Coordinate_t z) const __attribute__((__deprecated__("use value() method instead")))
Scalar_t	operator() (const Interpolator::Point_t &point) const __attribute__((__deprecated__("use value() method instead")))
void	operator() (Coordinate_t x, Coordinate_t y, Coordinate_t z, std::vector< Scalar_t > &v) const __attribute__((__deprecated__("use values() method instead")))
void	operator() (const Interpolator::Point_t &point, std::vector< Scalar_t > &v) const __attribute__((__deprecated__("use values() method instead")))
Scalar_t	value (Coordinate_t x, Coordinate_t y, Coordinate_t z) const
	Interpolate to get a value from point ( x, y ,z ). More...
Scalar_t	value (const Interpolator::Point_t &point) const
	Interpolate to get a value from point. More...
void	values (Coordinate_t x, Coordinate_t y, Coordinate_t z, std::vector< Scalar_t > &v) const
	Interpolate to get a series of values from point ( x, y ,z ) More...
void	values (const Interpolator::Point_t &point, std::vector< Scalar_t > &v) const
	Interpolate to get a series of values from point ( x, y ,z ) More...
virtual const carto::PropertySet &	header () const =0
	Return the header of the image. More...
Public Member Functions inherited from carto::RCObject
	RCObject ()
	RCObject (const RCObject &)
RCObject &	operator= (const RCObject &)
virtual	~RCObject ()

Detailed Description

Definition at line 55 of file linearInterpolator.h.

Member Typedef Documentation

Coordinate_t

typedef float aims::Interpolator::Coordinate_t

Definition at line 59 of file linearInterpolator.h.

Point_t

typedef Point3df aims::Interpolator::Point_t

Definition at line 60 of file linearInterpolator.h.

Scalar_t

typedef double aims::Interpolator::Scalar_t

Definition at line 61 of file linearInterpolator.h.

Constructor & Destructor Documentation

~Interpolator()

virtual aims::Interpolator::~Interpolator ( )

virtual

Member Function Documentation

header()

virtual const carto::PropertySet& aims::Interpolator::header ( ) const

pure virtual

Return the header of the image.

Implemented in aims::LinearInterpolator< T >.

Referenced by values().

isValid() [1/2]

virtual bool aims::Interpolator::isValid ( Coordinate_t  x, Coordinate_t  y, Coordinate_t  z  ) const

pure virtual

Return true if point ( x, y, z ) can be used for interpolation.

If interpolation is tried on an invalid point, it may crash the program.

Implemented in aims::LinearInterpolator< T >.

Referenced by isValid().

isValid() [2/2]

bool aims::Interpolator::isValid ( const Interpolator::Point_t &  point ) const

inline

Return true if point can be used for interpolation.

If interpolation is tried on an invalid point, it may crash the program.

Definition at line 73 of file linearInterpolator.h.

References isValid().

operator()() [1/4]

Scalar_t aims::Interpolator::operator() ( Coordinate_t  x, Coordinate_t  y, Coordinate_t  z  ) const

inline

Deprecated:

Obsolete, use value() method

Definition at line 79 of file linearInterpolator.h.

References __attribute__(), and __deprecated__.

operator()() [2/4]

Scalar_t aims::Interpolator::operator() ( const Interpolator::Point_t &  point ) const

inline

Deprecated:

Obsolete, use value() method

Definition at line 86 of file linearInterpolator.h.

References __attribute__(), and __deprecated__.

operator()() [3/4]

void aims::Interpolator::operator() ( Coordinate_t  x, Coordinate_t  y, Coordinate_t  z, std::vector< Scalar_t > &  v  ) const

inline

Deprecated:

Obsolete, use values() method

Definition at line 92 of file linearInterpolator.h.

References __attribute__(), and __deprecated__.

operator()() [4/4]

void aims::Interpolator::operator() ( const Interpolator::Point_t &  point, std::vector< Scalar_t > &  v  ) const

inline

Deprecated:

Obsolete, use values() method

Definition at line 99 of file linearInterpolator.h.

References __attribute__(), and __deprecated__.

value() [1/2]

Scalar_t aims::Interpolator::value ( Coordinate_t  x, Coordinate_t  y, Coordinate_t  z  ) const

inline

Interpolate to get a value from point ( x, y ,z ).

Definition at line 107 of file linearInterpolator.h.

value() [2/2]

Scalar_t aims::Interpolator::value ( const Interpolator::Point_t &  point ) const

inline

Interpolate to get a value from point.

Definition at line 113 of file linearInterpolator.h.

values() [1/2]

void aims::Interpolator::values ( Coordinate_t  x, Coordinate_t  y, Coordinate_t  z, std::vector< Scalar_t > &  v  ) const

inline

Interpolate to get a series of values from point ( x, y ,z )

Definition at line 118 of file linearInterpolator.h.

Referenced by aims::LinearInterpolator< T >::isValid().

values() [2/2]

void aims::Interpolator::values ( const Interpolator::Point_t &  point, std::vector< Scalar_t > &  v  ) const

inline

Interpolate to get a series of values from point ( x, y ,z )

Definition at line 124 of file linearInterpolator.h.

References aims::getLinearInterpolator(), and header().

---

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

• aims/resampling/linearInterpolator.h