Fix some documentation issues

[u/mrichter/AliRoot.git] / PWGLF / FORWARD / analysis2 / AliForwarddNdetaTask.h

diff --git a/PWGLF/FORWARD/analysis2/AliForwarddNdetaTask.h b/PWGLF/FORWARD/analysis2/AliForwarddNdetaTask.h
index f40180463ff93e37722ba1e4e458b6ad342c44a0..64a8b5c373aea9575f109840431d99ae2ce1e6a1 100644 (file)
--- a/PWGLF/FORWARD/analysis2/AliForwarddNdetaTask.h
+++ b/PWGLF/FORWARD/analysis2/AliForwarddNdetaTask.h
@@ -21,6 +21,8 @@ class TH1D;
 /**
  * Tasks to determine @f$ dN/d\eta@f$ in the forward regions
  *
+ * @image html alice-int-2012-040-performance_spdfmdvzero.png "dN/deta in PbPb"
+ * 
  * @ingroup pwglf_forward_tasks_dndeta
  * @ingroup pwglf_forward_dndeta
  */
@@ -46,6 +48,8 @@ public:
 protected:
   /** 
    * Copy constructor 
+   *
+   * @param o object to copy from 
    */
   AliForwarddNdetaTask(const AliForwarddNdetaTask& o);
   /** 
@@ -53,7 +57,7 @@ protected:
    * 
    * @return Reference to this
    */
-  AliForwarddNdetaTask& operator=(const AliForwarddNdetaTask&) { return *this; }
+  AliForwarddNdetaTask& operator=(const AliForwarddNdetaTask&);
 
   /** 
    * Retrieve the histogram 
@@ -63,13 +67,23 @@ protected:
    * 
    * @return Retrieved histogram or null
    */
-  TH2D* GetHistogram(const AliAODEvent* aod, Bool_t mc);
+  TH2D* GetHistogram(const AliAODEvent& aod, Bool_t mc);
   /** 
    * Get the colour to use for markers (only pp - in PbPb we use a rainbow)
    * 
    * @return Marker colour 
    */
   virtual Int_t GetColor() const { return kRed+2; }
+  /** 
+   * Massage data histograms for certain vertices in the satellite analysis 
+   * 
+   * @param vtx 
+   * @param data 
+   * @param mcData 
+   */
+  virtual void CheckEventData(Double_t vtx, 
+                             TH2*     data, 
+                             TH2*     mcData);
   /** 
    * Make a new centrality bin
    * 
@@ -82,6 +96,10 @@ protected:
   AliBasedNdetaTask::CentralityBin* 
   MakeCentralityBin(const char* name, Short_t l, Short_t h) const;
 
+  /**
+   * A structure holding the per-centrality bin information 
+   * 
+   */
   class CentralityBin : public AliBasedNdetaTask::CentralityBin 
   {
   public:
@@ -104,9 +122,7 @@ protected:
      * 
      * @param other Object to copy from 
      */
-    CentralityBin(const CentralityBin& other) 
-      : AliBasedNdetaTask::CentralityBin(other)
-    {}
+    CentralityBin(const CentralityBin& other);
     /** 
      * Destructor 
      */
@@ -117,7 +133,7 @@ protected:
      * 
      * @return 
      */
-    CentralityBin& operator=(const CentralityBin&) { return *this; }
+    CentralityBin& operator=(const CentralityBin&);
     /** 
      * End of processing 
      * 
@@ -126,6 +142,7 @@ protected:
      * @param scheme      Normalisation scheme options
      * @param shapeCorr   Shape correction or nil
      * @param trigEff     Trigger efficiency 
+     * @param trigEff0    0-bin trigger efficiency 
      * @param symmetrice  Whether to symmetrice the results
      * @param rebin       Whether to rebin the results
      * @param rootProj    If true, use TH2::ProjectionX
@@ -142,6 +159,7 @@ protected:
                     UShort_t    scheme,
                     const TH2F* shapeCorr, 
                     Double_t    trigEff,
+                    Double_t    trigEff0,
                     Bool_t      symmetrice,
                     Int_t       rebin, 
                     Bool_t      rootProj,
@@ -153,10 +171,10 @@ protected:
                     TList*      mclist,
                     TList*      truthlist);
   protected: 
-    ClassDef(CentralityBin,2); // A centrality bin     
+    ClassDef(CentralityBin,3); // A centrality bin     
   };
 
-  ClassDef(AliForwarddNdetaTask,2); // Determine multiplicity in forward region
+  ClassDef(AliForwarddNdetaTask,3); // Determine multiplicity in forward region
 };
 
 #endif