---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > EFC / V4-1-0

Constituent: dgfc     Tag: rad750

---

         

---

GFC_statsPrint.c File Reference

Provides routines to output the summary statistics of the filtering process. More...

#include "EFC/GFC_statsPrint.h"
#include "GFC_statsDef.h"
#include "EFC/GFC_status.h"
#include "GFC_resultDef.h"
#include "EDS/ECR_cal.h"
#include <stdio.h>
#include <string.h>

Include dependency graph for GFC_statsPrint.c:

Defines
#define	ORDER_K_NEW_LINE   0xff
	Order to print a new line.
#define	ORDER_K_SUBTRACT   0xfe
	Order to subtract the next two values, title index is the 3rd.
#define	ORDER_K_ADD   0xfd
	Order to add values the next N parameters, (written as TITLE, N, <add indexes>.
Enumerations
enum	_TITLE_K {   TITLE_K_ANY_VETO = (64 + 0),   TITLE_K_PASS = (65 + 0) }
	Derived statistics titles. More...
Functions
static void	printHeader (const unsigned char *caption, int nenergies, const unsigned int *eneriges)
	Prints the header line of the statistics table.
static void	printBody (const GFC_stats *stats, unsigned int vetoes, int nenergies, const unsigned char titles[][18], const unsigned char *orders, int cnt, int flag)
	Prints the body of the statistics table.
void	GFC_statsPrint (const GFC_stats *stats, unsigned int vetoes)
	Prints the statistics block in ASCII format to standard output.
void	GFC_statsAltPrint (const GFC_stats *stats, unsigned int vetoes, int nenergies, const unsigned int *energies)
	Prints the statistics block in ASCII format to standard output.
Variables
static const unsigned char	Titles [66][18]
	The title lines for each of the statistical quantities.
static const unsigned char	AllOrder []
	Indicates the order that the fields should be printed.
static unsigned char	SurvivorOrder []
	Indicates the order that the fields should be printed.
static unsigned char	Totals []
	Indicates the order that the fields should be printed.

---

Detailed Description

Provides routines to output the summary statistics of the filtering process.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: GFC_statsPrint.c,v 1.5 2007/06/26 01:08:18 russell Exp $

---

Enumeration Type Documentation

enum _TITLE_K

Derived statistics titles. Enumerator: TITLE_K_ANY_VETO  Derived statistics ALL - NOT_VETOED TITLE_K_PASS  Derived statistic, Sum of passes

---

Function Documentation

void GFC_statsAltPrint (  const GFC_stats *  stats, unsigned int  vetoes, int  nenergies, const unsigned int *  energies )

Prints the statistics block in ASCII format to standard output. Parameters: stats  The statistics block to print. vetoes  The active vetoes nenergies  The number of energy bins energies  Array defining the upper limit of the energy bin.

void GFC_statsPrint (  const GFC_stats *  stats, unsigned int  vetoes )

Prints the statistics block in ASCII format to standard output. Parameters: stats  The statistics block to print. vetoes  The active vetoes

static void printBody (  const GFC_stats *  stats, unsigned int  vetoes, int  nenergies, const unsigned char  titles[][18], const unsigned char *  orders, int  cnt, int  flag )  [static]

Prints the body of the statistics table. Parameters: stats  The statistics to print. vetoes  The active vetoes nenergies  The number of energy bins titles  A set of titles to be associated with the statistics. orders  A series of orders selecting which statistics are to be printed from the cnts parameter and, by implication, the title string from the titles parameter. It also contains meta-commands like new line orders to aid in the readability cnt  The number of orders in the orders array. flag  Flag indicating to add the next group of 64 on

static void printHeader (  const unsigned char *  caption, int  nenergies, const unsigned int *  energies )  [static]

Prints the header line of the statistics table. Parameters: caption  A short (< 9 characters) description of the statistics being described. nenergies  The number of energy bins energies  The energy bins.

---

Variable Documentation

static const unsigned char AllOrder[] [static]

Indicates the order that the fields should be printed. Indicates the order that the fields in the uncut statistical block should be printed. Special sentinal values indicating new lines and other control functions.

static unsigned char SurvivorOrder[] [static]

Indicates the order that the fields should be printed. Indicates the order that the fields in the statistical block for the events surviving to the tracking stage should be printed. Special sentinal values indicating new lines and other control functions.

static unsigned char Totals[] [static]

Initial value: { STAT_K_NOVETOES } Indicates the order that the fields should be printed. Indicates the order that the fields in the statistical block for the events surviving to the tracking stage should be printed. Special sentinal values indicating new lines and other control functions.

---