newwave is hosted by Hepforge, IPPP Durham

New Wave - Noise Elimination With Wavelets At Vast Energies  0.1.0
NewWave::RasterisedEvent< T > Class Template Reference

A rasterised representation of the event. More...

#include <RasterisedEvent.hh>

List of all members.

Public Member Functions

 RasterisedEvent (const T &inputParticles, const PixelDefinition &pixelDefn)
 Generic Templated constructor on anything that could be a list of particles.
 RasterisedEvent (const PixelArray &pixelArray, const PixelDefinition &pixelDefn)
 Constructor from an existing array of pixels.
const T & inputParticles () const
const PixelArraypixels () const
 Return the array of pixel values.
const PixelDefinitionpixelDefinition () const
 Return the pixel array definition.
template<>
 RasterisedEvent (HepMC::GenEvent *const &event, const PixelDefinition &pixelDefn)

Detailed Description

template<typename T>
class NewWave::RasterisedEvent< T >

A rasterised representation of the event.

Definition at line 17 of file RasterisedEvent.hh.


Constructor & Destructor Documentation

template<typename T >
NewWave::RasterisedEvent< T >::RasterisedEvent ( const T &  inputParticles,
const PixelDefinition pixelDefn 
) [inline]

Generic Templated constructor on anything that could be a list of particles.

Templated constructor on anything that is a list of particles possesing a momentum method. This would work with e.g. Rivet's Particle class

Parameters:
inputParticlesa vector of input Particle types
pixelDefnThe defintion of the pixel array

Definition at line 28 of file RasterisedEvent.hh.

template<typename T >
NewWave::RasterisedEvent< T >::RasterisedEvent ( const PixelArray pixelArray,
const PixelDefinition pixelDefn 
) [inline]

Constructor from an existing array of pixels.

Parameters:
pixelArrayA 2-D array of pixel values
pixelDefnThe definition of the pixel dimensions

Definition at line 46 of file RasterisedEvent.hh.

template<>
NewWave::RasterisedEvent< HepMC::GenEvent * >::RasterisedEvent ( HepMC::GenEvent *const &  event,
const PixelDefinition pixelDefn 
)

Constructor from a HepMC::GenEvent. Requires compiling against HepMC

Parameters:
eventThe HepMC GenEvent
pixelDefnThe definition of the pixel array

Member Function Documentation

template<typename T >
const T& NewWave::RasterisedEvent< T >::inputParticles ( ) const [inline]

Definition at line 51 of file RasterisedEvent.hh.

template<typename T >
const PixelDefinition& NewWave::RasterisedEvent< T >::pixelDefinition ( ) const [inline]

Return the pixel array definition.

Returns:
the definition in $\phi$ and rapidity

Definition at line 64 of file RasterisedEvent.hh.

template<typename T >
const PixelArray& NewWave::RasterisedEvent< T >::pixels ( ) const [inline]

Return the array of pixel values.

Returns:
the array of pixel values for this event

Definition at line 58 of file RasterisedEvent.hh.


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