---

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

Constituent: grbpsiu     Tag: linux-gcc

---

         

---

GRBP_clusterList.h File Reference

Cluster List management routines, interface. More...

#include "GRBP_probability.h"

Include dependency graph for GRBP_clusterList.h:

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

Data Structures
struct	_GRBP_clusterUpdateList
	Describes which clusters have been updated after a new photon has been added. By implication, these are the only clusters that need to be checked. More...
struct	_GRBP_clusterList
	Describes a array/circular list of clusters. More...
struct	_GRBP_clusterPrms
	Parameters/constants controlling the adding of a photon to a cluster presented in a form used directly by the code. More...
Defines
#define	GRBP_clusterListCheck(_clusterList, _clusterPrms, _nrange)
Typedefs
typedef _GRBP_cluster	GRBP_cluster
typedef _GRBP_DB_clusterList	GRBP_DB_clusterList
typedef _GRBP_clusterUpdateList	GRBP_clusterUpdateList
	Typedef for struct _GRBP_clusterUpdateList.
typedef _GRBP_clusterList	GRBP_clusterList
	Typedef for struct _GRBP_clusterList.
typedef _GRBP_clusterPrms	GRBP_clusterPrms
Functions
int	GRBP_clusterListSizeof (int clusterCount, int photonCount)
	Calculates the size, in bytes, to hold a cluster list with cluster_count clusters and a cross-reference array of for photon_count photons.
unsigned char *	GRBP_clusterListConstruct (GRBP_clusterList *clusterList, const GRBP_DB_clusterList *cfg, int photonCount, unsigned char *ptr)
	Constructs the cluster list according to the specified values.
void	GRBP_clusterListAdd (GRBP_clusterList *clusterList, const GRBP_clusterPrms *prms, double time, double energy, double dx, double dy, double dz)
	Adds photon to the clusterList using prms as the source of the parameters which control the calculation of the probabilities, both temporal and spatial, as well as the admittance criteria to call a photon a neighbor of another photon.
void	GRBP_clusterListReset (GRBP_clusterList *clusterList)
	Resets the specified cluster list.

---

Detailed Description

Cluster List management routines, interface.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: GRBP_clusterList.h,v 1.2 2007/08/02 17:24:59 russell Exp $

---

Function Documentation

void GRBP_clusterListAdd (  GRBP_clusterList *  clusterList, const GRBP_clusterPrms *  prms, double  time, double  energy, double  dx, double  dy, double  dz )

Adds photon to the clusterList using prms as the source of the parameters which control the calculation of the probabilities, both temporal and spatial, as well as the admittance criteria to call a photon a neighbor of another photon. Parameters: clusterList  The target cluster list. prms  The parameters controlling the promotion of a photon into a cluster. time  The time associated with the photon being added energy  The energy, in Mev, of the photon dx  The x direction cosine dy  The y direction cosine dz  The y direction cosine

unsigned char * GRBP_clusterListConstruct (  GRBP_clusterList *  clusterList, const GRBP_DB_clusterList *  cfg, int  photonCount, unsigned char *  ptr )

Constructs the cluster list according to the specified values. Returns: A pointer to the next available memory location Parameters: clusterList  The cluster list to construct cfg  The cluster list configuration photonCount  The number of photons on the master photon list. This is used to for a cross-reference list between a photon and a cluster member ptr  Pointer to the memory to carve the dynamically allocated arrays from.

void GRBP_clusterListReset (  GRBP_clusterList *  clusterList  )

Resets the specified cluster list. Parameters: clusterList  The cluster list to reset

int GRBP_clusterListSizeof (  int  cluster_count, int  photon_count )

Calculates the size, in bytes, to hold a cluster list with cluster_count clusters and a cross-reference array of for photon_count photons. Returns: The number of bytes to hold the specified cluster list. Parameters: cluster_count  The number of clusters and, implicitly, the size of each cluster (i.e. the number of neighbors), of the cluster list photon_count  The number of photons on the master photon list. This is used to for a cross-reference list between a photon and a cluster member

---