GFC_stats.h File Reference

Defines the interface for summarizing the event-by-event results of the filtering process into a statistics table. More...

Functions
int	GFC_statsSizeof (void)
	Returns the size, in bytes, of the statistics table.
void	GFC_statsClear (GFC_stats *stats)
	Clears the statistics block.
void	GFC_statsAccumulate (GFC_stats *stats, const GFC_result *beg, const GFC_result *end)
	Accumulates the statistics from a vector of event-by-event filtering results.
void	GFC_statsAltAccumulate (GFC_stats *stats, const GFC_result *beg, const GFC_result *end, int nenergies, const unsigned int *energies)
	Accumulates the statistics from a vector of event-by-event filtering results. The alternate energy binning scheme is used.

---

Detailed Description

Defines the interface for summarizing the event-by-event results of the filtering process into a statistics table.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: GFC_stats.h,v 1.2 2007/10/10 23:40:42 russell Exp $

---

Function Documentation

void GFC_statsAccumulate	(	GFC_stats *	stats,
		const GFC_result *	beg,
		const GFC_result *	end
	)

Accumulates the statistics from a vector of event-by-event filtering results.

Parameters:

	stats	The statistics block to accumulate into
	beg	The first result vector in the array to accumulate
	end	The last (actually one past the last) result vector in the array to accumulate

References _GFC_statsVector::cnts, _GFC_stats::energy, getEnergyBin(), GFC_V3_STAGE_M_TKR, GFC_V3_STAGE_V_TKR, _GFC_result::stageEnergy, and _GFC_result::status.

void GFC_statsAltAccumulate	(	GFC_stats *	stats,
		const GFC_result *	beg,
		const GFC_result *	end,
		int	nenergies,
		const unsigned int *	energies
	)

Accumulates the statistics from a vector of event-by-event filtering results. The alternate energy binning scheme is used.

Parameters:

	stats	The statistics block to accumulate into
	beg	The first result vector in the array to accumulate
	end	The last (actually one past the last) result vector in the array to accumulate
	nenergies	The number of energy bins (up to 7)
	energies	The energy bins, there can be up to 8. These define the upper edge of the energy bin. If 0 is defined as the first bin, the energy in the results bin will be considered a calculated value and checked for validity against the status value. If not, the value in the energy will be considered always valid.

References _GFC_statsVector::cnts, _GFC_stats::energy, GFC_V3_STAGE_M_ENERGY, GFC_V3_STAGE_M_TKR, GFC_V3_STAGE_V_TKR, _GFC_result::stageEnergy, and _GFC_result::status.

void GFC_statsClear

(

GFC_stats *

stats

)

Clears the statistics block.

Parameters:

stats

The statistics block to clear.

References _GFC_stats::energy.

int GFC_statsSizeof

(

void

)

Returns the size, in bytes, of the statistics table.

Returns:

The size, in bytes, of the statistics table