Defines the range and coordinates of the "pixels" in the rasterised event. More...

#include <PixelDefinition.hh>

Public Member Functions
	PixelDefinition (size_t nBins, double yMax, bool allowPadding=false)
	Constructor using equal no. of bins in y and $\phi$ and full $\phi$ coverage.
	PixelDefinition (size_t nBinsPhi, double phiMin, double phiMax, size_t nBinsY, double yMin, double yMax, bool allowPhiPadding=false)
	Constructor using $\phi$ and rapidity ranges.
PixelArray	makeEmptyPixelArray () const
	Return a square array of pixels of appropriate dimension.
size_t	phiPixelIndex (double phi) const
	Return the index of the pixel in which a given $\phi$ value lies.
size_t	yPixelIndex (double y) const
	Return the index of the pixel in which a given y value lies.
size_t	nPixels () const
	Return the number of pixels along the y and $\phi$ axes.
double	yMin () const
	Return the minimum of the rapidity covered by this PixelDefinition.
double	yMax () const
	Return the maximum of the rapidity covered by this PixelDefinition.
bool	covers (double y, double phi) const
	Returns true if the given rapidity and phi values are inside the covered ranges.
size_t	nLevels () const
	Returns the number of wavelet levels.

Detailed Description

Defines the range and coordinates of the "pixels" in the rasterised event.

The rasterised event representation requires a definiton of the pixel ranges and positions. This class divides a rapidity and $\phi$ range into a 2-D array of bins

Definition at line 20 of file PixelDefinition.hh.

Constructor & Destructor Documentation

NewWave::PixelDefinition::PixelDefinition	(	size_t	nBins,
		double	yMax,
		bool	allowPadding = `false`
	)

Constructor using equal no. of bins in y and $\phi$ and full $\phi$ coverage.

This will use an equal number of pixels in both the rapidity and $\phi$ direction, together with full $2\pi$ coverage in $\phi$ . The rapidity range is symmetrical around zero, with the maximum absolute value specified.

If the specified bumber of bins is not radix two, then the rapidity range will need to be padded to allow an increase in the number of bins. While this will preserve the size of the bins in the rapidity direction, it will lead to smaller size in the $\phi$ direction. This behaviour must be explicitly requested using the allowPadding argument, which defaults to false

Parameters:

nBins	The number of pixel bins
yMax	The rapidity range spans from -yMax to yMax
allowPadding	Allow padding, default to no

NewWave::PixelDefinition::PixelDefinition	(	size_t	nBinsPhi,
		double	phiMin,
		double	phiMax,
		size_t	nBinsY,
		double	yMin,
		double	yMax,
		bool	allowPhiPadding = `false`
	)

Constructor using $\phi$ and rapidity ranges.

Constructor defining the $\phi$ and rapidity spans

This will pad the y and $\phi$ ranges to allow the output raster array to be square. While this is not a problem for the y direction, it makes less sense in phi, due to the periodicity. There is therefore a switch,

Parameters:

allowPhiPadding,that	must be turned on to enable such padding. By default, it will throw an exception if such padding is necessary.
nBinsPhi	The number of bins in the $\phi$ direction
phiMin	The minimum of the $\phi$ range
phiMax	The maximum of the $\phi$ range
nBinsY	The number of bins in the rapidity direction
yMin	The minimum of the rapidity range
yMax	The maximum of the rapidity range

Member Function Documentation

bool NewWave::PixelDefinition::covers	(	double	y,
		double	phi
	)		const

Returns true if the given rapidity and phi values are inside the covered ranges.

Parameters:

y	The rapidity of a particle
phi	The $\phi$ of a particle

Returns:: true if the particle is covered by this PixelDefinition

PixelArray NewWave::PixelDefinition::makeEmptyPixelArray ( ) const

Return a square array of pixels of appropriate dimension.

The pixel array must be square, and have sides of length that is radix 2. This method returns such an array that guarantees to be at least as big as the input phi and y ranges.

Returns:: a PixelArray of the appropriate size

size_t NewWave::PixelDefinition::nLevels ( ) const

Returns the number of wavelet levels.

The number of wavelet levels includes the smoothing coefficient. Increasing the number of levels by one doubles the number of wavelet coefficients.

Returns:: The number of wavelet levels

size_t NewWave::PixelDefinition::nPixels ( ) const

Return the number of pixels along the y and $\phi$ axes.

size_t NewWave::PixelDefinition::phiPixelIndex ( double phi ) const

Return the index of the pixel in which a given $\phi$ value lies.

double NewWave::PixelDefinition::yMax ( ) const

Return the maximum of the rapidity covered by this PixelDefinition.

double NewWave::PixelDefinition::yMin ( ) const

Return the minimum of the rapidity covered by this PixelDefinition.

size_t NewWave::PixelDefinition::yPixelIndex ( double y ) const

Return the index of the pixel in which a given y value lies.

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

code/include/NewWave/PixelDefinition.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation