HOW TO IMPLEMENT NEW ALGORITHMS IN VEGAS

Size: px

Start display at page:

Download "HOW TO IMPLEMENT NEW ALGORITHMS IN VEGAS"

Myra Phillips
5 years ago
Views:

1 1 HOW TO IMPLEMENT NEW ALGORITHMS IN VEGAS Tulun Ergin University of Massachusetts, Amherst

2 2 USEFUL WEB SITES VEGAS USER'S MANUAL OAWG WIKI PAGE recommended programing practice

3 3 Suggested Standards for VEGAS Consistent syntax over all the projects (or modules/packages) within vegas Avoid repetition of names of classes, functions, directory or sub directory names except as a part of a decided naming convention All projects and classes within vegas should be documented before coding further (coming slide)

4 4 Suggested Standards for VEGAS Read the coding standards from the OAWG WIKI site Read the Doxygen documentation guidelines guidelines Doxygen generated API browser

5 5 Suggested Doxygen Documentation Every.cpp source file should include a Doxygen head. An example head is shown here: /** \class Analysis::VEventSelector * \ingroup Analysis * \brief Loop over events and apply selection cuts * * This class loops over all events in the input files reads * the configuration file that includes the set of analysis * cuts, calls background selection classes, and spectrum * calculator classes. * * Original Author: Tulun Ergin * $Author: ergin$ * $Date: 2005/06/25 01:13:37$ * $Revision: 1.3$ * $Tag $ * * */

6 6 Where To Implement Your Classes Decide on to which stage in vegas your code should belong to stage 1&2 stage 3&4 stage 5&6 Calibration Parameterization & Shower Reconstruction Event Selection & Visualization DB Connection No DB Connection

7 7 Directory Structure within VEGAS Carefully implement your classes and copy into the existing directory structure stage1: calibcalculation stage 2: calibapplication stage 3: imageparameterization common SubDirectories out src bin include lib stage 4: showerreconstruction stage 5: eventselection stage 6: resultsextractor examples doc

8 8 Directory Structure within VEGAS If the module is called name then the sub directory structure looks like this: source files (*.cpp) go into name/src sub directory header files (*.h) go into name/include sub directory binaries go into name/bin sub directory output files (*.o) go into name/out sub directory library files (*.so, *.a) go into name/lib sub directory example Root macros (*.cpp or *.C) go into name/examples subdirectory

9 9 COMMON Tools 1 VATime GPS clock time storage and conversion to different systems VARootIO the interface to calibrated data format VDF files VAEvent the interface to the raw data format VBF files VACommon definitions, consts, enums, names that are found throughout the analysis VAGlobal configure global options and provide random number generators, debug objects, and other goodies VAArrayInfo quasi static telescope information such as telescope and pixel locations VARunHeader stores run specific information VAVDF wrapper class to access the calibrated, parameterized and reconstructed array level data

10 10 COMMON TOOLS 2 Data storage classes classes for storage of processed data Cutting classes classes for performing cuts on vegas data VAException class for handling exceptions TraceAnalysis VATraceManager, VATraceModifier, VATraceEvaluator, VATracePadder, VATraceNoise VACrateTimingCorrector class for checking for FADC crate jitter using the L2 pulse VABadChannelIdentifier class for identifying bad channels VAParameterData class for storage of parameterized data VAShowerData, VACoordinateData and VATelescopeData class for storage of reconstructed shower related data

11 11 General Design Considerations in VEGAS I/O Classes Data Classes Algorithm Classes: Base Classes Algorithm Classes: Factory Classes

12 12 General Design Considerations: Data Classes They don't have a functionality on their own They provide access to their data and have simple functions to manipulate their data Example stage1: VARelGainsData: holds all relative gain data for all channels for a telescope VATraceData: Holds calibration info of a single channel from a single event. Only non zero suppressed events exist. Example stage3: VAParameterData: holds all Hillas parameters

13 13 General Design Considerations: I/O Classes They centralize the input and output of data objects to files or the database Can access all parts of data file in an interactive Root session Example from VEGAS common module: VARootIO: This class has the capability to operate on a per file basis for the stages 1 and 2 but also can operate on multiple root files a time to help stages 4, 5 and 6 to join events from all runs. This class does not have any configuration options. Reference:

14 14 General Design Considerations: Algorithm Classes Base Classes Each algorithm is defined by a base class Specific realizations of the algorithm type implemented as derived classes Selection of specific algorithms done by factory class using the defined configuration scheme Example stage1: VARelativeGainsCalc: base class defining the algorithm for all relative gains VARelativeGainsCalcLaser: specific calculator that uses laser events Example stage3: VACleanUpApp: standard clean up algorithm VAEventDisplayCleanUpApp: eventdisplay specific clean up algorithm

15 15 General Design Considerations: Algorithm Classes Factory Classes Algorithm Instantiation done by Factory classes The instantiation through main() is removed Mutiple programs can use the factory without duplicating intstantiation code within main() Possible to have multiple factory classes within a module Example stage 1: VARelativeGainsCalcFactory class that creates instances of VARelativeGainsCalc/VARelativeGainsCalcLaser Example stage3: VACleanUpAppFactory class that creates instances of VACleanUpApp/VAEventDisplayCleanUpApp

16 16 General Design Considerations: The main() Function One main() function per module The required layout of the main function as well as a base class and its header file is given below:

17 17 More Documentation on This Topic OAWG WIKI General Design Consideration: OAWG WIKI Component Configuration: OAWG Error handling:

Coordinate Transformations for VERITAS in OAWG - Stage 4

Coordinate Transformations for VERITAS in OAWG - Stage 4 (11 June 2006) Tülün Ergin 1 Contents 1 COORDINATE TRANSFORMATIONS 1 1.1 Rotation Matrices......................... 1 1.2 Rotations of the Coordinates...................