* See cxx source for full Copyright notice
*/
//___________________________________________________________________
-//
-// The classes defined here, are utility classes for reading in data
-// for the FMD. They are put in a seperate library to not polute the
-// normal libraries. The classes are intended to be used as base
-// classes for customized class that do some sort of analysis on the
-// various types of data produced by the FMD.
-//
+/** @defgroup FMD_util Utility classes.
+
+ The classes defined here, are utility classes for reading in data
+ for the FMD. They are put in a seperate library to not polute the
+ normal libraries. The classes are intended to be used as base
+ classes for customized class that do some sort of analysis on the
+ various types of data produced by the FMD.
+*/
#include <TObject.h>
#ifndef ROOT_TString
# include <TString.h>
class TChain;
//___________________________________________________________________
+/** @class AliFMDInput
+ @brief Base class for reading in various FMD data.
+ The class loops over all found events. For each event the
+ specified data is read in. The class then loops over all
+ elements of the read data, and process these with user defined
+ code.
+ @code
+ struct DigitInput : public AliFMDInput
+ {
+ DigitInput()
+ {
+ // Load digits
+ AddLoad(kDigits);
+ // Make a histogram
+ fHist = new TH1F("adc", "ADC spectra", 1024, -.5, 1023.5);
+ }
+ // Process one digit.
+ Bool_t ProcessDigit(AliFMDDigit* d)
+ {
+ fHist->Fill(d->Counts());
+ return kTRUE;
+ }
+ // After processing all events, display spectrum
+ Bool_t Finish()
+ {
+ fHist->Draw();
+ }
+ TH1F* fHist;
+ };
+
+ void AdcSpectrum()
+ {
+ DigitInput di;
+ di.Run();
+ }
+ @endcode
+ This class allows for writing small scripts, that can be compiled
+ with AcLIC, to do all sorts of tests, quick prototyping, and so
+ on. It has proven to be quiet useful. One can load more than
+ one type of data in one derived class, to for example to make
+ comparisons between hits and reconstructed points. See also the
+ various scripts in @c FMD/scripts.
+ @ingroup FMD_util
+ */
class AliFMDInput : public TObject
{
public:
+ /** The kinds of data that can be read in. */
enum ETrees {
kHits = 1, // Hits
kKinematics, // Kinematics (from sim)
kRaw, // Read raw data
kGeometry // Not really a tree
};
+ /** CTOR */
AliFMDInput();
+ /** CTOR
+ @param gAliceFile galice file */
AliFMDInput(const char* gAliceFile);
+ /** DTOR */
virtual ~AliFMDInput() {}
+ /** Add a data type to load
+ @param tree Data to load */
virtual void AddLoad(ETrees tree) { SETBIT(fTreeMask, tree); }
+ /** Remove a data type to load
+ @param tree Data to @e not load */
virtual void RemoveLoad(ETrees tree) { CLRBIT(fTreeMask, tree); }
+ /** @return # of available events */
virtual Int_t NEvents() const;
+ /** Initialize the class. If a user class overloads this member
+ function, then this @e must be explicitly called
+ @return @c false on error */
virtual Bool_t Init();
+ /** Callled at the beginning of each event. If a user class
+ overloads this member function, then this @e must be explicitly
+ called.
+ @param event Event number
+ @return @c false on error */
virtual Bool_t Begin(Int_t event);
+ /** Process one event. This loops over all the loaded data. Users
+ can overload this member function, but then it's @e strongly
+ recommended to explicitly call this classes version.
+ @return @c false on error */
virtual Bool_t Event();
+ /** Called at the end of each event.
+ @return @c false on error */
virtual Bool_t End();
+ /** Called at the end of the run.
+ @return @c false on error */
virtual Bool_t Finish() { return kTRUE; }
+ /** Run a full job.
+ @return @c false on error */
virtual Bool_t Run();
+ /** Loop over all hits, and call ProcessHit with that hit, and
+ optionally the corresponding kinematics track.
+ @return @c false on error */
virtual Bool_t ProcessHits();
+ /** Loop over all digits, and call ProcessDigit for each digit.
+ @return @c false on error */
virtual Bool_t ProcessDigits();
+ /** Loop over all summable digits, and call ProcessSDigit for each
+ digit.
+ @return @c false on error */
virtual Bool_t ProcessSDigits();
+ /** Loop over all digits read from raw data files, and call
+ ProcessRawDigit for each digit.
+ @return @c false on error */
virtual Bool_t ProcessRawDigits();
+ /** Loop over all reconstructed points, and call ProcessRecPoint for
+ each reconstructed point.
+ @return @c false on error */
virtual Bool_t ProcessRecPoints();
+ /** Process one hit, and optionally it's corresponding kinematics
+ track. Users should over this to process each hit.
+ @return @c false on error */
virtual Bool_t ProcessHit(AliFMDHit*, TParticle*) { return kTRUE; }
+ /** Process one digit. Users should over this to process each digit.
+ @return @c false on error */
virtual Bool_t ProcessDigit(AliFMDDigit*) { return kTRUE; }
+ /** Process one summable digit. Users should over this to process
+ each summable digit.
+ @return @c false on error */
virtual Bool_t ProcessSDigit(AliFMDSDigit*) { return kTRUE; }
+ /** Process one digit from raw data files. Users should over this
+ to process each raw digit.
+ @return @c false on error */
virtual Bool_t ProcessRawDigit(AliFMDDigit*) { return kTRUE; }
+ /** Process one reconstructed point. Users should over this to
+ process each reconstructed point.
+ @return @c false on error */
virtual Bool_t ProcessRecPoint(AliFMDRecPoint*) { return kTRUE; }
+ /** Process ESD data for the FMD. Users should overload this to
+ deal with ESD data.
+ @return @c false on error */
virtual Bool_t ProcessESD(AliESDFMD*) { return kTRUE; }
protected:
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff