GFC_resultsPrint.c File Reference

Provides routines to output the event-by-event gamma results vector to either a terminal (ASCII) or a file (BINARY). More...

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <EFC/GFC_resultsPrint.h>
#include <EFC/GFC_V3_status.h>
#include <GFC_resultDef.h>
#include <EDS/ECR_cal.h>
#include <EDS/TMR.h>

Classes
struct	_OutRecord
	The event-by-event output summary record. More...
Typedefs
typedef struct _OutRecord	OutRecord
	Typedef for struct _OutRecord.
Functions
int	GFC_resultsSizeof (void)
	Returns the size, in bytes, of a EFC result record.
static TMR_tick	printTime (int printIt, unsigned int *stage, int which, TMR_tick begTick, TMR_tick endTick, int *tot, int *cnt)
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

Provides routines to output the event-by-event gamma results vector to either a terminal (ASCII) or a file (BINARY).

Author:

JJRussell - russell@slac.stanford.edu

    CVS $Id

---

Typedef Documentation

OutRecord

Typedef for struct _OutRecord.

This record is a slight rearrangement of the GFC_result vector. In particular, times have been converted from internal units to nanoseconds and energies have been converted to Mev. Thus, except for endianness, the interpretation of this record is machine independent.

Warning:

The documentation for this record is always generated as if it were for the instrumented and development filter. If one is using the the flyable version of the filter code, only the status and stageEnergy word are defined.

---

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_resultsSizeof

(

void

)

Returns the size, in bytes, of a EFC result record.

Returns:

The size, in bytes, of a EFC result record.

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.