HyperBinning.h

Go to the documentation of this file.

#ifndef HYPERBINNING_HH
#define HYPERBINNING_HH

// HyperPlot includes
#include "Mint/MessageService.h"
#include "Mint/HyperPoint.h"
#include "Mint/HyperPointSet.h"
#include "Mint/HyperCuboid.h"
#include "Mint/HyperVolume.h"
#include "Mint/RootPlotter1D.h"
#include "Mint/RootPlotter2D.h"
#include "Mint/HyperName.h"
#include "Mint/BinningBase.h"
#include "Mint/LoadingBar.h"
#include "Mint/CachedVar.h"


// Root includes
#include "TRandom3.h"
#include "TH1D.h"
#include "TH2D.h"
#include "TMath.h"

// std includes
#include <algorithm>
#include <sstream>

class HyperBinning : public BinningBase {

  private:
  
  //mutable bool _changed; 
  mutable CachedVar<HyperPoint> _averageBinWidth;
  mutable CachedVar<HyperCuboid> _minmax; 
  mutable CachedVar<std::vector< int > >              _binNum; 
  mutable CachedVar< std::vector< int > >     _hyperVolumeNumFromBinNum;
  protected:


  int followBinLinks(const HyperPoint& coords, int binNumber) const; 

  void updateCash() const; 
  void updateBinNumbering() const; 
  void updateAverageBinWidth() const;
  void updateMinMax() const;

  int getHyperBinningDimFromTree(TTree* tree);

  void createBranches       (TTree* tree, int* binNumber, double* lowCorner, double* highCorner, std::vector<int>** linkedBins) const;
  void saveHyperVolumeToTree(TTree* tree, double* lowCorner, double* highCorner, const HyperVolume& hyperVolume) const;
  void savePrimaryVolumeNumbers() const;

  public:
  
  HyperBinning();
  
  bool isPrimaryVolume(int volumeNumber) const;

  //Used for getting between the bin number and HyperVolume numbers
  int getHyperVolumeNumber(int binNumber) const;
  int getBinNum(int volumeNumber) const;

  virtual std::vector<int> getPrimaryVolumeNumbers() const;

  virtual ~HyperBinning();

  /* Virtual functions that need to implemented in any derrived class */

  virtual void setDimension(int dim);

  virtual std::vector<int> getLinkedHyperVolumes( int volumeNumber ) const = 0;
  virtual HyperVolume getHyperVolume(int volumeNumber) const = 0; 
  virtual void addPrimaryVolumeNumber(int volumeNumber) = 0;
  virtual bool addHyperVolume(const HyperVolume& hyperVolume, std::vector<int> linkedVolumes = std::vector<int>(0, 0)) = 0;
  virtual int getNumHyperVolumes() const = 0;  

  virtual int getNumPrimaryVolumes  () const = 0;  
  virtual int getPrimaryVolumeNumber(int i) const = 0;  

  virtual void reserveCapacity(int nElements); 


  /* Virtual functions that need to implemented from BinningBase */
  /*    These will be implemented in the derived classes */

  virtual void load(TString filename, TString option = "READ") = 0;
  virtual BinningBase* clone() const = 0;

  /*    These will be implemented in this class */

  virtual void save(TString filename) const;
  virtual void save() const; 

  virtual void mergeBinnings( const BinningBase& other );

  virtual int getNumBins() const;
  virtual int getBinNum(const HyperPoint& coords) const;

  /*   */
  virtual std::vector<int> getBinNum(const HyperPointSet& coords) const;
  std::vector<int> getBinNumAlt(const HyperPointSet& coords) const;


  virtual HyperVolume getBinHyperVolume(int binNumber) const;

  virtual HyperPoint  getAverageBinWidth() const;
  virtual HyperCuboid getLimits()          const;



};



#endif