---

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

Constituent: grbpsiu     Tag: sun-gcc

---

         

---

GRBP_locate.h File Reference

Interface to the GRB location routines. More...

#include "GRB/GRB_latMsg.h"

Include dependency graph for GRBP_locate.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef _GRBP_gamma	GRBP_gamma
	Typedef struct _GRBP_gamma.
typedef _GRBP_gammaList	GRBP_gammaList
typedef _GRBP_location	GRBP_location
Functions
void	GRBP_locateAll (GRBP_location *loc, const GRBP_location *guess, GRBP_gammaList *list)
	Calculates the position using only those photons in the energy selected list.
void	GRBP_locateSelected (GRBP_location *loc, const GRBP_location *guess, GRBP_gamma *gammas)
	Calculates the position using only those photons in the energy selected list.
static __inline GRB_latAlertMsgLocMethod	GRBP__locate (GRBP_location *loc, const GRBP_location *guess, GRBP_gamma *gammas, GRBP_gammaList *list)
	Picks the location method, base on whether the linked list of gammas is non-NULL. If so it will use that list, otherwise it will use the list.

---

Detailed Description

Interface to the GRB location routines.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: GRBP_locate.h,v 1.1.1.1 2007/06/18 00:42:58 russell Exp $

---

Typedef Documentation

GRBP_gamma

Typedef struct _GRBP_gamma. For performance reasons, it is desirable that this structure includes only what is absolutely necessary to compute a new location. This minimizes the cache misses. Any other information is kept in a lookaside structure GRBP_gammaAux.

---

Function Documentation

static __inline GRB_latAlertMsgLocMethod GRBP__locate (  GRBP_location *  loc, const GRBP_location *  guess, GRBP_gamma *  gammas, GRBP_gammaList *  list )  [static]

Picks the location method, base on whether the linked list of gammas is non-NULL. If so it will use that list, otherwise it will use the list. Return values: GRB_LATALERTMSG_LOCMETHOD_ENERGY,if  the linked list of energy selected gammas was used GRB_LATALERTMSG_LOCMETHOD_ALL,if  the circular list of all gammas was used Parameters: loc  The location structure to fill in guess  The initial guess gammas  A linked list of gammas to use list  A count circular list of gammas to use if the link list is empty

void GRBP_locateAll (  GRBP_location *  loc, const GRBP_location *  guess, GRBP_gammaList *  list )

Calculates the position using only those photons in the energy selected list. Parameters: loc  The data structure to receive the calculated location guess  The location to use as a guess for the first iteration list  The circular list of gammas to use

void GRBP_locateSelected (  GRBP_location *  loc, const GRBP_location *  guess, GRBP_gamma *  gammas )

Calculates the position using only those photons in the energy selected list. Parameters: loc  The data structure to receive the calculated location guess  The location to use as a guess for the first iteration gammas  The first in the linked list of gammas used to calculate the position.

---