lti::mapperFunctor< Tin, Tout > Class Template Reference

This class maps a vector in a n-dimensional space into another vector in a m-dimensional space. More...

#include <ltiMapperFunctor.h>

Inheritance diagram for lti::mapperFunctor< Tin, Tout >:

[legend]

Collaboration diagram for lti::mapperFunctor< Tin, Tout >:

[legend]

List of all members.

Classes
class	parameters
	the parameters for the class mapperFunctor More...
Public Member Functions
	mapperFunctor ()
	mapperFunctor (const mapperFunctor &other)
virtual	~mapperFunctor ()
virtual const char *	getTypeName () const
virtual vector< Tout > &	apply (const vector< Tin > &src, vector< Tout > &dest) const
point &	apply (const vector< Tin > &src, point &dest) const
point &	apply (const Tin &src0, const Tin &src1, point &dest) const
point &	apply (const point &src, point &dest) const
Tout &	apply (const vector< Tin > &src, Tout &dest) const
Tout &	apply (const Tin &src, Tout &dest) const
mapperFunctor &	copy (const mapperFunctor &other)
virtual functor *	clone () const
const parameters &	getParameters () const

---

Detailed Description

template<class Tin, class Tout = int>
class lti::mapperFunctor< Tin, Tout >

This class maps a vector in a n-dimensional space into another vector in a m-dimensional space.

The main use of the "mappers" is to map a n-dimensional space in the integers cell space required by the histograms.

The type of the input space is Tin, and the type of the output space is Tout (default value int.

This is an abstract class. For an example see lti::linearMapper

There are only on-copy apply-members.

---

Constructor & Destructor Documentation

template<class Tin , class Tout = int>

lti::mapperFunctor< Tin, Tout >::mapperFunctor

(

)

default constructor

template<class Tin , class Tout = int>

lti::mapperFunctor< Tin, Tout >::mapperFunctor

(

const mapperFunctor< Tin, Tout > &

other

)

copy constructor

Parameters:

other

the object to be copied

template<class Tin , class Tout = int>

virtual lti::mapperFunctor< Tin, Tout >::~mapperFunctor

(

)

[virtual]

destructor

---

Member Function Documentation

template<class Tin , class Tout = int>

Tout& lti::mapperFunctor< Tin, Tout >::apply	(	const Tin &	src,
		Tout &	dest
	)			const

For the one dimensional case, maps a one dimensional vector in a output vector.

Parameters:

	src	one-dimensional vector with the source data.
	dest	one-dimensional vector where the result will be left.

Returns:

a reference to the dest.

Reimplemented in lti::linearMapperFunctor< Tin, Tout >, and lti::linearSatMapperFunctor< Tin, Tout >.

template<class Tin , class Tout = int>

Tout& lti::mapperFunctor< Tin, Tout >::apply	(	const vector< Tin > &	src,
		Tout &	dest
	)			const

For the one dimensional case, maps the input vector into a one dimensional vector of type Tout.

Parameters:

	src	int with the source data.
	dest	int where the result will be left.

Returns:

a reference to the dest.

Reimplemented in lti::linearMapperFunctor< Tin, Tout >, and lti::linearSatMapperFunctor< Tin, Tout >.

template<class Tin , class Tout = int>

point& lti::mapperFunctor< Tin, Tout >::apply	(	const point &	src,
		point &	dest
	)			const

For the two dimensional case, maps a two dimensional integer vector in a integer vector coded both as points.

Parameters:

	src	the original point
	dest	point where the result will be left.

Returns:

a reference to the dest.

Reimplemented in lti::linearMapperFunctor< Tin, Tout >, and lti::linearSatMapperFunctor< Tin, Tout >.

template<class Tin , class Tout = int>

point& lti::mapperFunctor< Tin, Tout >::apply	(	const Tin &	src0,
		const Tin &	src1,
		point &	dest
	)			const

For the two dimensional case, maps a two dimensional vector in a integer vector coded as a point.

Parameters:

	src0	the first element of the input vector
	src1	the second element of the input vector
	dest	point where the result will be left.

Returns:

a reference to the dest.

Reimplemented in lti::linearMapperFunctor< Tin, Tout >, and lti::linearSatMapperFunctor< Tin, Tout >.

template<class Tin , class Tout = int>

point& lti::mapperFunctor< Tin, Tout >::apply	(	const vector< Tin > &	src,
		point &	dest
	)			const

For the two dimensional case, maps a two dimensional vector in a integer vector coded as a point.

Parameters:

	src	ivector with the source data.
	dest	point where the result will be left.

Returns:

a reference to the dest.

Reimplemented in lti::linearMapperFunctor< Tin, Tout >, and lti::linearSatMapperFunctor< Tin, Tout >.

template<class Tin , class Tout = int>

virtual vector<Tout>& lti::mapperFunctor< Tin, Tout >::apply	(	const vector< Tin > &	src,
		vector< Tout > &	dest
	)			const [virtual]

Map the input vector src in the output vector dest.

Parameters:

	src	vector<Tin> with the source data.
	dest	vector<Tout> where the result will be left.

Returns:

a reference to the dest.

Reimplemented in lti::linearMapperFunctor< Tin, Tout >, and lti::linearSatMapperFunctor< Tin, Tout >.

template<class Tin , class Tout = int>

virtual functor* lti::mapperFunctor< Tin, Tout >::clone

(

)

const [virtual]

returns a pointer to a clone of this functor.

Implements lti::functor.

Reimplemented in lti::linearMapperFunctor< Tin, Tout >, and lti::linearSatMapperFunctor< Tin, Tout >.

template<class Tin , class Tout = int>

mapperFunctor& lti::mapperFunctor< Tin, Tout >::copy

(

const mapperFunctor< Tin, Tout > &

other

)

copy data of "other" functor.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::functor.

Reimplemented in lti::linearMapperFunctor< Tin, Tout >, and lti::linearSatMapperFunctor< Tin, Tout >.

template<class Tin , class Tout = int>

const parameters& lti::mapperFunctor< Tin, Tout >::getParameters

(

)

const

returns used parameters

Reimplemented from lti::functor.

Reimplemented in lti::linearMapperFunctor< Tin, Tout >, and lti::linearSatMapperFunctor< Tin, Tout >.

template<class Tin , class Tout = int>

virtual const char* lti::mapperFunctor< Tin, Tout >::getTypeName

(

)

const [virtual]

returns the name of this type ("mapperFunctor")

Reimplemented from lti::functor.

Reimplemented in lti::linearMapperFunctor< Tin, Tout >, and lti::linearSatMapperFunctor< Tin, Tout >.

---

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

• ltiMapperFunctor.h