Updates needed for full jet reconstruction (charged + emcal) [Magali Estienne]

[u/mrichter/AliRoot.git] / FMD / flow / AliFMDFlowBinned2D.h

// -*- mode: C++ -*-
/* Copyright (C) 2007 Christian Holm Christensen <cholm@nbi.dk>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA
 */
/** @file 
    @brief Declaration of a 2-dimensional Flow "histogram" */
//____________________________________________________________________ 
//
// A histogram of flow bins.  The axis can by anything
// (pseudo-rapidity, transvers momentum) - there's no assumption on
// what is the basis of the histogram.  The method Event can be used
// to calculate everything in one go.   Alternatively, one can use the
// methods AddToEventPlane and AddToHarmonic.  See also the example
// TestFlow.C 
#ifndef ALIFMDFLOWBINNED2D_H
#define ALIFMDFLOWBINNED2D_H
#include <TNamed.h>
#include <TAttLine.h>
#include <TAttFill.h>
#include <TAttMarker.h>
#include <flow/AliFMDFlowAxis.h>

// Forward declaration 
class AliFMDFlowBin;
class AliFMDFlowSplitter;
class TBrowser;
class TH1;

//______________________________________________________
/** @class AliFMDFlowBinned2D flow/AliFMDFlowBinned2D.h <flow/AliFMDFlowBinned2D.h>
    @brief A 2 dimensional "histogram" of objects of class AliFMDFlowBin. 
    @ingroup c_binned */
class AliFMDFlowBinned2D : public TNamed, 
			   public TAttLine, 
			   public TAttFill, 
			   public TAttMarker
{
public:
  /** Constructor 
      @param order    Order of the harmonic 
      @param nxbins   Number of X bins.
      @param xbins    Borders of X bins (@a nxbins+1 entries) 
      @param nybins   Number of Y bins.
      @param ybins    Borders of Y bins (@a nybins+1 entries) */
  AliFMDFlowBinned2D(const char* name, const char* title, UShort_t order,  
		     UShort_t nxbins, Double_t* xbins,
		     UShort_t nybins, Double_t* ybins,
		     AliFMDFlowSplitter* splitter=0);
  /** Constructor 
      @param order Order of the harmonic 
      @param xaxis Axis object 
      @param yaxis Axis object */
  AliFMDFlowBinned2D(const char* name, const char* title, UShort_t order, 
		     const AliFMDFlowAxis& xaxis, const AliFMDFlowAxis& yaxis,
		     AliFMDFlowSplitter* splitter=0);
      
  /** Copy constructor */
  AliFMDFlowBinned2D(const AliFMDFlowBinned2D& other);
  /** Copy constructor */
  AliFMDFlowBinned2D& operator=(const AliFMDFlowBinned2D& other);
  /** Destructor */
  virtual ~AliFMDFlowBinned2D();
  
  /** Called at the beginning of an event */
  virtual void Begin();
  /** Called at the end of an event */ 
  virtual void End();
  /** Called to add a contribution to the event plane 
      @param x   Bin to fill into 
      @param y   Bin to fill into 
      @param phi The angle @f$ \varphi@f$ in radians 
      @param w   Weight
      @param a   If true, add to sub-event A, otherwise sub-event B */ 
  virtual Bool_t AddToEventPlane(Double_t x, Double_t y, Double_t phi, 
				 Double_t w, Bool_t a);
  /** Called to add a contribution to the harmonic
      @param x   Bin to fill into 
      @param y   Bin to fill into 
      @param phi The angle @f$ \varphi@f$ in radians 
      @param wp  The event plane angle weight
      @param wh  The harmonic weight */
  virtual Bool_t AddToHarmonic(Double_t x, Double_t y, Double_t phi, 
			       Double_t wp, Double_t wh);
  /** Process a full event. 
      @param phis List of @a n @f$ \varphi=[0,2\pi]@f$ angles 
      @param xs   List of @a n @f$ x@f$ values. 
      @param ys   List of @a n @f$ y@f$ values. 
      @param wp   Weights for event plane
      @param wh   Weights for harmonic
      @param n    Size of @a phis and @a xs */
  virtual void Event(ULong_t n, Double_t* phis, Double_t* xs, Double_t* ys, 
		     Double_t* wp=0, Double_t* wh=0);
  /** Called at the end of a run */
  virtual void Finish();
  /** Get the bin at @a x 
      @param x The bin value to find a flow object for. 
      @param y The bin value to find a flow object for. 
      @return The flow object at @a x,y or 0 if out of range */ 
  virtual AliFMDFlowBin* GetBin(Double_t x, Double_t y) const;
  /** Get the bin at @a x 
      @param i The bin index to find a flow object for. 
      @param j The bin index to find a flow object for. 
      @return The flow object at @a i,j or 0 if out of range */ 
  virtual AliFMDFlowBin* GetBin(UShort_t i, UShort_t j) const;
  /** Whether this is to be considered a folder */
  Bool_t IsFolder() const { return kTRUE; }
  /** Browse this object */ 
  void Browse(TBrowser* b);
protected:
  /** X axis */ 
  AliFMDFlowAxis fXAxis; // X axis
  /** Y axis */ 
  AliFMDFlowAxis fYAxis; // Y axis
  /** Array of the flow objects */ 
  AliFMDFlowBin** fBins;  // Bins 
  /** The event splitter used. */
  AliFMDFlowSplitter* fSplitter;
  /** Define for ROOT I/O */
  ClassDef(AliFMDFlowBinned2D,1);
};


#endif
//
// EOF
//