ParticleWeightingKeyMap Class Reference

Class for handling KeyMap. More...

#include <ParticleWeightingKeyMap.h>

Public Member Functions
	ParticleWeightingKeyMap ()
	Constructor.
void	addAxis (const std::string &name)
	Add axis.
int	addKey (NDBin bin, int key_ID)
	Adding predefined ID to the table.
double	addKey (NDBin bin)
	Adding predefined ID to the table.
double	getKey (std::map< std::string, double > values) const
	Get global bin ID for given observable values.
std::vector< std::string >	getNames () const
	Get vector of names ParticleWeightingKeyMap.
void	printKeyMap () const
	Print content of the key map.

Private Attributes
std::map< std::string, ParticleWeightingAxis * >	m_axes
	Axes mapped with their names.
std::vector< MultiDimBin >	m_bins
	Vector of keys.
const int	m_outOfRangeBin = -1
	We assign unique bin ID for out-of-range bin.

Detailed Description

Class for handling KeyMap.

Definition at line 37 of file ParticleWeightingKeyMap.h.

Constructor & Destructor Documentation

ParticleWeightingKeyMap()

ParticleWeightingKeyMap ( )

inline

Constructor.

Definition at line 58 of file ParticleWeightingKeyMap.h.

{}

Member Function Documentation

addAxis()

void addAxis

(

const std::string &

name

)

Add axis.

Definition at line 18 of file ParticleWeightingKeyMap.cc.

{
  auto* axis = new ParticleWeightingAxis();;
  axis->setName(name);
  // Note: map is sorted by keys (C++ standards)
  m_axes.insert(std::make_pair(name, axis));
}

addKey() [1/2]

double addKey

(

NDBin

bin

)

Adding predefined ID to the table.

Parameters

bin	contains bin ranges and names of the variables

Returns

added key ID

Definition at line 69 of file ParticleWeightingKeyMap.cc.

{
  return this->addKey(std::move(bin), m_bins.size());
}

addKey() [2/2]

int addKey	(	NDBin	bin,
		int	key_ID )

Adding predefined ID to the table.

Parameters

bin	contains bin ranges and names of the variables
key_ID	predefined bin ID

Returns

added key ID

Definition at line 27 of file ParticleWeightingKeyMap.cc.

{
  // Note: it is only possible to add axes to an empty key map
  if (key_ID == m_outOfRangeBin) {
    B2FATAL("You are trying create bin with ID identical to out-of-range Bin : " << m_outOfRangeBin);
    return -1;
  }
 
  if (m_axes.size() == 0) {
    for (const auto& i_1dbin : bin) {
      this->addAxis(i_1dbin.first);
    }
  }
 
  if (bin.size() != m_axes.size()) {
    B2FATAL("Inconsistent dimensionality of added bin");
    return -1;
  }
 
  std::vector<int> bin_id_collection;
  for (auto i_axis : m_axes) {
    auto it =  bin.find(i_axis.first);
    if (it != bin.end()) {
      bin_id_collection.push_back(i_axis.second->addBin(it->second));
    } else {
      B2FATAL("Names of bin and existing axes don't match");
      return -1;
    }
  }
 
  for (auto i_bin : m_bins) {
    if (std::equal(i_bin.first.begin(), i_bin.first.end(), bin_id_collection.begin())) {
      B2FATAL("You tried to overwrite existing bin " + std::to_string(i_bin.second) + " with new ID " + std::to_string(key_ID));
      return -1;
    }
  }
 
  m_bins.emplace_back(bin_id_collection, key_ID);
  return key_ID;
}

getKey()

double getKey

(

std::map< std::string, double >

values

)

const

Get global bin ID for given observable values.

Parameters

values

map of axis names and corresponding values

Returns

global ID

Definition at line 75 of file ParticleWeightingKeyMap.cc.

{
  if (values.size() != m_axes.size()) {
    B2FATAL("Inconsistent dimensionality of requested value map");
    return -1;
  }
  std::vector<int> bin_id_collection;
  for (auto i_axis : m_axes) {
    auto it =  values.find(i_axis.first);
    if (it != values.end()) {
      bin_id_collection.push_back(i_axis.second->findBin(it->second));
    } else {
      B2FATAL("Names of bin and existing axes don't match");
      return -1;
    }
  }
  for (auto i_bin : m_bins) {
    if (std::equal(i_bin.first.begin(), i_bin.first.end(), bin_id_collection.begin())) {
      return i_bin.second;
    }
  }
  return m_outOfRangeBin;
}

getNames()

std::vector< std::string > getNames

(

)

const

Get vector of names ParticleWeightingKeyMap.

Returns

vector of axes names

Definition at line 100 of file ParticleWeightingKeyMap.cc.

{
  std::vector<std::string> names;
  for (const auto& i_axis : m_axes) {
    names.push_back(i_axis.first);
  }
  return names;
}

printKeyMap()

void printKeyMap

(

)

const

Print content of the key map.

Definition at line 110 of file ParticleWeightingKeyMap.cc.

{
  std::string axes_names = "";
  for (auto i_axis : m_axes) {
    axes_names += "'" + i_axis.first + "' bin;";
    i_axis.second->printAxis();
  }
  B2INFO("Bin map \n <" + axes_names + "> : <global ID>");
  for (const auto& i_bin : m_bins) {
    std::string binIDs = "";
    for (auto i_binid : i_bin.first) {
      binIDs += std::to_string(i_binid) + "; ";
    }
    B2INFO(binIDs + " : " + std::to_string(i_bin.second));
  }
 
}

Member Data Documentation

m_axes

std::map<std::string, ParticleWeightingAxis*> m_axes

private

Axes mapped with their names.

Definition at line 42 of file ParticleWeightingKeyMap.h.

m_bins

std::vector<MultiDimBin> m_bins

private

Vector of keys.

Definition at line 46 of file ParticleWeightingKeyMap.h.

m_outOfRangeBin

const int m_outOfRangeBin = -1

private

We assign unique bin ID for out-of-range bin.

Definition at line 51 of file ParticleWeightingKeyMap.h.

---

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

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