Contains a single wavelet coefficient value, together with its levels. More...

#include <WaveletCoefficient.hh>

Public Member Functions
	WaveletCoefficient (size_t yLevel, size_t phiLevel, size_t key, bool smoothing, double yMin, double yMax, double phiMin, double phiMax, double value)
	Constructor.
double	value () const
	The value of the coefficient.
size_t	key () const
	Return a unique key for the coefficient.
size_t	yLevel () const
	The rapidity level of the coefficient.
size_t	phiLevel () const
	The $\phi$ level of the coefficient.
bool	isSmoothing () const
	Is this coefficient part of the "smoothing" coefficients.
double	phiMin () const
	The minimum of the $\phi$ range covered by the coefficient.
double	phiMax () const
	The maximum of the $\phi$ range covered by the coefficient.
double	phiCentre () const
	The centre of the $\phi$ range covered by the coefficient.
double	yMin () const
	The minimum of the range covered by the coefficient.
double	yMax () const
	The maximum of the range covered by the coefficient.
double	yCentre () const
	The centre of the range covered by the coefficient.
void	setValue (double val)
	Set the value of the coefficient.
int	frequencyHash (int nLevels) const
	Give a hash that is unique to the FrequencyBand this coefficient belongs in.
int	frequencyHash () const
	Give a hash that is unique to the FrequencyBand this coefficient belongs in.
const FrequencyBand &	frequencyBand () const
Friends
class	WaveletBaseEvent

Detailed Description

Contains a single wavelet coefficient value, together with its levels.

The wavelet coefficient has a value, together with the scale information for the wavelet basis function it corresponds to. The scale information is in the form of an integer level, such that the scale is proportional to $1 / 2^{l}$ , where $l$ is the level. There are two such levels for rapidity and $\phi$

Definition at line 20 of file WaveletCoefficient.hh.

Constructor & Destructor Documentation

NewWave::WaveletCoefficient::WaveletCoefficient	(	size_t	yLevel,
		size_t	phiLevel,
		size_t	key,
		bool	smoothing,
		double	yMin,
		double	yMax,
		double	phiMin,
		double	phiMax,
		double	value
	)

Constructor.

Construct a WaveletCoefficient from its rapidity level, phi level and value

Parameters:

yLevel	The rapidity level
phiLevel	The $\phi$ level
key	A key that, within the present event, is unique for this coefficient
yMin	The lower edge of the rapidity region to which this coefficient contributes, normalised so that the entire rapidity range is {0,1}
phiMin	The lower edge of the phi region to which this coefficient contributes, normalised so that the entire phi range is {0,1}
value	The value of the coefficient

Member Function Documentation

const FrequencyBand& NewWave::WaveletCoefficient::frequencyBand ( ) const

int NewWave::WaveletCoefficient::frequencyHash ( int nLevels ) const

Give a hash that is unique to the FrequencyBand this coefficient belongs in.

The hash is determined by the y-level, the $\phi$ -level, and the total number of levels used. The hash is simply

$(level_{\phi}) + (N_{levels} + 1)\times(level_{y})$

Parameters:

nLevels the total number of levels specified in the transform

int NewWave::WaveletCoefficient::frequencyHash ( ) const

Give a hash that is unique to the FrequencyBand this coefficient belongs in.

The hash is determined by the y-level, the $\phi$ -level, and the total number of levels used. The hash is simply

$(level_{\phi}) + (N_{levels} + 1)\times(level_{y})$

Parameters:

nLevels the total number of levels specified in the transform

bool NewWave::WaveletCoefficient::isSmoothing ( ) const

Is this coefficient part of the "smoothing" coefficients.

Depending on the wavelet basis used, some coefficients do not provide any meaningful detail on the decomposition of the signal and can be considered equivalent to the smoothing terms. The 0,0 coefficient is always a smoothing coefficient, but other coefficients may also be included

size_t NewWave::WaveletCoefficient::key ( ) const

Return a unique key for the coefficient.

In a given event, there is a fixed set of coefficients specifying the event. Each one has a key that is unique within that set. Coefficients from different events may have the same key, of course.

Returns:: The unique key for this WaveletCoefficient

double NewWave::WaveletCoefficient::phiCentre ( ) const

The centre of the $\phi$ range covered by the coefficient.

The contribution of each coefficient is localised to a region in $\phi-y$ , the size of which depends on the $\phi$ and $y$ levels.

size_t NewWave::WaveletCoefficient::phiLevel ( ) const

The $\phi$ level of the coefficient.

The $\phi$ level gives the scale of the wavelet basis funciton in the $\phi$ axis. The scale is proportional to $1 / 2^{l}$

Returns:: The $\phi$ level

double NewWave::WaveletCoefficient::phiMax ( ) const

The maximum of the $\phi$ range covered by the coefficient.

The contribution of each coefficient is localised to a region in $\phi-y$ , the size of which depends on the $\phi$ and $y$ levels.

double NewWave::WaveletCoefficient::phiMin ( ) const

The minimum of the $\phi$ range covered by the coefficient.

The contribution of each coefficient is localised to a region in $\phi-y$ , the size of which depends on the $\phi$ and $y$ levels.

void NewWave::WaveletCoefficient::setValue ( double val )

Set the value of the coefficient.

Parameters:

val	the new value of the coefficient

double NewWave::WaveletCoefficient::value ( ) const

The value of the coefficient.

Returns:: The value of the coefficient

double NewWave::WaveletCoefficient::yCentre ( ) const

The centre of the $y$ range covered by the coefficient.

The contribution of each coefficient is localised to a region in $\phi-y$ , the size of which depends on the $\phi$ and $y$ levels.

size_t NewWave::WaveletCoefficient::yLevel ( ) const

The rapidity level of the coefficient.

The rapidity level gives the scale of the wavelet basis function in the rapidity axis. The scale is proportional to $1 / 2^{l}$

Returns:: The rapidity level

double NewWave::WaveletCoefficient::yMax ( ) const

The maximum of the $y$ range covered by the coefficient.

The contribution of each coefficient is localised to a region in $\phi-y$ , the size of which depends on the $\phi$ and $y$ levels.

double NewWave::WaveletCoefficient::yMin ( ) const

The minimum of the $y$ range covered by the coefficient.

The contribution of each coefficient is localised to a region in $\phi-y$ , the size of which depends on the $\phi$ and $y$ levels.

Friends And Related Function Documentation

friend class WaveletBaseEvent [friend]

Definition at line 186 of file WaveletCoefficient.hh.

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

code/include/NewWave/WaveletCoefficient.hh

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation