GRBP_locate.h File Reference

Interface to the GRB location routines. More...

#include <GRB/GRB_latMsg.h>

Typedefs
typedef struct _GRBP_gamma	GRBP_gamma
	Typedef struct _GRBP_gamma.
typedef struct _GRBP_gammaList	GRBP_gammaList
typedef struct _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.2 2011/03/30 22:11:51 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

References GRBP_locateAll(), and GRBP_locateSelected().

Referenced by GRBP_grbMessageLocate(), GRBP_grbSeed(), and GRBP_grbSeedLocate().

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

References _GRBP_gammaList::beg, _Sdata::c, complete(), converged(), _Sdata::cutoff_distance, _Sdata::cutoff_weight2, dot_product(), _GRBP_gamma::dx, _GRBP_location::dx0, _GRBP_gamma::dy, _GRBP_location::dy0, _GRBP_gamma::dz, _GRBP_location::dz0, _GRBP_gammaList::end, estimate(), _GRBP_gammaList::gammas, get_weight2(), ITERATIONS, _GRBP_gammaList::max, normalize(), _Sdata::one, _Sdata::tolerance, and _Sdata::zero.

Referenced by GRBP__locate(), and GRBP_windowTier1LatUpdate().

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.

References _Sdata::c, complete(), converged(), _Sdata::cutoff_distance, _Sdata::cutoff_weight2, dot_product(), _GRBP_gamma::dx, _GRBP_location::dx0, _GRBP_gamma::dy, _GRBP_location::dy0, _GRBP_gamma::dz, _GRBP_location::dz0, get_weight2(), ITERATIONS, normalize(), _GRBP_gamma::nxt, _Sdata::one, _Sdata::tolerance, and _Sdata::zero.

Referenced by GRBP__locate().