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

Constituent: grbpsiu     Tag: linux-gcc


Interface   Data Structures   File List   Data Fields   Globals  

GRBP_cluster.h File Reference

Interface to the clustering portion of the GRB algorithm. More...

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


Data Structures

struct  _GRBP_neighborInfo
 The information about the neighboring photons. More...
struct  _GRBP_neighborList
 Maintains a list of photons that are close to some other photon. More...
struct  _GRBP_cluster

Typedefs

typedef _GRBP_photon GRBP_photon
 Typedef struct _GRBP_photon.
typedef _GRBP_cluster GRBP_cluster
typedef _GRBP_clusterPrms GRBP_clusterPrms
 Typedef for struct _GRBP_clusterPrms.
typedef _GRBP_probabilityLogs GRBP_probabilityLogs
typedef _GRBP_neighborInfo GRBP_neighborInfo
 Typedef struct _GRBP_neighborInfo.
typedef _GRBP_neighborList GRBP_neighborList
 Typedef struct _GRBP_neighborList.

Functions

int GRBP_clusterGammasGather (const GRBP_cluster *clusters, int beg, int end, int max, const unsigned short int *list, int cnt, double contrast, double threshold, unsigned int *bl, GRBP_probabilityLogs *plog_max)
 Scans the circular list of clusters looking for clusters that are over the probability threshold. A list of photons that are members of such clusters is accumulated (in the form of a bit list) and returned in masks.

Detailed Description

Interface to the clustering portion of the GRB algorithm.

Author:
JJRussell - russell@slac.stanford.edu
   CVS $Id: GRBP_cluster.h,v 1.4 2007/08/10 20:47:53 russell Exp $

Function Documentation

int GRBP_clusterGammasGather const GRBP_cluster *  clusters,
int  beg,
int  end,
int  max,
const unsigned short int *  list,
int  cnt,
double  contrast,
double  threshold,
unsigned int *  bl,
GRBP_probabilityLogs plog_max
 

Scans the circular list of clusters looking for clusters that are over the probability threshold. A list of photons that are members of such clusters is accumulated (in the form of a bit list) and returned in masks.

Returns:
The number of masks that need to be scanned
Parameters:
clusters The circular list of clusters
beg The index of the first cluster to consider
end The index of the last cluster to consider. Note that this is the actual last cluster, not one past it.
max The number of clusters in the circular list. This determines the wrap-around point
list A list of all clusters, by index, that have had photons added to their neighbor list. These are the only clusters that need to be checked, and of these only those in the beg,end interval are valid for the window being considered. This list is ordered from oldest to newest photon.
cnt The number of indices in list.
contrast The temporal contrast factor. The log of the temporal probability will be multiplied by this factor when computing the sum of the spatial and temporal probabilities
threshold The cluster threshold
bl The bit list to fill in with the gammas
plog_max Argument to receive the logs of spatial and temporal probabilities from the cluster with the largest total probability. This is filled if and only if the total probability exceeds threshold.


Generated on Mon Oct 29 03:03:53 2007 by  doxygen 1.4.4