Main Page Class Hierarchy Compound List File List Compound Members File Members

OccupancyAlg Class Reference

#include <OccupancyAlg.h>

Inheritance diagram for OccupancyAlg:

Public Methods
	OccupancyAlg (Event event, Geometry hecGeom, Headers *runHeader)
	The user should never need to use this contructor. More...
bool	initialize ()
	Gets run once at the begining of the event Loop. More...
bool	execute ()
	Gets run for every event. More...
bool	finalize ()
	Gets run after all events have been executed. More...
void	hecEnable (string noiseFileName="")
	Enable the computation of channel occupancy for the hec If no noise file name is given, then the file is assumed to be hec_nnnnn_noise.dat. More...
void	hecNoiseCut (float noiseCut)
	Set the noise cut level \|signal\| > m_hecNoiseCutNoise.* More...
float	hecNoiseCut ()
	Read the noise cut level Useful when reading occupancy files (where it is stored). More...
void	hecPrintLevel (int level)
	Set the print level for noise computation for the hec 0 minimum 1 print occupancy results (default). More...
void	hecOccupancyFileName (string occupancyFileName)
	Set the hec occupancy file name. More...
map< int, float >	hecOccupancyMap ()
	Get the febno keyed occupancy map The map contains entries for all connected channels. More...
float	hecOccupancy (int febno)
	Get the hec occupancy. More...
map< int, float >	hecOccupancyErrorMap ()
	Get the febno keyed hec occupancy error estimate map The map contains entries for all connected channels. More...
float	hecOccupancyError (int febno)
	Get the hec occupancy error estimate. More...
int	hecReadOccupancyFile (string occupancyFileName="")
	Read a hec occupancy file If no noise file name is given, then the file is assumed to be hec_nnnnn_occupancy.dat Returns the run number in the occupancy file. More...
void	hecPrintOccupancy ()
	Print hec occupancy data. More...
void	hecCalibrationFileName (string calibrationFileName)
	Set the hec calibration file name Needed if the ntuple data is in ADC Must be called before hecEnable. More...
void	emecEnable (string noiseFileName="")
	Enable the computation of channel occupancy for the emec If no noise file name is given, then the file is assumed to be emec?_nnnnn_noise.dat where ? is given by the input data file name. More...
void	emecNoiseCut (float noiseCut)
	Set the noise cut level \|signal\| > m_emecNoiseCutNoise.* More...
float	emecNoiseCut ()
	Read the noise cut level Useful when reading occupancy files (where it is stored). More...
void	emecPrintLevel (int level)
	Set the print level for noise computation for the emec 0 minimum 1 print occupancy results (default). More...
void	emecOccupancyFileName (string occupancyFileName)
	Set the emec occupancy file name. More...
map< int, float >	emecOccupancyMap ()
	Get the febno keyed occupancy map The map contains entries for all connected channels. More...
float	emecOccupancy (int febno)
	Get the emec occupancy. More...
map< int, float >	emecOccupancyErrorMap ()
	Get the febno keyed emec occupancy error estimate map The map contains entries for all connected channels. More...
float	emecOccupancyError (int febno)
	Get the emec occupancy error estimate. More...
int	emecReadOccupancyFile (string occupancyFileName="")
	Read a emec occupancy file If no occupancy file name is given, then assume the file is emec?_nnnnn_occupancy.dat where ? is given by the input data file name Returns the run number in the occupancy file. More...
void	emecPrintOccupancy ()
	Print emec occupancy data. More...
void	emecCalibrationFileName (string calibrationFileName)
	Set the emec calibration file name Needed if the ntuple data is in ADC Must be called before emecEnable. More...

Detailed Description

-Class: OccupancyAlg

Author: Michel Lefebvre
Date: 29/7/2003
Description: OccupancyAlg is a systemAlg that computes the occupancy of each channel. The cut is |signal| > NoiseCut*noise. The occupancy results are stored to files. Occupancy files can also be read back and the occupancy values accessed.

Constructor & Destructor Documentation

OccupancyAlg::OccupancyAlg ( Event * event,

Geometry * hecGeom,

Headers * runHeader

)

The user should never need to use this contructor.

Parameters:

event A pointer in the event. Information contained in the event gets refreshed before the execute method is run

hecGeom Pointer to the singleton Geometry object

runHeader Pointer to the singleton HecRunHeader object

Member Function Documentation

void OccupancyAlg::emecCalibrationFileName ( string calibrationFileName ) [inline]

Set the emec calibration file name Needed if the ntuple data is in ADC Must be called before emecEnable.

Parameters:

calibrationFileName the name of the calibration file

void OccupancyAlg::emecEnable ( string noiseFileName = "" )

Enable the computation of channel occupancy for the emec If no noise file name is given, then the file is assumed to be emec?_nnnnn_noise.dat where ? is given by the input data file name.

Parameters:

noiseFileName Name of noise file

float OccupancyAlg::emecNoiseCut ( ) [inline]

Read the noise cut level Useful when reading occupancy files (where it is stored).

void OccupancyAlg::emecNoiseCut ( float noiseCut ) [inline]

Set the noise cut level |signal| > m_emecNoiseCut*Noise.

Parameters:

noiseCut the noise cut level in noise sigma units

float OccupancyAlg::emecOccupancy ( int febno )

Get the emec occupancy.

Parameters:

febno channel febno

float OccupancyAlg::emecOccupancyError ( int febno )

Get the emec occupancy error estimate.

Parameters:

febno channel febno

map<int, float> OccupancyAlg::emecOccupancyErrorMap ( ) [inline]

Get the febno keyed emec occupancy error estimate map The map contains entries for all connected channels.

void OccupancyAlg::emecOccupancyFileName ( string occupancyFileName ) [inline]

Set the emec occupancy file name.

Parameters:

occupancyFileName the name of the occupancy file

map<int, float> OccupancyAlg::emecOccupancyMap ( ) [inline]

Get the febno keyed occupancy map The map contains entries for all connected channels.

void OccupancyAlg::emecPrintLevel ( int level ) [inline]

Set the print level for noise computation for the emec 0 minimum 1 print occupancy results (default).

Parameters:

level Print level

void OccupancyAlg::emecPrintOccupancy ( )

Print emec occupancy data.

int OccupancyAlg::emecReadOccupancyFile ( string occupancyFileName = "" )

Read a emec occupancy file If no occupancy file name is given, then assume the file is emec?_nnnnn_occupancy.dat where ? is given by the input data file name Returns the run number in the occupancy file.

Parameters:

occupancyFileName the name of the occupancy file

bool OccupancyAlg::execute ( ) [virtual]

Gets run for every event.

Reimplemented from SystemAlg.

bool OccupancyAlg::finalize ( ) [virtual]

Gets run after all events have been executed.

Reimplemented from SystemAlg.

void OccupancyAlg::hecCalibrationFileName ( string calibrationFileName ) [inline]

Set the hec calibration file name Needed if the ntuple data is in ADC Must be called before hecEnable.

Parameters:

calibrationFileName the name of the calibration file

void OccupancyAlg::hecEnable ( string noiseFileName = "" )

Enable the computation of channel occupancy for the hec If no noise file name is given, then the file is assumed to be hec_nnnnn_noise.dat.

Parameters:

noiseFileName Name of noise file

float OccupancyAlg::hecNoiseCut ( ) [inline]

Read the noise cut level Useful when reading occupancy files (where it is stored).

void OccupancyAlg::hecNoiseCut ( float noiseCut ) [inline]

Set the noise cut level |signal| > m_hecNoiseCut*Noise.

Parameters:

noiseCut the noise cut level in noise sigma units

float OccupancyAlg::hecOccupancy ( int febno )

Get the hec occupancy.

Parameters:

febno channel febno

float OccupancyAlg::hecOccupancyError ( int febno )

Get the hec occupancy error estimate.

Parameters:

febno channel febno

map<int, float> OccupancyAlg::hecOccupancyErrorMap ( ) [inline]

Get the febno keyed hec occupancy error estimate map The map contains entries for all connected channels.

void OccupancyAlg::hecOccupancyFileName ( string occupancyFileName ) [inline]

Set the hec occupancy file name.

Parameters:

occupancyFileName the name of the occupancy file

map<int, float> OccupancyAlg::hecOccupancyMap ( ) [inline]

Get the febno keyed occupancy map The map contains entries for all connected channels.

void OccupancyAlg::hecPrintLevel ( int level ) [inline]

Set the print level for noise computation for the hec 0 minimum 1 print occupancy results (default).

Parameters:

level Print level

void OccupancyAlg::hecPrintOccupancy ( )

Print hec occupancy data.

int OccupancyAlg::hecReadOccupancyFile ( string occupancyFileName = "" )

Read a hec occupancy file If no noise file name is given, then the file is assumed to be hec_nnnnn_occupancy.dat Returns the run number in the occupancy file.

Parameters:

occupancyFileName the name of the occupancy file

bool OccupancyAlg::initialize ( ) [virtual]

Gets run once at the begining of the event Loop.

Reimplemented from SystemAlg.

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

Generated on Fri Aug 15 10:52:05 2003 for TBRootAna by

OccupancyAlg Class Reference

Public Methods

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation