Fix documentation issues

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

// 
// This class calculates the exclusive charged particle density
// in each for the 5 FMD rings. 
//
#ifndef ALIFMDMCCORRECTOR_H
#define ALIFMDMCCORRECTOR_H
/**
 * @file   AliFMDMCCorrector.h
 * @author Christian Holm Christensen <cholm@dalsgaard.hehi.nbi.dk>
 * @date   Wed Mar 23 14:03:15 2011
 * 
 * @brief  
 * 
 * 
 * @ingroup pwglf_forward_aod
 */
#include "AliFMDCorrector.h"
#include <TList.h>
class TProfile2D;
class TH2;

/** 
 * @defgroup pwglf_forward_mc  Monte-carlo code
 * 
 * @ingroup pwglf_forward
 */
/** 
 * This class calculates the exclusive charged particle density
 * in each for the 5 FMD rings. 
 *
 * @par Input:
 *   - 5 RingHistos objects - each with a number of vertex dependent 
 *     2D histograms of the inclusive charge particle density 
 *
 * @par Output:
 *   - 5 RingHistos objects - each with a number of vertex dependent 
 *     2D histograms of the exclusive charge particle density 
 * 
 * @par Corrections used: 
 *   - AliFMDCorrSecondaryMap;
 *   - AliFMDCorrVertexBias
 *   - AliFMDCorrMergingEfficiency
 *
 * @ingroup pwglf_forward_algo
 * @ingroup pwglf_forward_mc
 * @ingroup pwglf_forward_aod
 */
class AliFMDMCCorrector : public AliFMDCorrector
{
public:
  /** 
   * Constructor 
   */
  AliFMDMCCorrector()
    : AliFMDCorrector(),
      fFMD1i(0), 
      fFMD2i(0),
      fFMD2o(0),
      fFMD3i(0),
      fFMD3o(0),
      fComps(0),
      fSecondaryForMC(true)
  {}
  /** 
   * Constructor 
   * 
   * @param name Name of object
   */
  AliFMDMCCorrector(const char* name)
    : AliFMDCorrector(name),
      fFMD1i(0), 
      fFMD2i(0),
      fFMD2o(0),
      fFMD3i(0),
      fFMD3o(0),
      fComps(0),
      fSecondaryForMC(true)
  {}
  /** 
   * Copy constructor 
   * 
   * @param o Object to copy from 
   */
  AliFMDMCCorrector(const AliFMDMCCorrector& o)
    : AliFMDCorrector(o),
      fFMD1i(o.fFMD1i), 
      fFMD2i(o.fFMD2i),
      fFMD2o(o.fFMD2o),
      fFMD3i(o.fFMD3i),
      fFMD3o(o.fFMD3o),
      fComps(0),
      fSecondaryForMC(o.fSecondaryForMC)
  {}
  /** 
   * Destructor 
   */
  virtual ~AliFMDMCCorrector();
  /** 
   * Assignement operator
   * 
   * @param o Object to assign from 
   * 
   * @return Reference to this object
   */
  AliFMDMCCorrector& operator=(const AliFMDMCCorrector&);
  /** 
   * If set, then do not do the secondary correction for MC data
   * 
   * @param use 
   */
  void SetSecondaryForMC(Bool_t use) { fSecondaryForMC = use; }
  /** 
   * Initialize this object 
   * 
   * @param etaAxis Eta axis to use 
   */
  void Init(const TAxis& etaAxis);
  /** 
   * Do the calculations 
   * 
   * @param hists    Cache of histograms 
   * @param vtxBin   Vertex bin 
   * 
   * @return true on successs 
   */
  virtual Bool_t CorrectMC(AliForwardUtil::Histos& hists, UShort_t vtxBin);
  /** 
   * Compare the result of analysing the ESD for 
   * the inclusive charged particle density to analysing 
   * MC truth 
   * 
   * @param esd 
   * @param mc 
   * 
   * @return 
   */
  virtual Bool_t CompareResults(AliForwardUtil::Histos& esd, 
				AliForwardUtil::Histos& mc);
  /** 
   * Output diagnostic histograms to directory 
   * 
   * @param dir List to write in
   */  
  void DefineOutput(TList* dir);

  /**
   * Print information
   * 
   * @param option Not used 
   */
  void Print(Option_t* option="") const;
protected:
  /** 
   * MAke comparison profiles
   * 
   * @param d     Detector 
   * @param r     Ring 
   * @param axis  Eta axis 
   * 
   * @return Newly allocated profile object
   */
  TProfile2D* Make(UShort_t d, Char_t r, const TAxis& axis) const;
  /** 
   * Fill comparison profiles
   * 
   * @param d    Detector 
   * @param r    Ring 
   * @param esd  ESD histogram
   * @param mc   MC histogram
   */
  void Fill(UShort_t d, Char_t r, TH2* esd, TH2* mc);

  TProfile2D* fFMD1i; // Comparison
  TProfile2D* fFMD2i; // Comparison
  TProfile2D* fFMD2o; // Comparison
  TProfile2D* fFMD3i; // Comparison
  TProfile2D* fFMD3o; // Comparison
  TList*      fComps; // List of comparisons 
  Bool_t      fSecondaryForMC;  // Whether to correct MC data 

  ClassDef(AliFMDMCCorrector,1); // Calculate Nch density 
};

#endif
// Local Variables:
//   mode: C++
// End: