GRBP_gamma.h File Reference

Definition of the information for a photon that graduated from the raw photon input stage to the GRB candidate. More...

#include <GRBP_photon.h>

Classes
struct	_GRBP_gamma
	Encapsulates the primary information stored for each GRB gamma. More...
struct	_GRBP_gammaAux
	Encapsulates the auxilliary information stored for each GRB gamma. More...
Typedefs
typedef struct _GRBP_gamma	GRBP_gamma
typedef struct _GRBP_gammaAux	GRBP_gammaAux
	Typedef struct _GRBP_gammaAux.
Functions
static __inline GRBP_gammaAux *	GRBP__gammaAuxLocate (const GRBP_gamma *gamma_head, const GRBP_gamma *gamma, GRBP_gammaAux *aux_head)
	Given a GRBP_gamma element, returns a pointer to the corresponding GRBP_gammaAux structure.

---

Detailed Description

Definition of the information for a photon that graduated from the raw photon input stage to the GRB candidate.

Author:

JJRussell - russell@slac.stanford.edu

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

---

Function Documentation

static __inline GRBP_gammaAux * GRBP__gammaAuxLocate	(	const GRBP_gamma *	gamma_head,
		const GRBP_gamma *	gamma,
		GRBP_gammaAux *	aux_head
	)			[static]

Given a GRBP_gamma element, returns a pointer to the corresponding GRBP_gammaAux structure.

Returns:

A pointer to the corresponding GRBP_gammaAux structure.

Parameters:

	gamma_head	The head of the array of gammas
	gamma	The target gamma structure
	aux_head	The head of the array of gamma auxilliary structures

This routine is an unabashed concession to efficiency. In order to minimize memory references the GRBP_gamma structure has been stripped to its bare essentially. The other information is stored in the GRBP_gammaAux structure. Given a pointer to a GRBP_gamma structure, this function allows one to locate the gammas corresponding auxilliary information structure. It is ugly, but it doing this is worth almost a factor of 2 in performance of the GRBP locate routine.

Referenced by GRBP_gammaListSeed().