Classes
Tutorial programs

Classes

class  AnalyzerNS::Analyzer
 Module to analyze photoelectrons produced by particle injection. More...
 
class  DeprecationExample
 Example of using the Deprecation package. More...
 
class  GenerateDenseArrayNS::GenerateDenseArray
 Example module for generating a "dense" array. More...
 
class  GeometryExampleNS::GeometryExample
 Example of using the Geometry package. More...
 
class  OverrideConfigNS::OverrideConfig
 Example of overriding parameters in a configuration file. More...
 
class  ReadAerosolHLNS::ReadAerosolHL
 Example of reading from high level Aerosol DB. More...
 
class  ReadAerosolLLNS::ReadAerosolLL
 Example of reading from low level Aerosol DB interface. More...
 
class  ReadAtmQualityLLNS::ReadAtmQualityLL
 Example of reading from atmospheric quailty database. More...
 
class  ReadCloudHLNS::ReadCloudHL
 Example of reading from low level Cloud DB interface. More...
 
class  ReadCloudLLNS::ReadCloudLL
 Example of reading from low level Cloud DB interface. More...
 
class  ReadFDCalibNS::ReadFDCalib
 Example of reading FD calibration constants from database. More...
 
class  ReadLidarLLNS::ReadLidarLL
 Example of reading from low level Lidar DB interface. More...
 
class  ReadMolecularHLNS::ReadMolecularHL
 Example of reading from high level Molecular DB. More...
 
class  ReadMolecularLLNS::ReadMolecularLL
 Example of reading from low level Molecular DB interface. More...
 
class  StationListCreatorModuleNS::StationListCreatorModule
 Module to create an up-to-date xml station list file. More...
 
class  SuperModuleNS::SuperModule
 Example of calling modules from within another module. More...
 

Detailed Description

The Tutorial programs are simple examples illustrating how to use different parts of the Offline framework to carry out common tasks. The tutorials are located in:

path-to-offline-install/share/auger-offline/doc/Tutorials

Here is a copy of the README from that area, which has a short description of each tutorial:

===============================================================
This directory contains a number of small examples of using the 
offline framework for various things.  For the most part, these 
are meant to be simple, bite-sized examples which 
illustrate a single, limited task.  (In contrast, the  
Examples directory contains full-blown simulation and 
reconstruction examples).  If you have a particular example
in mind you think would benefit the collaboration, or humanity as 
a whole, please feel free to post an item about it on the
bugzilla:  http://www.auger.unam.mx/bugzilla
It's even better if you send along the code for it!
===============================================================

ReadMolecularLL
---------------
Read from the molecular database using the low-level interface.
The low level interface gives direct access to the data as it
appears in the database.

ReadMolecularHL
---------------
Read from the molecular database using the high-level interface.
The high-level interface uses so-called profile models to 
interpret data from the database.

ReadAerosolLL
-------------
Read from the aerosol database using the low-level interface.
The low level interface gives direct access to the data as it
appears in the database.

ReadAerosolHL
-------------
Read from aerosol database using the high-level interface. 
The high-level interface uses so-called aerosol models to 
interpret the data from the DB.

ReadAtmQualityLL
----------------
Read data from the overall atmospheric quality database.

ReadCloudHL
-----------
Read from the cloud database using the high-level interface.
This connects to the lidar and cloud databases to interpret the
coverage of FD pixels viewing some point in the atmosphere.

ReadCloudLL
-----------
Read from the cloud database using the low-level interface.
This gives direct access to the cloud coverage data in the 
database via CloudPixel classes.

ReadLidarLL
-----------
Read from the lidar database using the low-level interface.
Cloud height and aerosol optical depth data are available.

ReadFD
------
Read calibration constants from the FD calibation database

Geometry
--------
Manipulate geometrical objects using the geometry utilities

SuperModule
-----------
Call modules from within another module

DumpConfig
----------
Extract the configuration information from an Offline ROOT file 
and write it out as XML. 

OverrideConfig
--------------
Override parameters in the default configuration files.

GenerateDenseArray
------------------
Standalone program to create an XML file defining a custom 
"ficticious" array for use by the SDenseArrayXMLManager.  Such an 
array is defined in the shower coordinate system, and projected 
onto the ground by the SDenseArrayXMLManager. It is convenient 
for things like sampling true S1000 in simulations.

GenerateSStationList
--------------------
Create an up-to-date XML station list from the station list 
database.  Using an XML station list rather than the 
station list database when running offline 
may be more convenient in some cases.

SdSimulationCalibration
-----------------------
The calibration information for simulated stations is 
currently stored in a configuration file.  If 
parameters used in the simulation are changed, or if
the simulation code itself is changed, it is necessary
to recompute the calibration data so that it 
corresponds to the upated simulation.
This tutorial illustrates how to do that.

ParticleInjection
-----------------
Shoot single particles into a tank

TankVisualization
-----------------
Have fun looking at 3-D renderings of photons bouncing
around in a tank.

ShowerInventor
--------------
Make up your own shower front distributions for testing
SD simulation and reconstruction

, generated on Tue Sep 26 2023.