#include <UniformBinning.h>

Inheritance diagram for UniformBinning:

Public Member Functions
	UniformBinning (HyperCuboid limits, int nLocalBins)
	The only constructor. More...

	UniformBinning (HyperCuboid limits, std::vector< int > nLocalBins)

virtual	~UniformBinning ()

int	getNumLocalBins (int dimension) const

int	getGlobalBinNumber (std::vector< int > localBinNumbers) const

std::vector< int >	getLocalBinNumbers (int globalBinNumber) const

int	getLocalBinNumber (int dim, double val) const

std::vector< int >	getLocalBinNumbers (const HyperPoint &coords) const

double	getLowBinEdgeLocal (int dim, int localBinNum) const

double	getHighBinEdgeLocal (int dim, int localBinNum) const

HyperPoint	getLowCorner (int globalBinNum) const

HyperPoint	getHighCorner (int globalBinNum) const

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

virtual BinningBase *	clone () const

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 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 bool	isDiskResident () const

virtual TString	filename () const

virtual	~BinningBase ()

virtual void	reserveCapacity (int nElements)

virtual std::vector< int >	getBinNum (const HyperPointSet &coords) const

Private Attributes
HyperCuboid	_limits

std::vector< int >	_nLocalBins

Additional Inherited Members
Protected Member Functions inherited from BinningBase
virtual void	setDimension (int dimension)

void	setBinningType (TString binningType)

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

Uniform binning

Definition at line 44 of file UniformBinning.h.

Constructor & Destructor Documentation

◆ UniformBinning() [1/2]

UniformBinning::UniformBinning	(	HyperCuboid	limits,
		int	nLocalBins
	)

The only constructor.

Definition at line 5 of file UniformBinning.cpp.

                                                                  :
   _limits    (limits),
   _nLocalBins(_limits.getDimension(), nLocalBins)
 {
   setBinningType("UniformBinning");
   setDimension  (_limits.getDimension());
   
   WELCOME_LOG << "Hello from the UniformBinning() Constructor";
 }

◆ UniformBinning() [2/2]

UniformBinning::UniformBinning	(	HyperCuboid	limits,
		std::vector< int >	nLocalBins
	)

Definition at line 16 of file UniformBinning.cpp.

                                                                             :
   _limits    (limits),
   _nLocalBins(nLocalBins)
 {
   setBinningType("UniformBinning");
   setDimension  (_limits.getDimension());
 
   WELCOME_LOG << "Hello from the UniformBinning() Constructor";
 }

◆ ~UniformBinning()

UniformBinning::~UniformBinning ( )

virtual

Definition at line 203 of file UniformBinning.cpp.

                                {
 
 }

Member Function Documentation

◆ clone()

BinningBase * UniformBinning::clone ( ) const

virtual

Implements BinningBase.

Definition at line 133 of file UniformBinning.cpp.

                                         {
   return new UniformBinning(*this);
 }

◆ getAverageBinWidth()

HyperPoint UniformBinning::getAverageBinWidth ( ) const

virtual

Implements BinningBase.

Definition at line 189 of file UniformBinning.cpp.

                                                     {
 
   HyperPoint binwidth(_limits.getHighCorner() - _limits.getLowCorner());
   for (int i = 0; i < getDimension(); i++){
     binwidth.at(i)/= double(getNumLocalBins(i));
   }
   return binwidth;
 
 }

◆ getBinHyperVolume()

HyperVolume UniformBinning::getBinHyperVolume ( int binNumber ) const

virtual

Implements BinningBase.

Definition at line 182 of file UniformBinning.cpp.

                                                                 {
   HyperCuboid cube( getLowCorner(binNumber), getHighCorner(binNumber) );
   return HyperVolume(cube);
 }

◆ getBinNum()

int UniformBinning::getBinNum ( const HyperPoint & coords ) const

virtual

Implements BinningBase.

Definition at line 176 of file UniformBinning.cpp.

                                                            {
   
   return getGlobalBinNumber( getLocalBinNumbers(coords) );
 
 }

◆ getGlobalBinNumber()

int UniformBinning::getGlobalBinNumber ( std::vector< int > localBinNumbers ) const

Definition at line 41 of file UniformBinning.cpp.

                                                                             {
 
   int dimension = getDimension();
 
   int multiplier = 1;
   int binNumber  = 0;
 
   for (int i = 0; i < dimension; i++){
     binNumber += localBinNumbers.at(i)*multiplier;
     multiplier *= getNumLocalBins(i);
   }
   
   return binNumber;
 
 }

◆ getHighBinEdgeLocal()

double UniformBinning::getHighBinEdgeLocal	(	int	dim,
		int	localBinNum
	)		const

Definition at line 97 of file UniformBinning.cpp.

                                                                         {
   
   double low    = _limits.getLowCorner ().at(dim);
   double high   = _limits.getHighCorner().at(dim);
   double nbins  = _nLocalBins            .at(dim);
   double width = (high - low)/nbins;
 
   return low + width*(localBinNum + 1.0);
 
 }

◆ getHighCorner()

HyperPoint UniformBinning::getHighCorner ( int globalBinNum ) const

Definition at line 117 of file UniformBinning.cpp.

                                                               {
   HyperPoint corner(getDimension());
   std::vector<int> localBinNum = getLocalBinNumbers(globalBinNum);
   for (int i = 0; i < getDimension(); i++){
     corner.at( i ) = getHighBinEdgeLocal( i, localBinNum.at(i) );
   }
   return corner;
 }

◆ getLimits()

HyperCuboid UniformBinning::getLimits ( ) const

virtual

Implements BinningBase.

Definition at line 199 of file UniformBinning.cpp.

                                                     {
   return _limits;
 }

◆ getLocalBinNumber()

int UniformBinning::getLocalBinNumber	(	int	dim,
		double	val
	)		const

Definition at line 153 of file UniformBinning.cpp.

                                                               {
   
   double low    = _limits.getLowCorner ().at(dim);
   double high   = _limits.getHighCorner().at(dim);
   double nbins  = _nLocalBins            .at(dim);
   double width = (high - low)/nbins; 
   
   return floor( val - low )/width; 
 
 }

◆ getLocalBinNumbers() [1/2]

std::vector< int > UniformBinning::getLocalBinNumbers ( int globalBinNumber ) const

Definition at line 57 of file UniformBinning.cpp.

                                                                             {
 
   int nBins = getNumBins();
 
   if ( globalBinNumber >= nBins || globalBinNumber < 0 ){
     ERROR_LOG << "UniformBinning::getLocalBinNumbers - The global bin number you have given is out of range = " << globalBinNumber << std::endl;
   }
  
   int dimension = getDimension();
   
   std::vector<int> localBinNums(dimension, -1.0);
 
   int multiplier = nBins;
 
   for (int i = dimension - 1; i >= 0; i--){
 
     multiplier = multiplier/getNumLocalBins(i); 
 
     int localBinNum = floor(double(globalBinNumber)/double(multiplier));
     
     globalBinNumber -= multiplier*localBinNum;
 
     localBinNums.at(i) = localBinNum;
   }
 
   return localBinNums;
 
 }

◆ getLocalBinNumbers() [2/2]

std::vector< int > UniformBinning::getLocalBinNumbers ( const HyperPoint & coords ) const

Definition at line 164 of file UniformBinning.cpp.

                                                                                {
   
   std::vector<int> localBinNums(getDimension(), -1);
 
   for (int i = 0; i < getDimension(); i++){
     localBinNums.at(i) = getLocalBinNumber(i, coords.at(i));
   }
   return localBinNums;
 
 }

◆ getLowBinEdgeLocal()

double UniformBinning::getLowBinEdgeLocal	(	int	dim,
		int	localBinNum
	)		const

Definition at line 86 of file UniformBinning.cpp.

                                                                        {
   
   double low    = _limits.getLowCorner ().at(dim);
   double high   = _limits.getHighCorner().at(dim);
   double nbins  = _nLocalBins            .at(dim);
   double width = (high - low)/nbins;
 
   return low + width*localBinNum;
 
 }

◆ getLowCorner()

HyperPoint UniformBinning::getLowCorner ( int globalBinNum ) const

Definition at line 108 of file UniformBinning.cpp.

                                                              {
   HyperPoint corner(getDimension());
   std::vector<int> localBinNum = getLocalBinNumbers(globalBinNum);
   for (int i = 0; i < getDimension(); i++){
     corner.at( i ) = getLowBinEdgeLocal( i, localBinNum.at(i) );
   }
   return corner;
 }

◆ getNumBins()

int UniformBinning::getNumBins ( ) const

virtual

Implements BinningBase.

Definition at line 32 of file UniformBinning.cpp.

                                     {
   int nBins = 1;
   for (int i = 0; i < getDimension(); i++){
     nBins *= getNumLocalBins(i);
   }
   return nBins;
 }

◆ getNumLocalBins()

int UniformBinning::getNumLocalBins ( int dimension ) const

Definition at line 28 of file UniformBinning.cpp.

                                                       {
   return _nLocalBins.at(dimension); 
 }

◆ load()

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

virtual

Implements BinningBase.

Definition at line 126 of file UniformBinning.cpp.

                                                          {
   //not implemented this yet so added these lines to stop
   //compiler warnings
   filename = filename;
   option = option;
 }

◆ mergeBinnings()

void UniformBinning::mergeBinnings ( const BinningBase & other )

virtual

Implements BinningBase.

Definition at line 147 of file UniformBinning.cpp.

                                                             {
   //not implemented this yet so added these lines to stop
   //compiler warnings
   other.getDimension();
 }

◆ save() [1/2]

void UniformBinning::save ( TString filename ) const

virtual

Implements BinningBase.

Definition at line 137 of file UniformBinning.cpp.

                                                {
   //not implemented this yet so added these lines to stop
   //compiler warnings
   filename = filename;
 }

◆ save() [2/2]

void UniformBinning::save ( ) const

virtual

Implements BinningBase.

Definition at line 143 of file UniformBinning.cpp.

                                {
 
 }

Member Data Documentation

◆ _limits

HyperCuboid UniformBinning::_limits

private

Definition at line 48 of file UniformBinning.h.

◆ _nLocalBins

std::vector<int> UniformBinning::_nLocalBins

private

Definition at line 49 of file UniformBinning.h.

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

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

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UniformBinning() [1/2]

◆ UniformBinning() [2/2]

◆ ~UniformBinning()

Member Function Documentation

◆ clone()

◆ getAverageBinWidth()

◆ getBinHyperVolume()

◆ getBinNum()

◆ getGlobalBinNumber()

◆ getHighBinEdgeLocal()

◆ getHighCorner()

◆ getLimits()

◆ getLocalBinNumber()

◆ getLocalBinNumbers() [1/2]

◆ getLocalBinNumbers() [2/2]

◆ getLowBinEdgeLocal()

◆ getLowCorner()

◆ getNumBins()

◆ getNumLocalBins()

◆ load()

◆ mergeBinnings()

◆ save() [1/2]

◆ save() [2/2]

Member Data Documentation

◆ _limits

◆ _nLocalBins