#include <HyperBinningDiskRes.h>

Inheritance diagram for HyperBinningDiskRes:

Public Member Functions
	HyperBinningDiskRes ()

	HyperBinningDiskRes (const HyperBinningDiskRes &other)

virtual	~HyperBinningDiskRes ()

virtual void	reserveCapacity (int nElements)

virtual void	setDimension (int dim)

virtual void	addPrimaryVolumeNumber (int volumeNumber)

virtual bool	addHyperVolume (const HyperVolume &hyperVolume, std::vector< int > linkedVolumes=std::vector< int >(0, 0))

virtual int	getNumHyperVolumes () const

virtual HyperVolume	getHyperVolume (int volumeNumber) const
	Get a HyperVolume from its volume number. More...

virtual std::vector< int >	getLinkedHyperVolumes (int volumeNumber) const

virtual int	getNumPrimaryVolumes () const

virtual int	getPrimaryVolumeNumber (int i) const

virtual bool	isDiskResident () const

virtual TString	filename () const

virtual void	load (TString filename, TString option="READ")

virtual BinningBase *	clone () const
	Create a clone of the object and return a pointer to it. More...

Public Member Functions inherited from HyperBinning
	HyperBinning ()
	The only constructor. More...

bool	isPrimaryVolume (int volumeNumber) const

int	getHyperVolumeNumber (int binNumber) const

int	getBinNum (int volumeNumber) const

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

virtual	~HyperBinning ()

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

Public Member Functions inherited from BinningBase
	BinningBase ()

void	setNames (HyperName names)

HyperName	getNames () const

const int &	getDimension () const

double	getMin (int dimension) const

double	getMax (int dimension) const

TString	getBinningType () const

bool	isSameBinningType (const BinningBase &other) const

virtual	~BinningBase ()

Protected Member Functions
void	getEntry (int volumeNumber) const

void	loadHyperBinningTree ()

void	loadPrimaryVolumeTree ()

void	createHyperBinningTree ()

void	createPrimaryVolumeTree ()

Protected Member Functions inherited from HyperBinning
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

Protected Member Functions inherited from BinningBase
void	setBinningType (TString binningType)

Private Attributes
TFile *	_file

bool	_writeable

TTree *	_tree

HyperCuboid	_cuboid

std::vector< int > *	_linkedBins

int	_volumeNumber

int	_currentEntry

TTree *	_treePrimVol

int	_primVolNum

Detailed Description

HyperPlot, Author: Sam Harnew, sam.h.nosp@m.arne.nosp@m.w@gma.nosp@m.il.c.nosp@m.om , Date: Dec 2015

HyperBinningDiskRes is a binning scheme where each bin volume is defined by a HyperVolume.

Finding the correct bin number is quite a compuationally slow process if one has to loop over every bin and check if a HyperPoint falls within that bin volume. It's not unusual to have millions of HyperPoints that need to be sorted into tens of thousands of bins. This would require billions of calulations. To speed this process up there is the option to build a hierarchy of bins. A schematic below shows a 1D example.

      HyperVolume Numbers 
|-------------0-------------| 
|------1------|------2------| 
|--3---|---4--|---5---|--6--|
|-7-|-8| 
          Bin Numbers
| 0 | 1|   2  |   3   |  4  |

Imagine we have a HyperPoint that falls into Bin 0. One would first check if it falls into HyperVolume 0 (note the distiction here between Bin/HyperVolume Numbers as indicated by the figure). First we check if it falls into HyperVolume 0, then HyperVolume 1 or 2, then HyperVolume 3 or 4, then HyperVolume 7 or 8.

In this simple example, it took 7 operations, whereas checking each Bin would have taken

Clearly as the number of bins increases, it becomes computationally much less expensive to follow this hierarchy approach.

The

Definition at line 81 of file HyperBinningDiskRes.h.

Constructor & Destructor Documentation

◆ HyperBinningDiskRes() [1/2]

HyperBinningDiskRes::HyperBinningDiskRes ( )

The empty constuctor. Must call the load function to associate this object to a file

Definition at line 6 of file HyperBinningDiskRes.cpp.

                                          :
   _file(0),
   _writeable(false),
   _tree(0),
   _cuboid(0),
   _linkedBins(new std::vector<int>()),
   _volumeNumber(-1),
   _currentEntry(-1),
   _treePrimVol(0),
   _primVolNum(-1)
 {
   WELCOME_LOG << "Hello from the HyperBinningDiskRes() Constructor";
 }

◆ HyperBinningDiskRes() [2/2]

HyperBinningDiskRes::HyperBinningDiskRes ( const HyperBinningDiskRes & other )

The copy constuctor. Essentially just calls the empty constuctor, then loads from the same file as the other binning.

Definition at line 22 of file HyperBinningDiskRes.cpp.

                                                                          :
   _file(0),
   _writeable(false),
   _tree(0),
   _cuboid(0),
   _linkedBins(new std::vector<int>()),
   _volumeNumber(-1),
   _currentEntry(-1),
   _treePrimVol(0),
   _primVolNum(-1)
 { 
   if (other._writeable == true){
     other._file->Write();
   }  
   load(other._file->GetName(), "READ");
 }

◆ ~HyperBinningDiskRes()

HyperBinningDiskRes::~HyperBinningDiskRes ( )

virtual

Destructor

Definition at line 334 of file HyperBinningDiskRes.cpp.

                                          {
   GOODBYE_LOG << "Goodbye from the HyperBinningDiskRes() Constructor";
 
   if (_file != 0) {
     _file->cd();
     if (_writeable == true){
       _tree       ->Write();
       _treePrimVol->Write();
     }
     _file->Close();
     _file = 0;
   }
 
   delete _linkedBins;
 
 }

Member Function Documentation

◆ addHyperVolume()

bool HyperBinningDiskRes::addHyperVolume	(	const HyperVolume &	hyperVolume,
		std::vector< int >	linkedVolumes = `std::vector<int>(0, 0)`
	)

virtual

Add a HyperVolume and its linked bins to the HyperBinning

Implements HyperBinning.

Definition at line 133 of file HyperBinningDiskRes.cpp.

                                                                                                     {
   
   if (_writeable == false){
     ERROR_LOG << "HyperBinningDiskRes::addHyperVolume - Cannot write, you must have opened in READ mode" << std::endl;
     return false;
   }
 
   //If dimension hasn't been set, and it's a writeable, we can now
   //set the dimesnion and create the tree
 
   if (getDimension() == 0 && _writeable == true){
     setDimension(hyperVolume.getDimension());
     createHyperBinningTree();
   }
   
   if (_tree == 0){
     ERROR_LOG << "HyperBinningDiskRes::addHyperVolume - Cannot find tree" << std::endl;
     return false;
   }
 
   int nVolumes = getNumHyperVolumes();
   for (int i = 0; i < hyperVolume.size(); i++){
     *_linkedBins  = linkedVolumes;
     _cuboid       = hyperVolume.at(i);
     _volumeNumber = nVolumes;
     _tree->Fill();
   }
   
   updateCash();
   
   return true;
 }

◆ addPrimaryVolumeNumber()

void HyperBinningDiskRes::addPrimaryVolumeNumber ( int volumeNumber )

virtual

Add a primary volume number

Implements HyperBinning.

Definition at line 104 of file HyperBinningDiskRes.cpp.

                                                                 {
 
   if (_writeable == false){
     ERROR_LOG << "HyperBinningDiskRes::addPrimaryVolumeNumber - Cannot write, you must have opened in READ mode" << std::endl;
     return;
   }
   if (_treePrimVol == 0){
     ERROR_LOG << "HyperBinningDiskRes::addPrimaryVolumeNumber - Cannot find tree" << std::endl;
     return;
   }  
 
   _primVolNum = volumeNumber;
   _treePrimVol->Fill();
 }

◆ clone()

BinningBase * HyperBinningDiskRes::clone ( ) const

virtual

Create a clone of the object and return a pointer to it.

Implements HyperBinning.

Definition at line 80 of file HyperBinningDiskRes.cpp.

                                              {
   
   BinningBase* ret = dynamic_cast<BinningBase*>(new HyperBinningDiskRes());
 
   if (_file != 0) {
 
     TString filenm = filename();
     _file->cd();
 
     if (_writeable == true){
       _file->Write();
     }
     
     ret->load(filenm, "READ");
 
   }
 
   return ret;
 
 } 

◆ createHyperBinningTree()

void HyperBinningDiskRes::createHyperBinningTree ( )

protected

Definition at line 228 of file HyperBinningDiskRes.cpp.

                                                 {
   
   _file->cd();
   _tree = new TTree("HyperBinning", "HyperBinning");
 
   if (_treePrimVol == 0){
     ERROR_LOG << "HyperBinningDiskRes::createHyperBinningTree - could not open TTree";
     return;
   }
 
   //Figure out how many dimensions there are from the tree
   int dim = getDimension();
   if (dim == 0){
     ERROR_LOG << "The dimesion has not yet been set, so I cannot createHyperBinningTree!!" << std::endl;
     return;
   }
 
   _tree->Branch("binNumber" , &_volumeNumber );
   _tree->Branch("linkedBins", &_linkedBins   );
 
   for (int i = 0; i < dim; i++){
     TString lowCornerName  = "lowCorner_" ; lowCornerName  += i; 
     TString highCornerName = "highCorner_"; highCornerName += i;   
     _tree->Branch(lowCornerName , &_cuboid.getLowCorner ().at(i) );
     _tree->Branch(highCornerName, &_cuboid.getHighCorner().at(i) );
   }
   
   //random access is really slow. Thought this might help
   //_tree->SetMaxVirtualSize(1000);
 
   _currentEntry = -1;
   updateCash();
 
 }

◆ createPrimaryVolumeTree()

void HyperBinningDiskRes::createPrimaryVolumeTree ( )

protected

Definition at line 263 of file HyperBinningDiskRes.cpp.

                                                  {
 
   _file->cd();
   _treePrimVol = new TTree("PrimaryVolumeNumbers", "PrimaryVolumeNumbers");
 
   if (_treePrimVol == 0){
     ERROR_LOG << "HyperBinningDiskRes::createPrimaryVolumeTree - could not open TTree";
     return;
   }
 
   _treePrimVol->Branch("volumeNumber", &_primVolNum);
 
 }

◆ filename()

TString HyperBinningDiskRes::filename ( ) const

virtual

Reimplemented from BinningBase.

Definition at line 317 of file HyperBinningDiskRes.cpp.

                                            {
   if (_file == 0){
     ERROR_LOG << "HyperBinningDiskRes::filename - there is no file associated to this object yet" << std::endl;
     return "";
   }
   return _file->GetName();
 }

◆ getEntry()

void HyperBinningDiskRes::getEntry ( int volumeNumber ) const

protected

Get a HyperVolume from the tree and load it into memory

Definition at line 55 of file HyperBinningDiskRes.cpp.

                                                         {
   if (_tree == 0){
     ERROR_LOG << "HyperBinningDiskRes::getEntry - tree doesn't exist" << std::endl; 
     return;
   }
   if ( _currentEntry != volumeNumber ){
     _currentEntry = volumeNumber;
     _tree->GetEntry(volumeNumber);
   }
 }

◆ getHyperVolume()

HyperVolume HyperBinningDiskRes::getHyperVolume ( int volumeNumber ) const

virtual

Get a HyperVolume from its volume number.

get one of the HyperVolumes

Implements HyperBinning.

Definition at line 67 of file HyperBinningDiskRes.cpp.

                                                                      {
   getEntry(volumeNumber);
   return HyperVolume(_cuboid);
 } 

◆ getLinkedHyperVolumes()

std::vector< int > HyperBinningDiskRes::getLinkedHyperVolumes ( int volumeNumber ) const

virtual

Get all HyperVolumes linked to a specific volume number i.e. from the binning hiearcy

Implements HyperBinning.

Definition at line 74 of file HyperBinningDiskRes.cpp.

                                                                                  {
   getEntry(volumeNumber);
   return *_linkedBins;
 }

◆ getNumHyperVolumes()

int HyperBinningDiskRes::getNumHyperVolumes ( ) const

virtual

Get the number of HyperVolumes (this is not the number of bins)

Implements HyperBinning.

Definition at line 123 of file HyperBinningDiskRes.cpp.

                                                  {
   if (_tree == 0){
     return 0;
   }
   return _tree->GetEntries();
 }  

◆ getNumPrimaryVolumes()

int HyperBinningDiskRes::getNumPrimaryVolumes ( ) const

virtual

Get the number of primary volumes

Implements HyperBinning.

Definition at line 169 of file HyperBinningDiskRes.cpp.

                                                      {
   if (_treePrimVol == 0) return 0;
   return _treePrimVol->GetEntries();
 }

◆ getPrimaryVolumeNumber()

int HyperBinningDiskRes::getPrimaryVolumeNumber ( int i ) const

virtual

Get the primary volume numbers

Implements HyperBinning.

Definition at line 176 of file HyperBinningDiskRes.cpp.

                                                           {
   if (_treePrimVol == 0) {
     ERROR_LOG << "HyperBinningDiskRes::getPrimaryVolumeNumber - No tree found" << std::endl;
   }
   _treePrimVol->GetEntry(i);
   return _primVolNum;
 }

◆ isDiskResident()

bool HyperBinningDiskRes::isDiskResident ( ) const

virtual

Reimplemented from BinningBase.

Definition at line 314 of file HyperBinningDiskRes.cpp.

                                               {
   return true;
 }

◆ load()

void HyperBinningDiskRes::load	(	TString	filename,
		TString	option = `"READ"`
	)

virtual

Load HyperBinningDiskRes from a file

Implements HyperBinning.

Definition at line 279 of file HyperBinningDiskRes.cpp.

                                                               {
   
   _writeable = false;
   if (option == "UPDATE" || option == "RECREATE") {
     _writeable = true;
   }
   
   if (_file != 0) _file->Close();
 
   _file = new TFile(filename, option);
   
   if (_file == 0){
     ERROR_LOG << "Could not open TFile in HyperBinningDiskRes::load(" << filename << ")";
     return;
   }
   
   if (option == "UPDATE" || option == "READ"){
     loadHyperBinningTree   ();
     loadPrimaryVolumeTree  ();
   }
   else if (option == "RECREATE"){
     //if we're opening a new file, we don't know the dimension yet.
     //wait until the dimension is set explicitly with setDimension().
     //createHyperBinningTree   (); 
     createPrimaryVolumeTree  ();    
   }
   else{
     ERROR_LOG << "There are only three load options (READ, RECREATE, UPDATE) - You have selected " << option << std::endl;
     return;
   }
 
   INFO_LOG << "Sucessfully attached Disk Resident HyperBinning to file " << filename << std::endl;
 
 }

◆ loadHyperBinningTree()

void HyperBinningDiskRes::loadHyperBinningTree ( )

protected

Definition at line 185 of file HyperBinningDiskRes.cpp.

                                               {
 
   _tree = dynamic_cast<TTree*>(_file->Get("HyperBinning"));
 
   if (_tree == 0){
     ERROR_LOG << "Could not open TTree in HyperBinningDiskRes::load()";
     return;
   }
   
   //Figure out how many dimensions there are from the tree
   setDimension( getHyperBinningDimFromTree(_tree) );
   
   _tree->SetBranchAddress("binNumber" , &_volumeNumber);
   _tree->SetBranchAddress("linkedBins", &_linkedBins   );
 
   for (int i = 0; i < getDimension(); i++){
     TString lowCornerName  = "lowCorner_" ; lowCornerName  += i; 
     TString highCornerName = "highCorner_"; highCornerName += i;   
     _tree->SetBranchAddress(lowCornerName , &_cuboid.getLowCorner ().at(i) );
     _tree->SetBranchAddress(highCornerName, &_cuboid.getHighCorner().at(i) );
   }
   
   //_tree->SetMaxVirtualSize(1000);
   _currentEntry = -1;
   updateCash();
 
 }

◆ loadPrimaryVolumeTree()

void HyperBinningDiskRes::loadPrimaryVolumeTree ( )

protected

Definition at line 215 of file HyperBinningDiskRes.cpp.

                                                {
 
   _treePrimVol = dynamic_cast<TTree*>( _file->Get("PrimaryVolumeNumbers") );
   
   if (_treePrimVol == 0){
     ERROR_LOG << "HyperBinningDiskRes::loadPrimaryVolumeNumbers - could not open TTree";
     return;
   }
 
   _treePrimVol->SetBranchAddress("volumeNumber", &_primVolNum);
 
 }

◆ reserveCapacity()

void HyperBinningDiskRes::reserveCapacity ( int nElements )

virtual

Reimplemented from HyperBinning.

Definition at line 325 of file HyperBinningDiskRes.cpp.

                                                       {
   HyperBinning::reserveCapacity(nElements);  
   
 }

◆ setDimension()

void HyperBinningDiskRes::setDimension ( int dim )

virtual

Set the dimension of the HyperBinningDiskRes. This can only be called once, when it is known what the dimension is i.e. either when loading from a file, or the first time a HyperVolume is added to an empty file

Reimplemented from HyperBinning.

Definition at line 44 of file HyperBinningDiskRes.cpp.

                                              {
   
   if (getDimension() == 0){
     HyperBinning::setDimension(dim);
     _cuboid = HyperCuboid(dim);
   }
 
 }

Member Data Documentation

◆ _cuboid

HyperCuboid HyperBinningDiskRes::_cuboid

mutableprivate

Definition at line 89 of file HyperBinningDiskRes.h.

◆ _currentEntry

int HyperBinningDiskRes::_currentEntry

mutableprivate

Definition at line 92 of file HyperBinningDiskRes.h.

◆ _file

TFile* HyperBinningDiskRes::_file

mutableprivate

Definition at line 85 of file HyperBinningDiskRes.h.

◆ _linkedBins

std::vector<int>* HyperBinningDiskRes::_linkedBins

mutableprivate

Definition at line 90 of file HyperBinningDiskRes.h.

◆ _primVolNum

int HyperBinningDiskRes::_primVolNum

mutableprivate

Definition at line 95 of file HyperBinningDiskRes.h.

◆ _tree

TTree* HyperBinningDiskRes::_tree

mutableprivate

Definition at line 88 of file HyperBinningDiskRes.h.

◆ _treePrimVol

TTree* HyperBinningDiskRes::_treePrimVol

mutableprivate

Definition at line 94 of file HyperBinningDiskRes.h.

◆ _volumeNumber

int HyperBinningDiskRes::_volumeNumber

mutableprivate

Definition at line 91 of file HyperBinningDiskRes.h.

◆ _writeable

bool HyperBinningDiskRes::_writeable

private

Definition at line 86 of file HyperBinningDiskRes.h.

The documentation for this class was generated from the following files:

Mint/HyperBinningDiskRes.h
src/Mojito/Chi2Test/HyperBinningDiskRes.cpp

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HyperBinningDiskRes() [1/2]

◆ HyperBinningDiskRes() [2/2]

◆ ~HyperBinningDiskRes()

Member Function Documentation

◆ addHyperVolume()

◆ addPrimaryVolumeNumber()

◆ clone()

◆ createHyperBinningTree()

◆ createPrimaryVolumeTree()

◆ filename()

◆ getEntry()

◆ getHyperVolume()

◆ getLinkedHyperVolumes()

◆ getNumHyperVolumes()

◆ getNumPrimaryVolumes()

◆ getPrimaryVolumeNumber()

◆ isDiskResident()

◆ load()

◆ loadHyperBinningTree()

◆ loadPrimaryVolumeTree()

◆ reserveCapacity()

◆ setDimension()

Member Data Documentation

◆ _cuboid

◆ _currentEntry

◆ _file

◆ _linkedBins

◆ _primVolNum

◆ _tree

◆ _treePrimVol

◆ _volumeNumber

◆ _writeable