ROOTANA: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
(The midas documentation has moved to https://midas.triumf.ca/docs/)
Tag: Replaced
 
Line 1: Line 1:
{{Pagelinks}}
The midas documentation has moved. See [https://midas.triumf.ca/docs/develop/features/analysing_data/data_analysis/rootana/ ROOTANA (deprecated)] for the new documentation about ROOTANA. New experiments should use [https://midas.triumf.ca/docs/develop/features/analysing_data/data_analysis/manalyzer/ manalyzer] instead.
 
= Links =
 
* [[ROOT]]
* https://gitlab.triumf.ca/midas/rootana
* git clone https://gitlab.triumf.ca/midas/rootana.git
* git clone http://ladd00.triumf.ca/~daqweb/git/rootana.git
* (obsolete) [https://ladd00.triumf.ca/viewvc/rootana/trunk ROOTANA SVN reporitory] (username svn, password svn)
* [http://ladd00.triumf.ca/~daqweb/doc/rootana/html ROOTANA Doxygen documentation]
 
= Download and Quick start =
 
<pre>
echo $ROOTSYS # check correct installation of ROOT
root-config # check correct installation of ROOT
 
git clone https://gitlab.triumf.ca/midas/rootana.git
cd rootana
make
make dox
 
more analyzer.cxx
more event_dump.cxx
</pre>
 
= Introduction =
 
Welcome to ROOTANA, the ROOT (https://root.cern.ch) based data analysis package for the MIDAS Data Acquisition system (https://midas.triumf.ca).
 
The ROOTANA package includes 5 major components:
* a standalone library for reading and writing data files in the MIDAS .mid format, and for decoding the XML dump of MIDAS ODB typically embedded in every MIDAS data file. (libMidasInterface)
* a C++ interface class for connecting to an active MIDAS experiment, accessing ODB (read and write) and getting event data. (libMidasInterface)
* a set of C++ classes for exporting ROOT histogram and other objects to an external viewer for interactive visualization of live data, typically using the  ROODY histogram viewer or using a standard web browser (experimental feature). (libMidasServer, libNetDirectory, libXmlServer)
* simple examples of using these components (a graphical analyzer, an event dump and an event skim programs) (analyzer.cxx, event_dump.cxx, event_skim.cxx)
* a full featured framework for graphical data analysis including code to unpack typical VME and CAMAC modules ( see [[rootana Analyzer Framework]] and [[rootana Display Framework]])
 
 
The ROOTANA package can be used without installing ROOT and MIDAS:
* without both ROOT and MIDAS one can only read (and write) existing .mid files. Only event_dump and event_skim will be built.
* if only the MIDAS package is installed, access to live data and access to live ODB becomes possible. Only event_dump and event_skim will be built.
* decoding of XML ODB dumps embedded in MIDAS files requires ROOT TXML and TDOMParser components (a version of XML decoder using libxml2 used to exist in the past).
* if the ROOT package is installed but MIDAS is absent, full function of ROOTANA is available, except for access to live data. This mode is suitable for offline data analysis, i.e. the user has a copy of MIDAS data files on their laptop and wants to analyze them.
 
 
The sources for ROOTANA are managed at https://gitlab.triumf.ca/midas/rootana.
 
= Components =
 
== MIDAS Interface ==
 
These classes provide the actual access to MIDAS data
 
* TMidasEvent: a class encapulating a MIDAS event.
* TMidasFile: a class encapsulating a MIDAS file
* TMidasOnline: a class that allows access to online MIDAS events; this class requires that the MIDAS libraries be installed
* VirtualODB: a class that provides access to ODB variables, either through ODB dumps at the start of files or by directly connecting to the online ODB.
 
== XML Server ==
 
xmlServer & co
 
== example programs ==
 
* event_dump
* event_skim
* standalone graphical analyzer.cxx
 
== ROOT Analyzer framework ==
 
rootana provides low-level access to the MIDAS data files and online MIDAS data.  Using these low-level functionality users can design whatever sort of programs they want for accessing and analyzing the data.
 
rootana also provides a more structured, higher-level framework for organizing analysis programs.  The framework includes a standard event loop class and a standard display program.  Details on this higher-level framework available in [[rootana Analyzer Framework]] and  [[rootana Display Framework]].
 
= Contacts =
 
* Before conversion from svn to git, ROOTANA was managed by members of the TRIUMF DAQ group
* The git version hosted on the TRIUMF gitlab is managed by the members of the MIDAS developers group.
* to report bugs, request improvements, contribute bug fixes - please go to the ROOTANA issue tracker https://gitlab.triumf.ca/midas/rootana/-/work_items
* for questions and discussion - please go to the MIDAS discussion forum https://midas.triumf.ca/forum

Latest revision as of 22:01, 30 October 2026

The midas documentation has moved. See ROOTANA (deprecated) for the new documentation about ROOTANA. New experiments should use manalyzer instead.