GFC_resultsPrint.h File Reference

Defines the interface for summarizing the event-by-event results of the gamma filtering process. More...

Typedefs
typedef enum _GFC_RESULTS_PRINT_OPT_V	GFC_RESULTS_PRINT_OPT_V
	Typedef for enum _GFC_M_RESULTS_PRINT_OPT_V.
typedef enum _GFC_RESULTS_PRINT_OPT_M	GFC_RESULTS_PRINT_OPT_M
	Typedef for enum _GFC_RESULTS_PRINT_OPT_M.
Enumerations
enum	_GFC_RESULTS_PRINT_OPT_V {   GFC_RESULTS_PRINT_OPT_V_SUMMARY = 0,   GFC_RESULTS_PRINT_OPT_V_EVENT = 1 }
	Enumerates the print options for the GFC_resultsPrint routine as bit offsets. More...
enum	_GFC_RESULTS_PRINT_OPT_M {   GFC_RESULTS_PRINT_OPT_M_SUMMARY,   GFC_RESULTS_PRINT_OPT_M_EVENT,   GFC_RESULTS_PRINT_OPT_M_ALL = 0xffff }
	Enumerates the print options for the GFC_resultsPrint routine as bit masks. More...
Functions
int	GFC_resultsPrint (int options, const GFC_result *beg, const GFC_result *end)
	Prints the event-by-event result vector to the terminal.
int	GFC_resultsWrite (const char *fileName, const GFC_result *beg, const GFC_result *end)
	Writes the event-by-event result vector to a file (binary).

---

Detailed Description

Defines the interface for summarizing the event-by-event results of the gamma filtering process.

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id: GFC_resultsPrint.h,v 1.2 2005/11/22 02:32:06 russell Exp $

---

Enumeration Type Documentation

enum _GFC_RESULTS_PRINT_OPT_M

Enumerates the print options for the GFC_resultsPrint routine as bit masks.

Enumerator:

GFC_RESULTS_PRINT_OPT_M_SUMMARY	Print the summary information
GFC_RESULTS_PRINT_OPT_M_EVENT	Print the event by event information
GFC_RESULTS_PRINT_OPT_M_ALL	Print all the information

enum _GFC_RESULTS_PRINT_OPT_V

Enumerates the print options for the GFC_resultsPrint routine as bit offsets.

Enumerator:

GFC_RESULTS_PRINT_OPT_V_SUMMARY	Print the summary information
GFC_RESULTS_PRINT_OPT_V_EVENT	Print event by event information

---

Function Documentation

int GFC_resultsPrint	(	int	options,
		const GFC_result *	beg,
		const GFC_result *	end
	)

Prints the event-by-event result vector to the terminal.

Returns:

The number printed

Parameters:

	options	An options vector, expressed as a bit mask, controlling how verbose the display is.
	beg	The first results vector to print.
	end	The ending results vector

Currently only two options are supported GFC_RESULTS_PRINT_OPT_M_EVENT and GFC_RESULTS_PRINT_OPT_M_SUMMARY. These are documented in the interface file.

References _GFC_result::acd, _GFC_result::atf, _GFC_result::beg, _GFC_result::cal, _GFC_result::dir, _GFC_result::evtNum, _GFC_result::gem, GFC_RESULTS_PRINT_OPT_M_EVENT, GFC_RESULTS_PRINT_OPT_M_SUMMARY, GFC_V3__resultEnergyInLeuGet(), GFC_V3__resultStageGetL(), GFC_V3_STAGE_M_ACD, GFC_V3_STAGE_M_ATF, GFC_V3_STAGE_M_CAL, GFC_V3_STAGE_M_DIR, GFC_V3_STAGE_M_MPKT, GFC_V3_STAGE_M_TKR, _GFC_result::stageEnergy, _GFC_result::status, and _GFC_result::tkr.

int GFC_resultsWrite	(	const char *	fileName,
		const GFC_result *	beg,
		const GFC_result *	end
	)

Writes the event-by-event result vector to a file (binary).

Parameters:

	fileName	The name of the output file.
	beg	The first results vector to print.
	end	The ending results vector

References _GFC_result::acd, _OutRecord::acdElapsed, _GFC_result::atf, _OutRecord::atfElapsed, _GFC_result::beg, _GFC_result::cal, _OutRecord::calElapsed, _OutRecord::eventNum, _GFC_result::evtNum, _GFC_result::gem, _OutRecord::gemElapsed, _GFC_result::stageEnergy, _OutRecord::stageEnergy, _GFC_result::status, _OutRecord::status, _GFC_result::tkr, and _OutRecord::tkrElapsed.