jet::NearestArraySampler< T, R, 2 > Class Template Reference

2-D nearest array sampler class. More...

#include <jet/array_samplers2.h>

Public Member Functions
	NearestArraySampler (const ConstArrayAccessor2< T > &accessor, const Vector2< R > &gridSpacing, const Vector2< R > &gridOrigin)
	Constructs a sampler using array accessor, spacing between the elements, and the position of the first array element. More...
	NearestArraySampler (const NearestArraySampler &other)
	Copy constructor. More...
T	operator() (const Vector2< R > &pt) const
	Returns sampled value at point pt. More...
void	getCoordinate (const Vector2< R > &pt, Point2UI *index) const
	Returns the nearest array index for point x. More...
std::function< T(const Vector2< R > &)>	functor () const
	Returns a funtion object that wraps this instance. More...

Detailed Description

template<typename T, typename R>
class jet::NearestArraySampler< T, R, 2 >

2-D nearest array sampler class.

This class provides nearest sampling interface for a given 2-D array.

Template Parameters

T	- The value type to sample.
R	- The real number type.

Constructor & Destructor Documentation

NearestArraySampler() [1/2]

template<typename T , typename R >

jet::NearestArraySampler< T, R, 2 >::NearestArraySampler ( const ConstArrayAccessor2< T > &  accessor, const Vector2< R > &  gridSpacing, const Vector2< R > &  gridOrigin  )

explicit

Constructs a sampler using array accessor, spacing between the elements, and the position of the first array element.

Parameters

[in]	accessor	The array accessor.
[in]	gridSpacing	The grid spacing.
[in]	gridOrigin	The grid origin.

NearestArraySampler() [2/2]

template<typename T , typename R >

jet::NearestArraySampler< T, R, 2 >::NearestArraySampler

(

const NearestArraySampler< T, R, 2 > &

other

)

Copy constructor.

Member Function Documentation

functor()

template<typename T , typename R >

std::function<T(const Vector2<R>&)> jet::NearestArraySampler< T, R, 2 >::functor

(

)

const

Returns a funtion object that wraps this instance.

getCoordinate()

template<typename T , typename R >

void jet::NearestArraySampler< T, R, 2 >::getCoordinate	(	const Vector2< R > &	pt,
		Point2UI *	index
	)		const

Returns the nearest array index for point x.

operator()()

template<typename T , typename R >

T jet::NearestArraySampler< T, R, 2 >::operator()

(

const Vector2< R > &

pt

)

const

Returns sampled value at point pt.

---

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

• jet/array_samplers2.h