lti::polarToCartesian< T > Class Template Reference

Computes the elements of the cartesian coordinate system (real,imaginary) based on the parameters of the polar coordinate system (absolute value, phase). More...

#include <ltiPolarToCartesian.h>

Inheritance diagram for lti::polarToCartesian< T >:

[legend]

Collaboration diagram for lti::polarToCartesian< T >:

[legend]

List of all members.

Classes
class	parameters
	the parameters for the class polarToCartesian More...
Public Member Functions
	polarToCartesian ()
	polarToCartesian (const polarToCartesian &other)
virtual	~polarToCartesian ()
virtual const char *	getTypeName () const
bool	apply (matrix< T > &abs_r, matrix< T > &ph_i) const
bool	apply (const matrix< T > &absvalue, const matrix< T > &phase, matrix< T > &real, matrix< T > &imaginary) const
bool	apply (const tpointList< double > &src, tpointList< T > &dest, const tpoint< double > origin=tpoint< double >(0.0, 0.0)) const
polarToCartesian &	copy (const polarToCartesian &other)
virtual functor *	clone () const
const parameters &	getParameters () const

---

Detailed Description

template<class T>
class lti::polarToCartesian< T >

Computes the elements of the cartesian coordinate system (real,imaginary) based on the parameters of the polar coordinate system (absolute value, phase).

---

Constructor & Destructor Documentation

template<class T >

lti::polarToCartesian< T >::polarToCartesian

(

)

default constructor

template<class T >

lti::polarToCartesian< T >::polarToCartesian

(

const polarToCartesian< T > &

other

)

copy constructor

Parameters:

other

the object to be copied

template<class T >

virtual lti::polarToCartesian< T >::~polarToCartesian

(

)

[virtual]

destructor

---

Member Function Documentation

template<class T >

bool lti::polarToCartesian< T >::apply	(	const tpointList< double > &	src,
		tpointList< T > &	dest,
		const tpoint< double >	origin = tpoint< double >(0.0, 0.0)
	)			const

operates on a copy of the given parameters.

Parameters:

	src	tpointList<T>& with the polar data the absolute in x and the angle in y.
	dest	this pointList gets the cartesian data
	origin	the origin of the coordiante system. the angles and the absolute values are relative to this point. Default is (0,0).

template<class T >

bool lti::polarToCartesian< T >::apply	(	const matrix< T > &	absvalue,
		const matrix< T > &	phase,
		matrix< T > &	real,
		matrix< T > &	imaginary
	)			const

operates on a copy of the given parameters.

If the input matrices have different size, the result will be empty

Parameters:

	absvalue	matrix<T> the absolute value source data.
	phase	matrix<T> the phase source data.
	real	reference to the target matrix which will receive the real part of the result.
	imaginary	reference to the target matrix which will receive the imaginary part of the result.

template<class T >

bool lti::polarToCartesian< T >::apply	(	matrix< T > &	abs_r,
		matrix< T > &	ph_i
	)			const

operates on the given parameter.

If the input matrices have different size, the result will be empty

Parameters:

	abs_r	matrix<T> the absolute value source data.
	ph_i	matrix<T> the phase source data.

Returns:

references to abs_r (real) and ph_i (imaginary).

template<class T >

virtual functor* lti::polarToCartesian< T >::clone

(

)

const [virtual]

returns a pointer to a clone of this functor.

Implements lti::functor.

template<class T >

polarToCartesian& lti::polarToCartesian< T >::copy

(

const polarToCartesian< T > &

other

)

copy data of "other" functor.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::functor.

template<class T >

const parameters& lti::polarToCartesian< T >::getParameters

(

)

const

returns used parameters

Reimplemented from lti::transform.

template<class T >

virtual const char* lti::polarToCartesian< T >::getTypeName

(

)

const [virtual]

returns the name of this type ("polarToCartesian")

Reimplemented from lti::transform.

---

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

• ltiPolarToCartesian.h