CyclicPhaseBins Class Reference

#include <CyclicPhaseBins.h>

Public Member Functions
	CyclicPhaseBins (std::vector< double > binEdges)
	CyclicPhaseBins ()
void	setUniformCiSiBins (int nBinPairs)
void	setBinEdges (std::vector< double > binEdges)
int	getBinNumber (double phase) const
double	getLowBinBoundary (int bin) const
double	getHighBinBoundary (int bin) const
double	getLowBinBoundary (double phase) const
double	getHighBinBoundary (double phase) const
int	getNumBins () const
	~CyclicPhaseBins ()

Private Attributes
std::vector< double >	_binEdges

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

Dealing with cyclic bin boundaries is annoying. This class makes life easier.

Definition at line 20 of file CyclicPhaseBins.h.

Constructor & Destructor Documentation

CyclicPhaseBins() [1/2]

CyclicPhaseBins::CyclicPhaseBins

(

std::vector< double >

binEdges

)

Constuct a phase binning with the given bin edges. Since the binning is cyclic you only need nBins edges. The edges must be given in asending order, and within 2pi of each other

Definition at line 7 of file CyclicPhaseBins.cpp.

                                                          {
  
  double min = binEdges.at(0);
  for (unsigned i = 1; i < binEdges.size(); i++){

    double val = binEdges.at(i);
    if ( val < min ){
      ERROR_LOG << "CyclicPhaseBins::CyclicPhaseBins The bin edges MUST increase" << std::endl;
    }
    if ( val > min + TMath::Pi()*2.0 ){
      ERROR_LOG << "CyclicPhaseBins::CyclicPhaseBins This bin edge is more than 2pi bigger than the smallest bin edge!" << std::endl;
    }
  
  }

  _binEdges = binEdges;  

}

CyclicPhaseBins() [2/2]

CyclicPhaseBins::CyclicPhaseBins

(

)

Empty constuctor i.e. no bins

Definition at line 3 of file CyclicPhaseBins.cpp.

                                {

}

~CyclicPhaseBins()

CyclicPhaseBins::~CyclicPhaseBins

(

)

desctructor

Definition at line 128 of file CyclicPhaseBins.cpp.

                                 {

}

Member Function Documentation

getBinNumber()

int CyclicPhaseBins::getBinNumber

(

double

phase

)

const

For a given phase, return the bin number. Note that the phase does not have to be mapped into any particular range i.e. [-pi, +pi]

Definition at line 26 of file CyclicPhaseBins.cpp.

                                                   {
  
  double min = _binEdges.at(0);  
  
  bool tooSmall   = (phase - min) < 0.0;
  bool tooBig     = (phase - min) > TMath::Pi()*2.0;

  while (tooSmall || tooBig){
    if (tooSmall) {
      phase += 2.0*TMath::Pi();
      tooSmall = (phase - min) < 0.0;
    }
    if (tooBig  ) {
      phase -= 2.0*TMath::Pi();
      tooBig = (phase - min) > TMath::Pi()*2.0;
    }
  }
  
  for (unsigned i = 1; i < _binEdges.size(); i++){
    if (phase < _binEdges.at(i)) return i - 1; 
  }

  return _binEdges.size() - 1;
 
}

getHighBinBoundary() [1/2]

double CyclicPhaseBins::getHighBinBoundary

(

int

bin

)

const

Get the high bin edge for given bin number. This just uses the nmbers stored in _binEdges

Definition at line 73 of file CyclicPhaseBins.cpp.

                                                        {

  double highEdge = 0.0;

  if (bin == ((int)_binEdges.size() - 1) ){
    highEdge = _binEdges.at(0) + TMath::Pi()*2.0;
  }
  else{
    highEdge = _binEdges.at(bin+1);
  }

  return highEdge;
}

getHighBinBoundary() [2/2]

double CyclicPhaseBins::getHighBinBoundary

(

double

phase

)

const

Get the high bin edge for given phase. This appropriately maps the numbers stored in _binEdges so that the bin edge is below the phase given, but within 2pi

Definition at line 104 of file CyclicPhaseBins.cpp.

                                                            {

  int binNum = getBinNumber(phase);

  double highEdge = getHighBinBoundary(binNum);

  while (phase > highEdge){
    highEdge += TMath::Pi()*2.0;
  }

  while (phase < highEdge - TMath::Pi()*2.0){
    highEdge -= TMath::Pi()*2.0;
  }
  
  return highEdge;
}

getLowBinBoundary() [1/2]

double CyclicPhaseBins::getLowBinBoundary

(

int

bin

)

const

Get the low bin edge for given bin number. This just uses the nmbers stored in _binEdges

Definition at line 67 of file CyclicPhaseBins.cpp.

                                                       {

  return _binEdges.at(bin);

}

getLowBinBoundary() [2/2]

double CyclicPhaseBins::getLowBinBoundary

(

double

phase

)

const

Get the low bin edge for given phase. This appropriately maps the numbers stored in _binEdges so that the bin edge is below the phase given, but within 2pi

Definition at line 87 of file CyclicPhaseBins.cpp.

                                                            {

  int binNum = getBinNumber(phase);
  
  double lowEdge = getLowBinBoundary(binNum);
  
  while (phase < lowEdge){
    lowEdge -= TMath::Pi()*2.0;
  }

  while (phase > lowEdge + TMath::Pi()*2.0){
    lowEdge += TMath::Pi()*2.0;
  }
  
  return lowEdge;
}

getNumBins()

int CyclicPhaseBins::getNumBins

(

)

const

Get number of bins

Definition at line 121 of file CyclicPhaseBins.cpp.

                                     {

  return (int)_binEdges.size();

}

setBinEdges()

void CyclicPhaseBins::setBinEdges

(

std::vector< double >

binEdges

)

Set the bin edges. See constuctor for details

Definition at line 63 of file CyclicPhaseBins.cpp.

                                                                  {
  _binEdges = binEdges; 
}

setUniformCiSiBins()

void CyclicPhaseBins::setUniformCiSiBins

(

int

nBinPairs

)

set nBinPairs*2 uniformly spaces bins between -pi and pi

Definition at line 52 of file CyclicPhaseBins.cpp.

                                                                    {
  
  std::vector<double> binEdges;

  for (int i = 0; i < 2*nBinPairs; i++){
    binEdges.push_back( - TMath::Pi() + (TMath::Pi()/double(nBinPairs))*i );
  }

  _binEdges = binEdges;
}

Member Data Documentation

_binEdges

std::vector<double> CyclicPhaseBins::_binEdges

private

Definition at line 22 of file CyclicPhaseBins.h.

---

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

• Mint/CyclicPhaseBins.h
• src/Mojito/Chi2Test/CyclicPhaseBins.cpp