ParticleWeightingAxis Class Reference

Class for handling LookUp tables. More...

#include <ParticleWeightingAxis.h>

Collaboration diagram for ParticleWeightingAxis:

Public Member Functions
	ParticleWeightingAxis ()
	Constructor.
std::string	getName () const
	Returns name of an axis.
void	setName (const std::string &name)
	Sets name of an axis.
int	addBin (ParticleWeightingBinLimits *bin)
	Check if bin exists and creates it if not.
int	findBin (ParticleWeightingBinLimits *bin) const
	Returns id of bin with given bin limits Returns out-of-range binID if can't find.
int	findBin (double value) const
	Returns id of bin containing value.
void	printAxis () const
	Prints axis information to the B2INFO stream.

Private Member Functions
bool	isOverlappingBin (ParticleWeightingBinLimits *bin)
	Return TRUE if bin exists or overlaps with existing.

Private Attributes
BinMap	m_unnamedAxis
	Named axis with bins.
std::string	m_axisName
	Axis name.
const int	m_outOfRangeBinID = -1
	ID of out-of-range bin.

Detailed Description

Class for handling LookUp tables.

Definition at line 26 of file ParticleWeightingAxis.h.

Constructor & Destructor Documentation

ParticleWeightingAxis()

ParticleWeightingAxis ( )

inline

Constructor.

Definition at line 46 of file ParticleWeightingAxis.h.

{}

Member Function Documentation

addBin()

int addBin

(

ParticleWeightingBinLimits *

bin

)

Check if bin exists and creates it if not.

Returns bin ID Issues fatal error in case of overlapping bins.

Parameters

bin	bin limits

Returns

key ID

Definition at line 46 of file ParticleWeightingAxis.cc.

{
  int existing_id = this->findBin(bin);
  if (existing_id != m_outOfRangeBinID) {
    return existing_id;
  }
  if (this->isOverlappingBin(bin)) {
    B2FATAL("Attempting to add overlapping or existing bin");
  } else {
    int id = m_unnamedAxis.size() + 1;
    m_unnamedAxis.insert(std::make_pair(id, bin));
    return id;
  }
}

findBin() [1/2]

int findBin

(

double

value

)

const

Returns id of bin containing value.

Parameters

value

value

Returns

key ID

Definition at line 73 of file ParticleWeightingAxis.cc.

{
  for (auto i_bin : m_unnamedAxis) {
    if ((value >= i_bin.second->first()) and (value < i_bin.second->second())) {
      return i_bin.first;
    }
  }
  return m_outOfRangeBinID;
}

findBin() [2/2]

int findBin

(

ParticleWeightingBinLimits *

bin

)

const

Returns id of bin with given bin limits Returns out-of-range binID if can't find.

Parameters

bin	bin limits

Returns

key ID

Definition at line 62 of file ParticleWeightingAxis.cc.

{
  for (auto i_bin : m_unnamedAxis) {
    if ((bin->first() == i_bin.second->first()) and (bin->second() == i_bin.second->second())) {
      return i_bin.first;
    }
  }
  return m_outOfRangeBinID;
}

getName()

std::string getName ( ) const

inline

Returns name of an axis.

Definition at line 51 of file ParticleWeightingAxis.h.

{ return m_axisName;}

isOverlappingBin()

bool isOverlappingBin ( ParticleWeightingBinLimits *  bin )

private

Return TRUE if bin exists or overlaps with existing.

Parameters

bin	- tested bin

Returns

is this bin overlapping with existing bins or not

Checking if lower border is within some bin existing binning: | | new binning: | |

Checking if upper border is within some bin existing binning: | | new binning: | |

Checking if new bin covers existing bin completely existing binning: | | new binning: | |

Definition at line 14 of file ParticleWeightingAxis.cc.

{
  for (auto i_bin : m_unnamedAxis) {
    if ((bin->first() >= i_bin.second->first()) and (bin->first() < i_bin.second->second())) {
      return true;
    }
    if ((bin->second() > i_bin.second->first()) and (bin->second() <= i_bin.second->second())) {
      return true;
    }
    if ((bin->first() < i_bin.second->first()) and (bin->second() > i_bin.second->second())) {
      return true;
    }
  }
  return false;
}

printAxis()

void printAxis

(

)

const

Prints axis information to the B2INFO stream.

Definition at line 83 of file ParticleWeightingAxis.cc.

{
  B2INFO("Printing axis " + m_axisName);
  int len = 10;
  std::string id_cells = "";
  std::string bin_cells = "";
  for (auto i_entry : m_unnamedAxis) {
    std::string i_id = std::to_string(i_entry.first);
    int i_id_len = i_id.size();
    std::string i_ll = std::to_string(i_entry.second->first());
    int i_ll_len = i_ll.size();
    std::string i_ul = std::to_string(i_entry.second->second());
    int i_ul_len = i_ul.size();
    id_cells += "|" + std::string(len, ' ') + i_id + std::string(std::max(1, len - i_id_len + 1), ' ') + "|";
    bin_cells += "|" + i_ll + std::string(std::max(1, len - i_ll_len), ' ') + "|" + i_ul + std::string(std::max(1, len - i_ul_len),
                 ' ') + "|";
  }
  B2INFO(id_cells);
  B2INFO(bin_cells);
}

setName()

void setName ( const std::string &  name )

inline

Sets name of an axis.

Parameters

name

axis name

Definition at line 57 of file ParticleWeightingAxis.h.

{ m_axisName = name;}

Member Data Documentation

m_axisName

std::string m_axisName

private

Axis name.

Definition at line 30 of file ParticleWeightingAxis.h.

m_outOfRangeBinID

const int m_outOfRangeBinID = -1

private

ID of out-of-range bin.

Definition at line 32 of file ParticleWeightingAxis.h.

m_unnamedAxis

BinMap m_unnamedAxis

private

Named axis with bins.

Definition at line 28 of file ParticleWeightingAxis.h.

---

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

• analysis/dbobjects/include/ParticleWeightingAxis.h
• analysis/dbobjects/src/ParticleWeightingAxis.cc