Tools
=====

This is a collection of useful tools for various applications within PandaRoot:

Histogram Tools
---------------

  * :doc:`PndMultiCanvasCreator` automatically creates a new canvas once the number of maximum number of histograms is exceeded
  * :doc:`PndHistoCombiner` combines histograms with the same name from different files in one overlay histogram
  
FairLink Tools
---------------
  * :doc:`PndMCTruthMatch` prints the MCTrack info for all data objects in a branch
  * :doc:`PndPrintFairLinks` prints all FairLinks of a given branch to the screen
  
Event Tools
-----------
  * :doc:`PndEventCounterTask` task to print out the event number
  * :doc:`PndGetEventTimeTask` task to extract the event time from the digi file
  
Track Analysis Tools
--------------------
  * :doc:`MCTrackAna/MCTrackAna` analyses the complete reconstruction chain to find point of failures
  
Master Tasks
------------
  * :doc:`PndMasterTasks/PndMasterTasks` collection of predefined tasks for simulation, digitization and reconstruction

  
Various Tools
-------------

  * :doc:`PndStringSeparator` separates in input string into a vector of sub-strings
  * :doc:`PndFileNameCreator` creates the standard output for PandaRoot macros
  * :doc:`PndTrackArrayMerger` combines several input arrays of the same data type into one output string
  * :doc:`PndMCCloner` copies the MC track data from the sim file into the pid file and removes unseen MC tracks
  * :doc:`PndGeoHandling` gives access to the full geo path name from the short ids
  * :doc:`PndBlackBoxTask` base class for tasks within PandaRoot which adds verbosity control
  * :doc:`PndBurstBuilder/PndBurstBuilder` classes to generate bursts out of a continuous data stream
  
Undocumented Tools
------------------
  *  Doxygen Example: Example files for documenting the code using doxygen
  *  MVA: Multi Variate Analysis
  *  Alignment: Tools to be used in the alignment of PANDA
  *  RadMapTool:  Stand alone tool to generate a radiation map for PANDA
  *  PndMQ: obsolete classes for MQ based processing
  

API
---  

.. toctree::
   :maxdepth: 2
   
   PndMCTruthMatch
   PndPrintFairLinks
   PndStringSeparator
   PndFileNameCreator
   PndMultiCanvasCreator
   PndHistoCombiner
   PndTrackArrayMerger
   PndMCCloner
   PndGeoHandling
   MCTrackAna/MCTrackAna
   PndEventCounterTask
   PndBlackBoxTask
   PndBurstBuilder/PndBurstBuilder
   PndGetEventTimeTask
   PndMasterTasks/PndMasterTasks