---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > GRBP / V0-4-2

Constituent: grbpsiu     Tag: linux-gcc

---

         

---

GRBP_grb.c File Reference

Controls the context for entering and maintaining the description of a GRB. More...

#include "GRBP_grb.h"
#include "GRBP_locate.h"
#include "GRBP_location.h"
#include "GRBP_gammaList.h"
#include "GRBP_photonList.h"
#include "GRBP_window.h"
#include "GRBP_DB/GRBP_DB_grb.h"
#include <math.h>

Include dependency graph for GRBP_grb.c:

Defines
#define	NULL   ((void *)0)
Functions
int	GRBP_grbSizeof (const GRBP_DB_grb *cfg)
	Returns the size, in bytes, of the specified gamma context.
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.

---

Detailed Description

Controls the context for entering and maintaining the description of a GRB.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: GRBP_grb.c,v 1.4 2007/10/16 22:42:57 jgt Exp $

---

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

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

void GRBP_grbMessageLocate (  GRBP_grb *  grb  )

Updates the GRB message location. Parameters: grb  The GRB data atructure

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

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

void GRBP_grbSeedLocate (  GRBP_grb *  grb  )

Updates the GRB seed location. Parameters: grb  The GRB data atructure

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

---