Mantid::CurveFitting::HalfComplex Class Reference

Class for helping to read the transformed data. More...

#include <HalfComplex.h>

Public Member Functions
	HalfComplex (double *data, const size_t &n)
	Constructor. More...
double	imag (size_t i) const
	The imaginary part of i-th transform coefficient. More...
double	real (size_t i) const
	The real part of i-th transform coefficient. More...
void	set (size_t i, const double &re, const double &im)
	Set a new value for i-th complex coefficient. More...
size_t	size () const
	Returns the size of the transform. More...

Private Attributes
double *	m_data
	pointer to the transformed data More...
bool	m_even
	true if the size of the original data is even More...
size_t	m_size
	size of the transformed data More...

Detailed Description

Class for helping to read the transformed data.

It represent an output of the GSL real fast fourier transform routine. The routine transforms an array of n real numbers into an array of about n/2 complex numbers which are the amplitudes of the positive frequencies of the full complex fourier transform.

Definition at line 19 of file HalfComplex.h.

Constructor & Destructor Documentation

HalfComplex()

Mantid::CurveFitting::HalfComplex::HalfComplex ( double *  data, const size_t &  n  )

inline

Constructor.

Parameters

data	:: A pointer to the transformed complex data
n	:: The size of untransformed real data

Definition at line 27 of file HalfComplex.h.

Member Function Documentation

imag()

double Mantid::CurveFitting::HalfComplex::imag ( size_t  i ) const

inline

The imaginary part of i-th transform coefficient.

Parameters

i	:: The index of the complex transform coefficient

Returns

The imaginary part

Definition at line 44 of file HalfComplex.h.

References m_data, m_even, and m_size.

real()

double Mantid::CurveFitting::HalfComplex::real ( size_t  i ) const

inline

The real part of i-th transform coefficient.

Parameters

i	:: The index of the complex transform coefficient

Returns

The real part

Definition at line 34 of file HalfComplex.h.

References m_data, and m_size.

Referenced by Mantid::CurveFitting::Functions::ChebfunBase::calcA().

set()

void Mantid::CurveFitting::HalfComplex::set ( size_t  i, const double &  re, const double &  im  )

inline

Set a new value for i-th complex coefficient.

Parameters

i	:: The index of the coefficient
re	:: The real part of the new value
im	:: The imaginary part of the new value

Definition at line 58 of file HalfComplex.h.

References m_data, m_even, and m_size.

Referenced by Mantid::CurveFitting::Functions::ChebfunBase::calcP().

size()

size_t Mantid::CurveFitting::HalfComplex::size ( ) const

inline

Returns the size of the transform.

Definition at line 29 of file HalfComplex.h.

References m_size.

Member Data Documentation

m_data

double* Mantid::CurveFitting::HalfComplex::m_data

private

pointer to the transformed data

Definition at line 21 of file HalfComplex.h.

Referenced by imag(), real(), and set().

m_even

bool Mantid::CurveFitting::HalfComplex::m_even

private

true if the size of the original data is even

Definition at line 22 of file HalfComplex.h.

Referenced by imag(), and set().

m_size

size_t Mantid::CurveFitting::HalfComplex::m_size

private

size of the transformed data

Definition at line 20 of file HalfComplex.h.

Referenced by imag(), real(), set(), and size().

---

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

• Framework/CurveFitting/inc/MantidCurveFitting/HalfComplex.h