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

Constituent: igfc     Tag: sun-gcc

Interface   Data Structures   File List   Data Fields   Globals  
g » glast » flight » PHY » source » EFC » V4-1-2 » EFC

GFC_resultsPrint.h File Reference

Defines the interface for summarizing the event-by-event results of the gamma filtering process. More...

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


Typedefs

typedef enum _GFC_RESULTS_PRINT_OPT_V GFC_RESULTS_PRINT_OPT_V
 Typedef for enum _GFC_M_RESULTS_PRINT_OPT_V.
typedef enum _GFC_RESULTS_PRINT_OPT_M GFC_RESULTS_PRINT_OPT_M
 Typedef for enum _GFC_RESULTS_PRINT_OPT_M.

Enumerations

enum  _GFC_RESULTS_PRINT_OPT_V {
  GFC_RESULTS_PRINT_OPT_V_SUMMARY = 0,
  GFC_RESULTS_PRINT_OPT_V_EVENT = 1
}
 Enumerates the print options for the GFC_resultsPrint routine as bit offsets. More...
enum  _GFC_RESULTS_PRINT_OPT_M {
  GFC_RESULTS_PRINT_OPT_M_SUMMARY,
  GFC_RESULTS_PRINT_OPT_M_EVENT,
  GFC_RESULTS_PRINT_OPT_M_ALL = 0xffff
}
 Enumerates the print options for the GFC_resultsPrint routine as bit masks. More...

Functions

int GFC_resultsPrint (int options, const GFC_result *beg, const GFC_result *end)
 Prints the event-by-event result vector to the terminal.
int GFC_resultsWrite (const char *fileName, const GFC_result *beg, const GFC_result *end)
 Writes the event-by-event result vector to a file (binary).

Detailed Description

Defines the interface for summarizing the event-by-event results of the gamma filtering process.

Author:
JJRussell - russell@slac.stanford.edu
    CVS $Id: GFC_resultsPrint.h,v 1.2 2005/11/22 02:32:06 russell Exp $

Enumeration Type Documentation

enum _GFC_RESULTS_PRINT_OPT_M
 

Enumerates the print options for the GFC_resultsPrint routine as bit masks.

Enumerator:
GFC_RESULTS_PRINT_OPT_M_SUMMARY  Print the summary information
GFC_RESULTS_PRINT_OPT_M_EVENT  Print the event by event information
GFC_RESULTS_PRINT_OPT_M_ALL  Print all the information

enum _GFC_RESULTS_PRINT_OPT_V
 

Enumerates the print options for the GFC_resultsPrint routine as bit offsets.

Enumerator:
GFC_RESULTS_PRINT_OPT_V_SUMMARY  Print the summary information
GFC_RESULTS_PRINT_OPT_V_EVENT  Print event by event information

Function Documentation

int GFC_resultsPrint (  int  options,
const GFC_result *  beg,
const GFC_result *  end
) 
 

Prints the event-by-event result vector to the terminal.

Returns:
The number printed
Parameters:
options An options vector, expressed as a bit mask, controlling how verbose the display is.
beg The first results vector to print.
end The ending results vector
Currently only two options are supported GFC_RESULTS_PRINT_OPT_M_EVENT and GFC_RESULTS_PRINT_OPT_M_SUMMARY. These are documented in the interface file.

int GFC_resultsWrite (  const char *  fileName,
const GFC_result *  beg,
const GFC_result *  end
) 
 

Writes the event-by-event result vector to a file (binary).

Parameters:
fileName The name of the output file.
beg The first results vector to print.
end The ending results vector

Generated on Thu Sep 4 01:48:28 2008 by  doxygen 1.4.4