GRBP_grb.h File Reference

Interface to the routines that maintain and access the GRB description. This description includes

1. List of gammas thought to be from the GRB
2. Location of the GRB
3. Message schedule.

More...

#include <GRBP_gammaList.h>
#include <GRBP_location.h>
#include <GRBP_skew.h>
#include <GRB/GRB_latMsg.h>

Classes
struct	_GRBP_grbUpdatePrms
	Holds the parameters that update the GRB gamma list after a GRB trigger has been declared. More...
struct	_GRBP_grbLocations
	Holds the two locations and one for the seed location and one for the alert messages. More...
struct	_GRBP_grb
	Defines the data structure used for the GRB description. More...
Typedefs
typedef struct _GRBP_window	GRBP_window
typedef struct _GRBP_photonList	GRBP_photonList
	Typedef struct _GRBP_photonList.
typedef struct _GRBP_messageSchedule	GRBP_messageSchedule
	Typedef for struct _GRBP_messageSchedule.
typedef struct _GRBP_locationSchedule	GRBP_locationSchedule
	Typedef for struct _GRBP_locationSchedule.
typedef struct _GRBP_DB_grb	GRBP_DB_grb
typedef struct _GRBP_grbUpdatePrms	GRBP_grbUpdatePrms
	Typedef for struct _GRBP_grbUpdatePrms.
typedef struct _GRBP_grbLocations	GRBP_grbLocations
	Typedef for struct _GRBP_grbLocations.
typedef struct _GRBP_grb	GRBP_grb
	Typedef struct _GRBP_grb.
Functions
unsigned char *	GRBP_grbConstruct (GRBP_grb *grb, const GRBP_DB_grb *cfg, unsigned char *ptr)
	Constructs the specified GRB data structure.
int	GRBP_grbAdd (GRBP_grb *grb, unsigned int lid, double time, double energy, double dx, double dy, double dz)
	If the photon passes the cuts, this photon is added to the list candidate GRB gammas.
void	GRBP_grbMessageLocate (GRBP_grb *grb)
	Updates the GRB message location.
void	GRBP_grbSeedLocate (GRBP_grb *grb)
	Updates the GRB seed location.
void	GRBP_grbReset (GRBP_grb *grb)
	Resets the GRB context. This is normally called after a GRB has been declared over.
int	GRBP_grbSeed (GRBP_grb *grb, GRBP_window *window)
	This function is used to seed the gamma list associated with the specified window with photons. It is really glorified copy.
int	GRBP_grbSizeof (const GRBP_DB_grb *cfg)
	Returns the size, in bytes, of the specified gamma context.

---

Detailed Description

Interface to the routines that maintain and access the GRB description. This description includes

1. List of gammas thought to be from the GRB
2. Location of the GRB
3. Message schedule.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: GRBP_grb.h,v 1.3 2011/03/30 22:11:51 russell Exp $

---

Typedef Documentation

GRBP_locationSchedule

Typedef for struct _GRBP_locationSchedule.

This is an unfortunate structure. Ideally one would like to recalculate the position of the GRB with every new gamma. However, this process is so slow, that one can only do it so often. This controls that scheduling of that process.

---

Function Documentation

int GRBP_grbAdd	(	GRBP_grb *	grb,
		unsigned int	lid,
		double	time,
		double	energy,
		double	dx,
		double	dy,
		double	dz
	)

If the photon passes the cuts, this photon is added to the list candidate GRB gammas.

Return values:

	0,photon	not added
	1,photon	added

Parameters:

	grb	The GRB handle
	lid	The photon's local index. This is the count of photons received
	time	The time associated with the photon
	energy	The energy, in Mev, of the photon
	dx	The x direction cosine
	dy	The y direction cosine
	dz	The y direction cosine

References _GRBP_gammaList::beg, _GRBP_gammaList::cnt, _GRBP_gamma::dx, _GRBP_location::dx0, _GRBP_gamma::dy, _GRBP_location::dy0, _GRBP_gamma::dz, _GRBP_location::dz0, _GRBP_gammaList::end, _GRBP_gammaAux::energy, _GRBP_gammaList::gammas, _GRBP_gammaList::gammas_aux, _GRBP_window::grb, _GRBP_grb::list, _GRBP_grb::loc_cnt, _GRBP_grb::loc_tail, _GRBP_grb::location, _GRBP_gammaList::max, _GRBP_gamma::nxt, _GRBP_windowGrb::prms, _GRBP_grbLocations::seed, _GRBP_gammaAux::time, _GRBP_grb::window, and wrap_hi().

Referenced by GRBP_clientProcess().

unsigned char * GRBP_grbConstruct	(	GRBP_grb *	grb,
		const GRBP_DB_grb *	cfg,
		unsigned char *	ptr
	)

Constructs the specified GRB data structure.

Returns:

Pointer to the new available memory location

Parameters:

	grb	The GRB data structure to construct
	cfg	The GRB configuration
	ptr	Pointer to the memory used to allocate the variable piece of the structure from

References _GRBP_skew::dec, GRBP_gammaListConstruct(), _GRBP_grb::list, _GRBP_skew::ra, and _GRBP_grb::skew.

Referenced by GRBP_clientConstruct().

void GRBP_grbMessageLocate

(

GRBP_grb *

grb

)

Updates the GRB message location.

Parameters:

grb

The GRB data atructure

References GRBP__locate(), _GRBP_grbLocations::guess, _GRBP_grb::list, _GRBP_grb::loc_head, _GRBP_grb::location, _GRBP_grbLocations::message, and _GRBP_grbLocations::method.

Referenced by confirmCheck(), stop(), and updateCheck().

void GRBP_grbReset

(

GRBP_grb *

grb

)

Resets the GRB context. This is normally called after a GRB has been declared over.

Parameters:

grb

The GRB context to reset

References GRBP_gammaListReset(), _GRBP_grb::list, _GRBP_grb::loc_cnt, _GRBP_grb::loc_head, _GRBP_grb::loc_tail, and _GRBP_grb::window.

Referenced by latReset().

int GRBP_grbSeed	(	GRBP_grb *	grb,
		GRBP_window *	window
	)

This function is used to seed the gamma list associated with the specified window with photons. It is really glorified copy.

Returns:

The number of photons sown

Parameters:

	grb	The GRB data structure
	window	The triggering window

References _GRBP_gammaList::beg, _GRBP_gammaList::cnt, _GRBP_gammaList::end, _GRBP_gammaAux::energy, _GRBP_gammaList::gammas, _GRBP_gammaList::gammas_aux, _GRBP_window::grb, GRBP__locate(), _GRBP_grbLocations::guess, _GRBP_grb::list, _GRBP_windowTier2::list, _GRBP_grb::loc_cnt, _GRBP_grb::loc_head, _GRBP_grb::loc_tail, _GRBP_windowTier2::location, _GRBP_grb::location, _GRBP_grbLocations::message, _GRBP_grbLocations::method, _GRBP_gamma::nxt, _GRBP_windowGrb::prms, _GRBP_grbLocations::seed, _GRBP_window::tier2, _GRBP_gammaAux::time, and _GRBP_grb::window.

Referenced by grbDeclare().

void GRBP_grbSeedLocate

(

GRBP_grb *

grb

)

Updates the GRB seed location.

Parameters:

grb

The GRB data atructure

References GRBP__locate(), _GRBP_grbLocations::guess, _GRBP_grb::list, _GRBP_grb::loc_head, _GRBP_grb::location, and _GRBP_grbLocations::seed.

Referenced by GRBP_clientProcess().

int GRBP_grbSizeof

(

const GRBP_DB_grb *

cfg

)

Returns the size, in bytes, of the specified gamma context.

Returns:

The size, in bytes, of the specified GRB data structure

Parameters:

cfg

The configuration of the GRB data structure

References GRBP_gammaListSizeof().

Referenced by GRBP_clientSizeof().