GFC_resultDef.h File Reference

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

#include <EDS/TMR.h>

Classes
struct	_GFC_result
	Describes the event-by-event results of the gamma filtering process for the instrumented and development version of the filtering code. More...
Defines
#define	tmr_store(_where)   _where = TMR_GET()
	In the instrumented version of the filter, this macro gets and stores the current time. In other versions, it is a NOOP.
#define	ievt_store(_where, _ievt)   _where = (_ievt)
	In the instrumented version of the filter, this macro stores current event number.
Typedefs
typedef struct _GFC_result	GFC_result
	Typedef for GFC_result.

---

Detailed Description

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

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: GFC_resultDef.h,v 1.4 2011/03/27 04:55:30 russell Exp $

This defines two versions of the Gamma Result vector. One is a bare bones version used in flight, the other is used when instrumenting the filter for performance monitoring.

---

Define Documentation

#define ievt_store	(	_where,
		_ievt		)	_where = (_ievt)

In the instrumented version of the filter, this macro stores current event number.

Parameters:

	_where	Where to store the event number.
	_ievt	The event number to store

This macro is a NOOP in all but the instrumented version of the filter

Referenced by gammaFilter().

#define tmr_store

(

_where

)

_where = TMR_GET()

In the instrumented version of the filter, this macro gets and stores the current time. In other versions, it is a NOOP.

Parameters:

_where

Where to store the time

This macro is a NOOP in all but the instrumented version of the filter

Referenced by gammaFilter(), and tkrComplete().

---

Typedef Documentation

GFC_result

Typedef for GFC_result.

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.