THistManager.h

Go to the documentation of this file.

#ifndef THISTMANAGER_H
#define THISTMANAGER_H
/* Copyright(c) 1998-2016, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

#include <THashList.h>
#include <TIterator.h>
#include <TNamed.h>
#include <iterator>

class TArrayD;
class TAxis;
class TBinning;
class TList;
class TH1;
class TH2;
class TH3;
class THnSparse;
class TProfile;

class THistManager : public TNamed {
public:

  class iterator :  public std::iterator<std::bidirectional_iterator_tag,
                                                 TObject, std::ptrdiff_t,
                                                 TObject **, TObject *&>{
  public:
    enum THMIDirection_t {
      kTHMIforward = 0,   
      kTHMIbackward = 1   
    };

    iterator(const THistManager *hmgr, Int_t currentpos, THMIDirection_t dir = kTHMIforward);

    iterator(const iterator &ref);

    ~iterator() { }

    iterator              &operator=(const iterator &rhs);

    Bool_t                operator!=(const iterator &aIter) const;

    iterator              &operator++();

    iterator              operator++(int);

    iterator              &operator--();

    iterator              operator--(int);

    TObject               *operator*() const;

  private:
    const THistManager          *fkArray;             
    Int_t                       fCurrentPos;          
    Int_t                       fNext;                
    THMIDirection_t             fDirection;           

    iterator();
  };

  THistManager();

  THistManager(const char *name);

  ~THistManager();

  void ReleaseOwner() { fIsOwner = kFALSE; };

  THashList* CreateHistoGroup(const char *groupname);

  TH1* CreateTH1(const char *name, const char *title, int nbins, double xmin, double xmax, Option_t *opt = "");

  TH1* CreateTH1(const char *name, const char *title, int nbins, const double *xbins, Option_t *opt = "");

  TH1* CreateTH1(const char *name, const char *title, const TArrayD &xbins, Option_t *opt = "");

  TH1* CreateTH1(const char *name, const char *title, const TBinning &binning, Option_t *opt = "");

  TH2* CreateTH2(const char *name, const char *title, int nbinsx, double xmin, double xmax, int nbinsy, double ymin, double ymax, Option_t *opt = "");

  TH2* CreateTH2(const char *name, const char *title, int nbinsx, const double *xbins, int nbinsy, const double *ybins, Option_t *opt = "");

  TH2* CreateTH2(const char *name, const char *title, const TArrayD &xbins, const TArrayD &ybins, Option_t *opt = "");

  TH2* CreateTH2(const char *name, const char *title, const TBinning &xbins, const TBinning &ybins, Option_t *opt = "");

  TH3* CreateTH3(const char *name, const char *title, int nbinsx, double xmin, double xmax, int nbinsy, double ymin, double ymax, int nbinsz, double zmin, double zmax, Option_t *opt = "");

  TH3* CreateTH3(const char *name, const char *title, int nbinsx, const double *xbins, int nbinsy, const double *ybins, int nbinsz, const double *zbins, Option_t *opt = "");

  TH3* CreateTH3(const char *name, const char *title, const TArrayD &xbins, const TArrayD &ybins, const TArrayD &zbins, Option_t *opt = "");

  TH3* CreateTH3(const char *name, const char *title, const TBinning &xbins, const TBinning &ybins, const TBinning &zbins, Option_t *opt = "");

  THnSparse* CreateTHnSparse(const char *name, const char *title, int ndim, const int *nbins, const double *min, const double *max, Option_t *opt = "");

  THnSparse* CreateTHnSparse(const char *name, const char *title, int ndim, const TAxis **axes, Option_t *opt = "");

  THnSparse* CreateTHnSparse(const char *name, const char *title, int ndim, const TBinning **axes, Option_t *opt = "");


  void CreateTProfile(const char *name, const char *title, int nbinsX, double xmin, double xmax, Option_t *opt = "");

  void CreateTProfile(const char *name, const char *title, int nbinsX, const double *xbins, Option_t *opt = "");

  void CreateTProfile(const char *name, const char *title, const TArrayD &xbins, Option_t *opt = "");

  void CreateTProfile(const char *name, const char *title, const TBinning &xbins, Option_t *opt = "");

  void SetObject(TObject * const o, const char *group = "/");

  void FillTH1(const char *hname, double x, double weight = 1., Option_t *opt = "");

  void FillTH1(const char *name, const char *label, double weight = 1., Option_t *opt = "");

  void FillTH2(const char *hname, double x, double y, double weight = 1., Option_t *opt = "");

  void FillTH2(const char *hname, double *point, double weight = 1., Option_t *opt = "");

  void FillTH3(const char *hname, double x, double y, double z, double weight = 1., Option_t *opt = "");

  void FillTH3(const char *hname, const double *point, double weight = 1., Option_t *opt = "");

  void FillTHnSparse(const char *name, const double *x, double weight = 1., Option_t *opt = "");

  void FillProfile(const char *name, double x, double y, double weight = 1.);

  inline iterator begin() const;

  inline iterator end() const;

  inline iterator rbegin() const;

  inline iterator rend() const;

  THashList *GetListOfHistograms() const { return fHistos; }

  TObject *FindObject(const char *name) const;

  virtual TObject *FindObject(const TObject *obj) const;

private:
  THistManager(const THistManager &);
  THistManager &operator=(const THistManager &);


  THashList *FindGroup(const char *dirname) const;

  TString basename(const TString &path) const;

  TString histname(const TString &path) const;

  THashList *fHistos;                   
  bool fIsOwner;                        

  ClassDef(THistManager, 1);  // Container for histograms
};

THistManager::iterator THistManager::begin() const {
  return iterator(this, 0, iterator::kTHMIforward);
}

THistManager::iterator THistManager::rbegin() const {
  return iterator(this, fHistos->GetEntries()-1, iterator::kTHMIbackward);
}

THistManager::iterator THistManager::end() const {
  return iterator(this, fHistos->GetEntries(), iterator::kTHMIforward);
}

THistManager::iterator THistManager::rend() const {
  return iterator(this, -1, iterator::kTHMIbackward);
}

namespace TestTHistManager {

class THistManagerTestSuite {
public:

  THistManagerTestSuite() {}

  virtual ~THistManagerTestSuite() {}

  int TestBuildSimpleHistograms();

  int TestBuildGroupedHistograms();

  int TestFillSimpleHistograms();

  int TestFillGroupedHistograms();
};

int TestRunAll();

int TestRunBuildSimple();

int TestRunBuildGrouped();

int TestRunFillSimple();

int TestRunFillGrouped();

}
#endif