GRBP_probCalculate.c File Reference

Support routines for calculating the spatial and temporal probabilities. More...

#include <GRBP_probCalculate.h>
#include <GRBP_math.h>
#include <dprintf.h>

Functions
const GRBP_probTemporalCtl *	GRBP_probTemporalConstruct (void)
	Constructs the lookup table for the time probability calculation.
const GRBP_probSpatialCtl *	GRBP_probSpatialConstruct (double log10_costhetamax)
	Constructs the control structure use to when computing the spatial probability.
float	GRBP_probSpatialCalculate (const GRBP_probSpatialCtl *ctl, float distance)
	Returns the log, base 10, of the spatial probability for the angular distance distance.
float	GRBP_probTemporalCalculate (const GRBP_probTemporalCtl *ctl, float delta_time)
	Returns the log, base 10, of the temporal probability for the specified time difference delta_time.
Variables
static GRBP_probSpatialCtl	SpatialCtl
	The control structure, mainly the lookup table, used in calculating the spatial probability.
static GRBP_probTemporalCtl	TemporalCtl
	The control structure, mainly the lookup table, used in calculating the temporal probability.

---

Detailed Description

Support routines for calculating the spatial and temporal probabilities.

Author:

JJRussell - russell@slac.stanford.edu

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

---

Function Documentation

float GRBP_probSpatialCalculate	(	const GRBP_probSpatialCtl *	ctl,
		float	distance
	)

Returns the log, base 10, of the spatial probability for the angular distance distance.

Returns:

The log, base 10, of the spatial probability.

Parameters:

	ctl	The control handle for calculating the spatial probability.
	distance	The angular separation expressed as 1 - dot_product.

References GRBP__probSpatialCalculate().

Referenced by GRBP_gammaListSeed(), and GRBP_windowTier2Update().

const GRBP_probSpatialCtl * GRBP_probSpatialConstruct

(

double

log10_costhetamax

)

Constructs the control structure use to when computing the spatial probability.

Returns:

Pointer to the control structure

Parameters:

log10_costhetamax

The log, base 10, of the cosine of the maximum opening angle, in radians. The maximum opening angle is the acceptance and is generally the equivalent of about ~115 degrees.

References _GRBP_probSpatialCtl::table, _Float::ul, and _Float::v.

Referenced by GRBP_probabilityPrmsEstablish().

float GRBP_probTemporalCalculate	(	const GRBP_probTemporalCtl *	ctl,
		float	delta_time
	)

Returns the log, base 10, of the temporal probability for the specified time difference delta_time.

Returns:

The log, base 10, of the spatial probability

Parameters:

	ctl	The control handle for calculating the temporal probability
	delta_time	The time difference

References GRBP__probTemporalCalculate().

Referenced by GRBP_gammaListSeed(), and GRBP_windowTier2Update().