Software Structure

This section is organised as follows:-

Introduction to the Structure Tables
List of Structure Tables
List of Routine Names

NB These links will be broken until the HTML Version of the Code is installed.

Introduction to the Structure Tables

The purpose of the software structure tables is to help the reader understand the structure of the SNOlib code. The first level of structuring is the Software Units (SUs) for an introduction to the SU see "Doing More" in the SNOMAN User Manual To keep these tables to a manageable size, and hopefully more comprehensible, each SU is stored in a separate table.

In a few cases, an SU will be subdivided into two or more tables with introductory comments describing the substructure. References between tables are fully indentified in both directions to allow navigation between tables. There is also a

List of Routine Names

which lists in alphabetical order, all the routines described in these tables, giving links to the code and the owning SU table.

Each structure table is organised into the following sections:-

  1. Introduction A brief introduction to the SU.
  2. Titles Banks Used A list of the titles banks used by the SU.
  3. Initialisation Routines Externally called routine(s) to initialise it.
  4. Execution Routines Routine(s) that are externally called during execution.
  5. Termination Routines Externally called routine(s) to terminate it.
The top level routines listed in each table have hypertext links direct to the relevant HTML source code in which each call to another SNOlib function or subroutine is a hypertext link to it so that from these top level routines you can browse through SNOMAN. Calls to external libraries are shown in red. At the start of each SNOlib function or subroutine there is cross-reference link shown as:- 
   <<<
which links to a list of callers to it so navigation can be bi-directional.

List of Structure Tables

(see also List of Routine Names)

ANL: Event Analyser
ANX: Abnormal Channel Analysis
CAL: Event Calibration
CLN: Event Classifier: Network
CTD: Context specific Titles Dumper
DMM: Data Mask Manager
DSM: Data Structure Manager
DSP: Event Graphical Display
EGS: Electron and Gamma Shower
ECA: Electronics Calibration
EIO: Event I/O Support
FIO: File I/O Support
FLT: Event Filter
FPS: First Pass Run Selection
FT1: User Fitter 1
FTA: Attenuation Event Fitter
FTC: Stopping muon Event Fitter
FTE: Elastic Fitter
FTG: Grid Fitter
FTI: Muon Impact Parameter Fitter
FTK: Energy Fitter
FTM: Muon Fitter
FTN: nFTU Fitter
FTP: Path Fitter
FTQ: Quad Fitter
FTR: Through-going muon track fitter
FTT: Time Fitter
FTU: QPDF Fitter
GEO: Detector Geometry
HAD: Hadron Transport
HBK: HBOOK Support.
HST: Event Histogrammer
INP: Event Input
LSP: Livetime Summary
MCD: MC DAQ
MCE: MC Evolution
MCG: MC Generation
MCO: Monte Carlo
MES: Muon Event Selection
MPC: Multiphoton Correction
MSW: MSW Generator
MTT: Management of Titles
MXF: Max likelihood fit processor
NCA: NCD Electronics Calibration
NCC: NCD Correction Calibrator
NCL: NCD Event Calibrator
NHP: NCD Histogram Producer
NPF: NCD Pulse Fourier Transform
NTP: N-tuple
OUT: Event Output
OCA: Optical Calibration
PCA: PMT Calibration
PCK: Event Packer
PHI: Physics Interactions
PMT: PMT Simulation
PRU: Event Pruner
QIO: Root Tree I/O
RAA: Random Access Analyser
RAN: Random Number Generator
RDV: Raw Data Validation
RLG: Runlog Generator
RLR: Runlog Reader
RLO: Runlog Output
RSP: Energy Calibration
SDB: SNOMAN Database Interface
SHL: Shell
SIO: Generic FZ Input Output
SPS: Second Pass Run Selection
SUC: Software Unit Control
TCA: Time Correlation Analyser
TKN: Text Token Processing
TRF: Trigger Efficiency Processor
TSP: Time Spoiler Processor
UCL: Event UnCalibration
UNC: NCD Event UnCalibrator
UPK: Event Unpacker
USR: User Processor
UTL: Utilities
VIW: Event Viewer
XED: XSnoed Event Viewer
ZBR: ZEBRA

Go Back to the Snoman Companion Top Page

Highest link so far: 2:-
Software Structure Introduction to the Structure Tables
List of Structure Tables