GLAST / LAT > DAQ and FSW > FSW > Doxygen Index> GRBP / dev > grbpsiu / rhel5-32

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » PHY » source » GRBP » dev » src

GRBP_window.h File Reference

Interface to the routines that maintain the list of gammas to be used in the localization process. More...

#include <GRBP_windowState.h>
#include <GRBP_gammaList.h>
#include <GRBP_gamma.h>
#include <GRBP_location.h>
#include <GRBP_probability.h>
#include <GRBP_messageSchedule.h>
#include <GRBP_locationSchedule.h>

Classes

struct  _GRBP_windowTier1Prms
 Static parameters that define the tier1 window. More...
struct  _GRBP_windowTier1
 The tier 1 list of gammas + their configuration/control parameters. More...
struct  _GRBP_windowTier2Prms
 The parameters controlling the tiers gamma list. More...
struct  _GRBP_windowTier2
 The tier 2 list of gammas + their configuration/control parameters. More...
struct  _GRBP_windowGrbPrms
struct  _GRBP_windowGrb
 Window specific GRB parameters. These are used after a window has declared a GRB, but are specific to this window. More...
struct  _GRBP_window
 The window context. More...

Typedefs

typedef struct
_GRBP_gammaListUpdatePrms 		GRBP_gammaListUpdatePrms
typedef struct _GRBP_DB_window GRBP_DB_window
typedef struct _GRBP_cache GRBP_cache
 Typedef struct _GRBP_cache.
typedef enum _GRBP_windowType GRBP_windowType
 Typedef for enum _GRBP_windowType.
typedef struct
_GRBP_windowTier1Prms 		GRBP_windowTier1Prms
 Typedef for struct _GRBP_windowTier1Prms.
typedef struct _GRBP_windowTier1 GRBP_windowTier1
 Typedef for struct GRBP_windowTier1.
typedef struct
_GRBP_windowTier2Prms 		GRBP_windowTier2Prms
 Typedef for struct _GRBP_windowTiersPrms.
typedef struct _GRBP_windowTier2 GRBP_windowTier2
 Typedef for struct GRBP_windowTier2.
typedef struct _GRBP_windowGrbPrms GRBP_windowGrbPrms
 Typedef for struct _GBBP_windowGrbPrms.
typedef struct _GRBP_windowGrb GRBP_windowGrb
 Typedef for GRBP_windowGrb.
typedef struct _GRBP_window GRBP_window
 Typedef for struct _GRBP_window.

Enumerations

enum  _GRBP_windowType {
  GRBP_WINDOW_TYPE_K_LAT = 0,
  GRBP_WINDOW_TYPE_K_GBM = 1
}
 The window type, either LAT or GBM. More...

Functions

int GRBP_windowAdd (GRBP_window *window, GRBP_cache *cache)
unsigned char * GRBP_windowConstruct (GRBP_window *window, const GRBP_DB_window *cfg)
 Constructs the list used in the localization process.
void GRBP_windowReset (GRBP_window *window)
 Resets the window context.
int GRBP_windowSizeof (const GRBP_DB_window *window)
 Computes the number of bytes needed for a window list of cnt elements.
int GRBP_windowSuspectCheck (GRBP_window *window, int added)
GRBP_windowState GRBP_windowTier1LatUpdate (GRBP_window *window, GRBP_cache *cache)
 Adds any new photons that are in clusters that pass the selection criteria, merges them onto the list maintained by this window and, if necessary, performs a localization on these photons.
GRBP_windowState GRBP_windowTier2Update (GRBP_window *window, GRBP_cache *cache)
 Check to see if the newest photon in the cache of input photons should be added to this tier 2 window.
GRBP_windowState GRBP_windowTier2GbmSeed (GRBP_window *window, const GRBP_cache *cache, double dx, double dy, double dz, double time)
 Based on the location from the GBM, this seeds the tier 2 list of gammas from the input photon cache.
void GRBP_windowCheck (const GRBP_window *window, const GRBP_cache *cache)

Detailed Description

Interface to the routines that maintain the list of gammas to be used in the localization process.

Author:
JJRussell - russell@slac.stanford.edu

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

Typedef Documentation

GRBP_windowTier2Prms

Typedef for struct _GRBP_windowTiersPrms.

This set of parameters controls the entering of photons into the tier2 stage of processing and, ultimately the declaration of GRB.

Enumeration Type Documentation

enum _GRBP_windowType

The window type, either LAT or GBM.

Enumerator:
GRBP_WINDOW_TYPE_K_LAT  Window is a LAT window
GRBP_WINDOW_TYPE_K_GBM  Window is a GBM window

Function Documentation

unsigned char * GRBP_windowConstruct ( GRBP_window *  window,
const GRBP_DB_window *  cfg 
)

Constructs the list used in the localization process.

Returns:
The new memory pointer
Parameters:
window The window to construct
cfg The configuration for the window list

References _GRBP_window::grb, _GRBP_window::name, _GRBP_window::rsvd, _GRBP_window::tier1, _GRBP_window::tier2, _GRBP_window::type, windowGrbConstruct(), windowTier1Construct(), and windowTier2Construct().

Referenced by GRBP_windowListConstruct().

void GRBP_windowReset ( GRBP_window *  window  ) 

Resets the window context.

Parameters:
window The window to be reset
This routine is generally called after a GRB has been declared over. It clears out any stale context, readying the window context for the next detection round.

References _GRBP_window::grb, GRBP_WINDOWSTATE_K_TIER1, _GRBP_window::state, _GRBP_window::tier1, _GRBP_window::tier2, windowGrbReset(), windowTier1Reset(), and windowTier2Reset().

Referenced by windowListReset(), and windowStateCheck().

int GRBP_windowSizeof ( const GRBP_DB_window *  cfg  ) 

Computes the number of bytes needed for a window list of cnt elements.

Returns:
The number of bytes needed for a window specified by cfg
Parameters:
cfg The window configuration values

References windowGrbSizeof(), windowTier1Sizeof(), and windowTier2Sizeof().

Referenced by GRBP_windowListSizeof().

GRBP_windowState GRBP_windowTier1LatUpdate ( GRBP_window *  window,
GRBP_cache *  cache 
)

Adds any new photons that are in clusters that pass the selection criteria, merges them onto the list maintained by this window and, if necessary, performs a localization on these photons.

Returns:
The window state
Parameters:
window The window context
cache The input photon cache

References _GRBP_cache::clusterList, _GRBP_windowTier1::clusterPlogs, _GRBP_clusterList::clusters, _GRBP_clusterUpdateList::cnt, _GRBP_clusterList::cnt, _GRBP_clusterList::cur, _GRBP_location::dx0, _GRBP_location::dy0, _GRBP_location::dz0, _GRBP_windowTier1::gammas, _GRBP_gammaList::gammas_aux, GRBP_clusterGammasGather(), GRBP_gammaListAdd(), GRBP_locateAll(), GRBP_WINDOWSTATE_K_TIER1, _GRBP_windowTier2::list, _GRBP_clusterUpdateList::list, _GRBP_windowTier2::location, _GRBP_clusterList::max, _GRBP_windowTier1Prms::nrange, _GRBP_photonList::pcur, _GRBP_cache::photonList, _GRBP_windowTier1::prms, _GRBP_windowTier1Prms::temporal_contrast, _GRBP_windowTier1Prms::threshold, _GRBP_window::tier1, _GRBP_window::tier2, _GRBP_photon::time, _GRBP_gammaAux::time, _GRBP_clusterList::upd, windowTier2Seed(), and wrap_lo().

Referenced by windowListTier1LatUpdate().

GRPB_windowState GRBP_windowTier2GbmSeed ( GRBP_window *  window,
const GRBP_cache *  cache,
double  dx0,
double  dy0,
double  dz0,
double  time 
)

Based on the location from the GBM, this seeds the tier 2 list of gammas from the input photon cache.

Returns:
The window state
Parameters:
window The window context
cache The master list of photons
dx0 The normalized X direction cosine of the GRB location
dy0 The normalized Y direction cosine of the GRB location
dz0 The normalized Y direction cosine of the GRB location
time The time that this was declared, (Really the time of the GBM calculation message.)

References _GRBP_location::dx0, _GRBP_location::dy0, _GRBP_location::dz0, _GRBP_windowTier2::location, _GRBP_window::tier2, and windowTier2Seed().

GRBP_windowState GRBP_windowTier2Update ( GRBP_window *  window,
GRBP_cache *  cache 
)

Check to see if the newest photon in the cache of input photons should be added to this tier 2 window.

Returns:
The window state
Parameters:
window The window context
cache The input photon cache

References _GRBP_gammaList::cnt, _GRBP_windowTier2Prms::distance, _GRBP_gamma::dx, _GRBP_photon::dx, _GRBP_location::dx0, _GRBP_gamma::dy, _GRBP_photon::dy, _GRBP_location::dy0, _GRBP_gamma::dz, _GRBP_photon::dz, _GRBP_location::dz0, _GRBP_gammaList::end, _GRBP_gammaAux::energy, _GRBP_photon::energy, _GRBP_gammaList::gammas, _GRBP_gammaList::gammas_aux, GRBP_probSpatialCalculate(), GRBP_probTemporalCalculate(), _GRBP_windowTier2::list, _GRBP_windowTier2::location, _GRBP_gamma::nxt, _GRBP_photonList::pcur, _GRBP_cache::photonList, _GRBP_windowTier2::plog, _GRBP_windowTier2::prms, _GRBP_windowTier2Prms::probability, _GRBP_probabilityPrms::psc, _GRBP_probabilityPrms::ptc, _GRBP_probabilityLogs::spatial, _GRBP_window::state, _GRBP_probabilityLogs::temporal, _GRBP_window::tier2, _GRBP_gammaAux::time, _GRBP_photon::time, and windowStateCheck().

Referenced by windowListTier2Update().

Generated on Wed Sep 28 09:49:30 2011 by  doxygen 1.5.8