Updated comments for Doxygen
[u/mrichter/AliRoot.git] / MUON / AliMUON.h
index a127602..28ff0a0 100644 (file)
  * See cxx source for full Copyright notice                               */
 
 /* $Id$ */
-/* $Id$ */
+// Revision of includes 07/05/2004
+
+/// \ingroup base
+/// \class AliMUON
+/// \brief AliDetector class for MUON subsystem providing
+/// simulation data management 
 
+#include <TObjArray.h>
 
-////////////////////////////////////////////////
-//  AliDetector Class for MUON subsystem      //
-////////////////////////////////////////////////
 #include "AliDetector.h"
 #include "AliMUONData.h"
 #include "AliMUONChamber.h"
+#include "AliMUONTrigger.h"
+
+#include <TVectorfwd.h>
+
+class TFile;
+class TTree;
 
 class AliLoader;
-class AliMUONLocalTrigger;
-class AliMUONGlobalTrigger;
 class AliMUONTriggerCircuit;
-class AliMUONTriggerDecision;
-class AliSegmentation;
+class AliMUONTriggerCircuitNew;
+class AliMUONData;
 class AliMUONResponse;
-class AliMUONMerger;
+class AliMUONSegmentation;
 class AliMUONHit;
-class AliMUONPadHit;
 class AliMUONRawCluster;
-class AliMUONClusterFinderVS;
-class AliMUONReconstHit;
-class AliMUONMerger;
-
-class TVector;
-#include "TObjArray.h"
-class TFile;
-class TTree;
+class AliMUONGeometry;
+class AliMUONGeometryTransformer;
+class AliMUONGeometryBuilder;
+class AliMUONRawWriter;
+class AliMUONVGeometryBuilder;
+class AliESD;
 
-
-class AliMUON : public  AliDetector {
- public:
+class AliMUON : public  AliDetector 
+{
+  public:
     AliMUON();
-    AliMUON(const char *name, const char *title);
-    AliMUON(const AliMUON& rMUON);
-    virtual       ~AliMUON();
+    AliMUON(const char* name, const char *title="FactoryV4",
+            const char* sDigitizerType="sdigitizer:AliMUONSDigitizerV2",
+            const char* digitizerType="digitizer:NewDigitizerWithNoiseOldTrigger");
+    virtual ~AliMUON();
    
+    // Geometry
+    void AddGeometryBuilder(AliMUONVGeometryBuilder* geomBuilder);
+    void ResetGeometryBuilder();
+    
     virtual void   BuildGeometry();
-    Int_t          DistancetoPrimitive(Int_t px, Int_t py);
-    AliMUONData*   GetMUONData() {return fMUONData;}
     virtual Int_t  IsVersion()   const {return 0;}
+    
+    AliMUONGeometryBuilder*            GetGeometryBuilder() const {return fGeometryBuilder;}
+    const AliMUONGeometryTransformer*  GetGeometryTransformer() const;
+    AliMUONSegmentation*               GetSegmentation() const    { return fSegmentation; }
+
+    // MUONData   
+    AliMUONData*   GetMUONData() {return fMUONData;}
 
     // MUONLoader definition
     virtual AliLoader* MakeLoader(const char* topfoldername); //builds standard getter (AliLoader type)
     // Interface with AliMUONData
     virtual void       MakeBranch(Option_t *opt=" ") {GetMUONData()->MakeBranch(opt);}
-    void               SetTreeAddress();
+    virtual void       SetTreeAddress();
     virtual void       ResetHits()                   {GetMUONData()->ResetHits();}
     virtual void       ResetDigits()                 {GetMUONData()->ResetDigits();}
-    virtual void       ResetTrigger()                {GetMUONData()->ResetTrigger();};
-    virtual void       ResetRawClusters()            {GetMUONData()->ResetRawClusters();};
-    // Cluster Finding
-    virtual void   Digits2Reco();
-    virtual void   FindClusters();
+    virtual void       ResetTrigger()                {GetMUONData()->ResetTrigger();}
+    virtual void       ResetRawClusters()            {GetMUONData()->ResetRawClusters();}
+    virtual void       SetSplitLevel(Int_t SplitLevel)     {fSplitLevel=SplitLevel;}
+
     // Digitisation 
+    virtual AliDigitizer* CreateDigitizer(AliRunDigitizer* manager) const;
     virtual void   SDigits2Digits();      
+    virtual void   Hits2SDigits();
+    virtual void   Digits2Raw();
+    
+    // Trigger
+    virtual AliTriggerDetector* CreateTriggerDetector() const
+       { return new AliMUONTrigger(); }
+    
+
     // Configuration Methods (per station id)
     //
-    // Set Chamber Segmentation Parameters
-    // id refers to the station and isec to the cathode plane
-    // Set Z values for all chambers
-    virtual void SetChambersZ(const Float_t *Z);
-    virtual void SetChambersZToDefault(void);
-    virtual void SetPadSize(Int_t id, Int_t isec, Float_t p1, Float_t p2);
     // Set Signal Generation Parameters
     virtual void   SetSigmaIntegration(Int_t id, Float_t p1);
     virtual void   SetChargeSlope(Int_t id, Float_t p1);
     virtual void   SetChargeSpread(Int_t id, Float_t p1, Float_t p2);
     virtual void   SetMaxAdc(Int_t id, Int_t p1);
-    // Set Segmentation and Response Model
-    virtual void   SetSegmentationModel(Int_t id, Int_t isec,
-                                       AliSegmentation *segmentation);
+    // Set Response Model
     virtual void   SetResponseModel(Int_t id, AliMUONResponse *response);
-    virtual void   SetNsec(Int_t id, Int_t nsec);
-    // Set Reconstruction Model
-    virtual void   SetReconstructionModel(Int_t id, AliMUONClusterFinderVS *reconstruction);
-    // Set Merger/Digitizer
-    virtual void   SetMerger(AliMUONMerger* merger);
-    virtual AliMUONMerger* Merger();
-    
+
     // Set Stepping Parameters
     virtual void   SetMaxStepGas(Float_t p1);
     virtual void   SetMaxStepAlu(Float_t p1);
     virtual void   SetMaxDestepGas(Float_t p1);
     virtual void   SetMaxDestepAlu(Float_t p1);
-    virtual void   SetAcceptance(Bool_t acc=0, Float_t angmin=2, Float_t angmax=9);
    
-    // get Trigger answer
-    void   Trigger(Int_t nev);
+    // Get Stepping Parameters
+    virtual Float_t  GetMaxStepGas() const;
+    virtual Float_t  GetMaxStepAlu() const;
+    virtual Float_t  GetMaxDestepGas() const;
+    virtual Float_t  GetMaxDestepAlu() const;
+    
+    // Set alignement option
+    virtual void  SetAlign(Bool_t align = true);
+    virtual void  SetAlign(const TString& fileName, Bool_t align = true);
+
+    // Set scaler event for trigger
+    virtual void  SetTriggerScalerEvent(Bool_t scaler = true){fTriggerScalerEvent = scaler;}
+
     // Return reference to Chamber #id
     virtual AliMUONChamber& Chamber(Int_t id)
       {return *((AliMUONChamber *) (*fChambers)[id]);}
     // Return reference to Circuit #id
     virtual AliMUONTriggerCircuit& TriggerCircuit(Int_t id)
       {return *((AliMUONTriggerCircuit *) (*fTriggerCircuits)[id]);}
-    // Retrieve pad hits for a given Hit
-    virtual AliMUONPadHit* FirstPad(AliMUONHit *hit, TClonesArray *padHits);
-    virtual AliMUONPadHit* NextPad(TClonesArray *padHits);
+    virtual AliMUONTriggerCircuitNew& TriggerCircuitNew(Int_t id)
+       {return *((AliMUONTriggerCircuitNew*) (*fTriggerCircuitsNew)[id]);}
     // Return pointers to digits
     AliMUONRawCluster    *RawCluster(Int_t ichamber, Int_t icathod,
                                     Int_t icluster);
-    // Copy Operator
-    AliMUON& operator = (const AliMUON& rhs);
-    
+    // Inherited and overridden from AliModule:
+    //PH    virtual void RemapTrackHitIDs(Int_t * map);
+
+    TString SDigitizerType() const;
+    TString DigitizerType() const;
     
- protected:
-    Int_t                 fNCh;                // Number of chambers   
-    Int_t                 fNTrackingCh;        // Number of tracking chambers*
-    AliMUONData*          fMUONData;           // Data container for MUON subsystem  
-    TObjArray*            fChambers;           // List of Tracking Chambers
-    TObjArray*            fTriggerCircuits;    // List of Trigger Circuits
+  protected:
+    AliMUON(const AliMUON& rMUON);
+    AliMUON& operator = (const AliMUON& rhs);
+
+    const AliMUONGeometry* GetGeometry() const;
+
+    Int_t                 fNCh;                ///< Number of chambers   
+    Int_t                 fNTrackingCh;        ///< Number of tracking chambers*
+    AliMUONData*          fMUONData;           ///< Data container for MUON subsystem  
+    Int_t                 fSplitLevel;         ///< Splitlevel when making branches in outfiles.
+    TObjArray*            fChambers;           ///< List of Tracking Chambers
+    TObjArray*            fTriggerCircuits;    ///< List of Trigger Circuits
+    TObjArray*            fTriggerCircuitsNew; ///< List of Trigger Circuits
+    AliMUONGeometryBuilder*  fGeometryBuilder; ///< Geometry builder 
+    AliMUONSegmentation*  fSegmentation;       ///< New segmentation 
    
     //
-    Bool_t   fAccCut;          //Transport acceptance cut
-    Float_t  fAccMin;          //Minimum acceptance cut used during transport
-    Float_t  fAccMax;          //Minimum acceptance cut used during transport
+    Bool_t   fAccCut;         ///<Transport acceptance cut
+    Float_t  fAccMin;         ///<Minimum acceptance cut used during transport
+    Float_t  fAccMax;         ///<Minimum acceptance cut used during transport
     //  
     //  Stepping Parameters
-    Float_t fMaxStepGas;      // Maximum step size inside the chamber gas
-    Float_t fMaxStepAlu;      // Maximum step size inside the chamber aluminum
-    Float_t fMaxDestepGas;    // Maximum relative energy loss in gas
-    Float_t fMaxDestepAlu;    // Maximum relative energy loss in aluminum
+    Float_t fMaxStepGas;      ///< Maximum step size inside the chamber gas
+    Float_t fMaxStepAlu;      ///< Maximum step size inside the chamber aluminum
+    Float_t fMaxDestepGas;    ///< Maximum relative energy loss in gas
+    Float_t fMaxDestepAlu;    ///< Maximum relative energy loss in aluminum
     
     // Pad Iterator
-    Int_t fMaxIterPad;        // Maximum pad index
-    Int_t fCurIterPad;        // Current pad index
-    // Background eent for event mixing
-    Text_t *fFileName;           // ! File with background hits
-    AliMUONMerger *fMerger;   // ! pointer to merger
+    Int_t fMaxIterPad;        ///< Maximum pad index
+    Int_t fCurIterPad;        ///< Current pad index
+   
+    // setting scaler for trigger
+    Bool_t fTriggerScalerEvent; ///< Flag to generates scaler event
+    
+    TString fSDigitizerType;    ///< Class to use for SDigitizer
+    TString fDigitizerType;     ///< Class to use for Digitizer
+    
+    AliMUONRawWriter* fRawWriter; //!< Raw data writer
     
-    ClassDef(AliMUON,3)  // MUON Detector base class
+    ClassDef(AliMUON,13)  // MUON Detector base class
 };
 #endif