ArrayMath Namespace Reference

Classes
class	ArrayOperExecSetup
class	ArrOperExec
	Parallel task for computing the element wise operations of one array and optionally a second input array. Should not be used directly, instead call getSum(const ArrayND) More...
class	CumArrOperExec
	Parallel task for computing the sum of element wise operations of one array and optionally a second input array. Should not be used directly, instead call getSum(const ArrayND) Template parameter SumType should be double (real or complex) for all float types. Should be od_int64 for all integer types. Template parameter OperType should be double (real) for all float types. Should be od_int64 for all integer types. More...

Functions
template<class ArrType , class SumType , class OperType , class RetType >
RetType	getSum (const ArrayND< ArrType > &in, bool noudf, bool parallel)
	returns the sum of all defined values in the Array. Returns UDF if empty or only udfs encountered. More...
template<class ArrType , class SumType , class OperType , class RetType >
RetType	getAverage (const ArrayND< ArrType > &in, bool noudf, bool parallel)
	returns the average amplitude of the array More...
template<class ArrType , class SumType , class OperType >
void	getScaled (const ArrayND< ArrType > &in, ArrayND< ArrType > *out_, OperType fact, SumType shift, bool noudf, bool parallel)
	returns a scaled array More...
template<class ArrType , class SumType , class OperType >
void	getSum (const ArrayND< ArrType > &in1, const ArrayND< ArrType > &in2, ArrayND< ArrType > &out, bool noudf, bool parallel)
	computes the sum array between two arrays More...
template<class ArrType , class SumType , class OperType >
void	getSum (const ArrayND< ArrType > &in1, const ArrayND< ArrType > &in2, ArrayND< ArrType > &out, OperType fact1, OperType fact2, bool noudf, bool parallel)
	computes the sum array between two arrays with scaling More...
template<class ArrType , class SumType , class OperType >
void	getProduct (const ArrayND< ArrType > &in1, const ArrayND< ArrType > &in2, ArrayND< ArrType > &out, bool noudf, bool parallel)
	computes the product array between two arrays More...
template<class ArrType , class SumType , class OperType , class RetType >
RetType	getSumProduct (const ArrayND< ArrType > &in1, const ArrayND< ArrType > &in2, bool noudf, bool parallel)
	returns the sum of product amplitudes between two vectors More...
template<class ArrType , class SumType , class OperType , class RetType >
RetType	getSumSq (const ArrayND< ArrType > &in, bool noudf, bool parallel)
	returns the sum of squarred amplitudes of the array More...
template<class ArrType , class SumType , class OperType , class RetType >
RetType	getNorm2 (const ArrayND< ArrType > &in, bool noudf, bool parallel)
	return the Norm-2 of the array More...
template<class ArrType , class SumType , class OperType , class RetType >
RetType	getRMS (const ArrayND< ArrType > &in, bool noudf, bool parallel)
	return the RMS of the array More...
template<class ArrType , class SumType , class OperType , class RetType >
RetType	getResidual (const ArrayND< ArrType > &in1, const ArrayND< ArrType > &in2, bool noudf, bool parallel)
	returns the residual differences of two arrays More...
template<class ArrType , class SumType , class OperType , class RetType >
RetType	getSumXMY2 (const ArrayND< ArrType > &in1, const ArrayND< ArrType > &in2, bool noudf, bool parallel)
	returns the sum of squarred differences of two arrays More...
template<class ArrType , class SumType , class OperType , class RetType >
RetType	getSumX2PY2 (const ArrayND< ArrType > &in1, const ArrayND< ArrType > &in2, bool noudf, bool parallel)
	returns the sum of summed squarred amplitudes of two arrays More...
template<class ArrType , class SumType , class OperType , class RetType >
RetType	getSumX2MY2 (const ArrayND< ArrType > &in1, const ArrayND< ArrType > &in2, bool noudf, bool parallel)
	returns the sum of subtracted squarred amplitudes of two arrays More...
template<class ArrType , class SumType , class OperType >
bool	removeBias (const ArrayND< ArrType > &in, ArrayND< ArrType > &out, bool noudf, bool parallel)
	Fills an ArrayND with an unbiased version of another. More...
template<class ArrType , class SumType , class OperType >
bool	removeBias (ArrayND< ArrType > &inout, bool noudf, bool parallel)
	Removes the bias ( 0 order trend = average ) from an ArrayND. More...
template<class ArrType , class OperType >
bool	getInterceptGradient (const ArrayND< ArrType > &iny, const ArrayND< ArrType > *inx_, OperType &intercept, OperType &gradient, bool parallel)
	returns the intercept and gradient of two arrays More...
template<class ArrType , class OperType >
bool	removeTrend (const ArrayND< ArrType > &in, ArrayND< ArrType > &out)
	Fills an ArrayND with a de-trended version of another. More...
template<class ArrType , class OperType >
bool	removeTrend (ArrayND< ArrType > &inout)
	Removes a 1st order (linear) trend from an ArrayND. More...

Function Documentation

template<class ArrType , class SumType , class OperType , class RetType >

RetType ArrayMath::getAverage ( const ArrayND< ArrType > &  in, bool  noudf, bool  parallel  )

inline

returns the average amplitude of the array

template<class ArrType , class OperType >

bool ArrayMath::getInterceptGradient ( const ArrayND< ArrType > &  iny, const ArrayND< ArrType > *  inx_, OperType &  intercept, OperType &  gradient, bool  parallel  )

inline

returns the intercept and gradient of two arrays

template<class ArrType , class SumType , class OperType , class RetType >

RetType ArrayMath::getNorm2 ( const ArrayND< ArrType > &  in, bool  noudf, bool  parallel  )

inline

return the Norm-2 of the array

template<class ArrType , class SumType , class OperType >

void ArrayMath::getProduct ( const ArrayND< ArrType > &  in1, const ArrayND< ArrType > &  in2, ArrayND< ArrType > &  out, bool  noudf, bool  parallel  )

inline

computes the product array between two arrays

template<class ArrType , class SumType , class OperType , class RetType >

RetType ArrayMath::getResidual ( const ArrayND< ArrType > &  in1, const ArrayND< ArrType > &  in2, bool  noudf, bool  parallel  )

inline

returns the residual differences of two arrays

template<class ArrType , class SumType , class OperType , class RetType >

RetType ArrayMath::getRMS ( const ArrayND< ArrType > &  in, bool  noudf, bool  parallel  )

inline

return the RMS of the array

template<class ArrType , class SumType , class OperType >

void ArrayMath::getScaled ( const ArrayND< ArrType > &  in, ArrayND< ArrType > *  out_, OperType  fact, SumType  shift, bool  noudf, bool  parallel  )

inline

returns a scaled array

template<class ArrType , class SumType , class OperType , class RetType >

RetType ArrayMath::getSum ( const ArrayND< ArrType > &  in, bool  noudf, bool  parallel  )

inline

returns the sum of all defined values in the Array. Returns UDF if empty or only udfs encountered.

template<class ArrType , class SumType , class OperType >

void ArrayMath::getSum ( const ArrayND< ArrType > &  in1, const ArrayND< ArrType > &  in2, ArrayND< ArrType > &  out, bool  noudf, bool  parallel  )

inline

computes the sum array between two arrays

template<class ArrType , class SumType , class OperType >

void ArrayMath::getSum ( const ArrayND< ArrType > &  in1, const ArrayND< ArrType > &  in2, ArrayND< ArrType > &  out, OperType  fact1, OperType  fact2, bool  noudf, bool  parallel  )

inline

computes the sum array between two arrays with scaling

template<class ArrType , class SumType , class OperType , class RetType >

RetType ArrayMath::getSumProduct ( const ArrayND< ArrType > &  in1, const ArrayND< ArrType > &  in2, bool  noudf, bool  parallel  )

inline

returns the sum of product amplitudes between two vectors

template<class ArrType , class SumType , class OperType , class RetType >

RetType ArrayMath::getSumSq ( const ArrayND< ArrType > &  in, bool  noudf, bool  parallel  )

inline

returns the sum of squarred amplitudes of the array

template<class ArrType , class SumType , class OperType , class RetType >

RetType ArrayMath::getSumX2MY2 ( const ArrayND< ArrType > &  in1, const ArrayND< ArrType > &  in2, bool  noudf, bool  parallel  )

inline

returns the sum of subtracted squarred amplitudes of two arrays

template<class ArrType , class SumType , class OperType , class RetType >

RetType ArrayMath::getSumX2PY2 ( const ArrayND< ArrType > &  in1, const ArrayND< ArrType > &  in2, bool  noudf, bool  parallel  )

inline

returns the sum of summed squarred amplitudes of two arrays

template<class ArrType , class SumType , class OperType , class RetType >

RetType ArrayMath::getSumXMY2 ( const ArrayND< ArrType > &  in1, const ArrayND< ArrType > &  in2, bool  noudf, bool  parallel  )

inline

returns the sum of squarred differences of two arrays

template<class ArrType , class SumType , class OperType >

bool ArrayMath::removeBias ( const ArrayND< ArrType > &  in, ArrayND< ArrType > &  out, bool  noudf, bool  parallel  )

inline

Fills an ArrayND with an unbiased version of another.

template<class ArrType , class SumType , class OperType >

bool ArrayMath::removeBias ( ArrayND< ArrType > &  inout, bool  noudf, bool  parallel  )

inline

Removes the bias ( 0 order trend = average ) from an ArrayND.

template<class ArrType , class OperType >

bool ArrayMath::removeTrend ( const ArrayND< ArrType > &  in, ArrayND< ArrType > &  out  )

inline

Fills an ArrayND with a de-trended version of another.

template<class ArrType , class OperType >

bool ArrayMath::removeTrend ( ArrayND< ArrType > &  inout )

inline

Removes a 1st order (linear) trend from an ArrayND.