GRB.h File Reference

Gamma Ray Burst Analysis Code Defines the interface to and data structures containing the parameters used in processing and generating gamma ray burst alerts. More...

#include "PBS/WCT.h"

Include dependency graph for GRB.h:

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


Data Structures
struct	_GRB_alertMsg
	Structure containing a GRB alert message. More...
struct	_GRB_GbmCalc
	Structure containing a GBM Calc Info message. More...
struct	_GRB_GbmRpt
	Structure containing a GBM Repoint message. More...
struct	_GRB_GbmClose
	Structure containing a GBM Close message. More...
Typedefs
typedef enum _GRBSim_Modes	GRBSim_Modes
	Typedef for enum _GRBSim_Modes.
typedef void(*	GRB_suspectCb )(GRB_alertMsg *alert)
	Signature for a GRB Suspect Alert callback routine.
typedef void(*	GRB_updateCb )(GRB_alertMsg *alert)
	Signature for a GRB Update Alert callback routine.
typedef void(*	GRB_confirmCb )(GRB_alertMsg *alert, unsigned int dur)
	Signature for a GRB Confirm Alert callback routine.
typedef void(*	GRB_closeoutCb )(GRB_alertMsg *alert)
	Signature for a GRB Closeout Alert callback routine.
typedef unsigned int(*	GRB_attXformJCb )(const WCT_time t, const double Vl, double Vj)
	Signature for a GRB attitude J2000 transformation routine Transforms LAT cartesian vector to J2000.
typedef unsigned int(*	GRB_attXformSCb )(const double Vc, double Vs)
	Signature for a GRB attitude spherical transformation routine Transforms J2000 vector to RA,DEC spherical coordinates.
typedef WCT_time(*	GRB_timeLookupCb )(unsigned int gem_strobe, unsigned int gem_clk)
	Signature for a GRB time lookup routine.
typedef _GRB_alertMsg	GRB_alertMsg
	Typedef for struct _GRB_alertMsg.
typedef _GRB_GbmCalc	GRB_GbmCalc
	Typedef for struct _GRB_GbmCalc.
typedef _GRB_GbmRpt	GRB_GbmRpt
	Typedef for struct _GRB_GbmRpt.
typedef _GRB_GbmClose	GRB_GbmClose
	Typedef for struct _GRB_GbmClose.
Enumerations
enum	_GRBSim_Modes { GRBSIM_MODE_DISABLE = 0, GRBSIM_MODE_FULL = 1, GRBSIM_MODE_SUSPECT = 2, GRBSIM_MODE3 = 3, GRBSIM_MODE4 = 4, GRBSIM_MODE5 = 5 }
	LPA GRB Algorithm Simulation Modes. More...
Functions
int	GRB_sizeofAlgCtl (void)
	Returns the size of a algorithm control block.
int	GRB_initAlgCtl (GRB_algCtl *ctl)
	Initializes an algorithm control block.
int	GRB_registerCbs (GRB_algCtl *ctl, GRB_suspectCb suspect, GRB_updateCb update, GRB_confirmCb confirm, GRB_closeoutCb closeout, GRB_attXformJCb xformj, GRB_attXformSCb xforms, GRB_timeLookupCb lktime)
	Registers the posting routines for alert messaging.
int	GRB_handleEvents (GRB_algCtl ctl, void dat, unsigned int size, unsigned int prm)
	Processes GRB event summaries from the GRB filter. This is a counting simulation and transitions between detection states based on summary counters.
int	GRB_handleGbmInt (GRB_algCtl *ctl)
	Handle the GBM Interrupt.
int	GRB_handleGbmCalc (GRB_algCtl ctl, GRB_GbmCalc dat)
	Handle the GBM Calc Info command.
int	GRB_handleGbmRpt (GRB_algCtl ctl, GRB_GbmRpt dat)
	Handle the GBM Repoint command.
int	GRB_handleGbmClose (GRB_algCtl ctl, GRB_GbmClose dat)
	Handle the GBM Closeout command.
int	GRB_reset (GRB_algCtl *ctl)
	Reset the GRB algorithm control block.
int	GRB_loadDbSiu (GRB_algCtl *ctl, unsigned int fid, unsigned int instance)
	Loads the GRB_DB.
int	GRB_simConfig (GRB_algCtl *ctl, unsigned int mode, unsigned int repoint, unsigned int interval)
	Configure for a simulated GRB detection.
int	GRB_simDetect (GRB_algCtl *ctl)
	Simulate a GRB detection.

Detailed Description

Gamma Ray Burst Analysis Code Defines the interface to and data structures containing the parameters used in processing and generating gamma ray burst alerts.

Author:: Sergio Maldonado - smaldona@slac.stanford.edu

    CVS $Id: GRB.h,v 1.3 2007/03/15 17:00:56 smaldona Exp $

Typedef Documentation

GRB_alertMsg

Typedef for struct _GRB_alertMsg.

This structure describes the content of a GRB alert message.

unsigned int(* GRB_attXformJCb)(const WCT_time t, const double *Vl, double *Vj)

Signature for a GRB attitude J2000 transformation routine Transforms LAT cartesian vector to J2000.

Returns:
Status

Parameters:

t The timestamp for the attitude information.

Vl Input vector in LAT coordinates.
Vl[0] = x
Vl[1] = y
Vl[2] = z

Vj Output vector in J2000 coordinates.
Vj[0] = x
Vj[1] = y
Vj[2] = z

unsigned int(* GRB_attXformSCb)(const double *Vc, double *Vs)

Signature for a GRB attitude spherical transformation routine Transforms J2000 vector to RA,DEC spherical coordinates.

Returns:
Status

Parameters:

Vc The input vector in cartisian coordinates.
Vc[0] = x
Vc[1] = y
Vc[2] = z

Vs The output vector in spherical coordinates.
Vs[0] = ra
Vs[1] = dec

void(* GRB_closeoutCb)(GRB_Alert *alert)

Signature for a GRB Closeout Alert callback routine.

Returns:
Status

Parameters:

alert The alert message

void(* GRB_confirmCb)(GRB_Alert *alert, unsigned int dur)

Signature for a GRB Confirm Alert callback routine.

Returns:
Status

Parameters:

alert The alert message

dur Duration in seconds of the requested repoint

GRB_GbmCalc

Typedef for struct _GRB_GbmCalc.

This structure describes the content of a GBM Calc Info message.

GRB_GbmClose

Typedef for struct _GRB_GbmClose.

This structure describes the content of a GBM Close message.

GRB_GbmRpt

Typedef for struct _GRB_GbmRpt.

This structure describes the content of a GBM Repoint message.

void(* GRB_suspectCb)(GRB_Alert *alert)

Signature for a GRB Suspect Alert callback routine.

Returns:
Status

Parameters:

alert The alert message

WCT_time(* GRB_timeLookupCb)(unsigned int gem_strobe, unsigned int gem_clk)

Signature for a GRB time lookup routine.

Returns:
Wall clock time

Parameters:

gem_strobe strobe counter from GEM from event data

gem_clk clock counter from GEM from event data

void(* GRB_updateCb)(GRB_Alert *alert)

Signature for a GRB Update Alert callback routine.

Returns:
Status

Parameters:

alert The alert message

Enumeration Type Documentation

enum _GRBSim_Modes

LPA GRB Algorithm Simulation Modes.

Enumerator:

GRBSIM_MODE_DISABLE GRB detection simulation disabled

GRBSIM_MODE_FULL GRB detection simulation mode full

GRBSIM_MODE_SUSPECT GRB detection mode suspect only

GRBSIM_MODE3 GRB detection mode 3 unused

GRBSIM_MODE4 GRB detection mode 4 unused

GRBSIM_MODE5 GRB detection mode 5 unused

Function Documentation

int GRB_handleEvents ( GRB_algCtl * ctl,

void * dat,

unsigned int size,

unsigned int prm

)

Processes GRB event summaries from the GRB filter. This is a counting simulation and transitions between detection states based on summary counters.

Return values:

0,Success

-1,Failure

Parameters:

ctl The GRB algorithm control block

dat The GRB event summary block

size The GRB event summary size

prm The GRB event summary parameter

int GRB_handleGbmCalc ( GRB_algCtl * ctl,

GRB_GbmCalc * dat

)

Handle the GBM Calc Info command.

Return values:

0,Success

-1,Failure

int GRB_handleGbmClose ( GRB_algCtl * ctl,

GRB_GbmClose * dat

)

Handle the GBM Closeout command.

Return values:

0,Success

-1,Failure

int GRB_handleGbmInt ( GRB_algCtl * ctl )

Handle the GBM Interrupt.

Return values:

0,Success

-1,Failure

int GRB_handleGbmRpt ( GRB_algCtl * ctl,

GRB_GbmRpt * dat

)

Handle the GBM Repoint command.

Return values:

0,Success

-1,Failure

int GRB_initAlgCtl ( GRB_algCtl * ctl )

Initializes an algorithm control block.

Return values:

0 Success

-1 Failure

int GRB_loadDbSiu ( GRB_algCtl * ctl,

unsigned int fid,

unsigned int instance

)

Loads the GRB_DB.

Return values:

file key

-1,Failure

int GRB_registerCbs ( GRB_algCtl * ctl,

GRB_suspectCb suspect,

GRB_updateCb update,

GRB_confirmCb confirm,

GRB_closeoutCb closeout,

GRB_attXformJCb xformj,

GRB_attXformSCb xforms,

GRB_timeLookupCb lktime

)

Registers the posting routines for alert messaging.

Parameters:

ctl The GRB algorithm control block

suspect The suspect alert post routine

update The update alert post routine

confirm The confirm alert post routine

closeout The closeout alert post routine

xformj The J2000 coordinate transform routine

xforms The spherical coordinate transform routine

lktime The event time lookup routine

int GRB_reset ( GRB_algCtl * ctl )

Reset the GRB algorithm control block.

Return values:

0,Success

-1,Failure

int GRB_simConfig ( GRB_algCtl * ctl,

unsigned int mode,

unsigned int repoint,

unsigned int interval

)

Configure for a simulated GRB detection.

Return values:

0,Success

-1,Failure

Parameters:

ctl The GRB algorithm control block

mode The GRB simulation mode

repoint The GRB repoint time

interval The interval in seconds between state transitions

int GRB_simDetect ( GRB_algCtl * ctl )

Simulate a GRB detection.

Return values:

0,Success

-1,Failure

Parameters:

ctl The GRB algorithm control block

int GRB_sizeofAlgCtl ( void )

Returns the size of a algorithm control block.

Return values:

Size in bytes of algorithm control block

Generated on Sat Mar 17 06:42:19 2007 by

1.4.4

GRB.h File Reference

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation