dE/dx cosine gain calibration constants More...

#include <CDCDedxCosineCor.h>

Inheritance diagram for CDCDedxCosineCor:

Public Member Functions
	CDCDedxCosineCor ()
	Default constructor.

	CDCDedxCosineCor (const std::vector< double > &cosgains)
	Old payloads Constructor.

	CDCDedxCosineCor (const std::vector< std::vector< double > > &groupCosgains, const std::vector< unsigned int > &layerToGroup)
	New-style constructor: grouped cosine corrections with layer-to-group mapping.

	~CDCDedxCosineCor ()
	Destructor.

CDCDedxCosineCor &	operator*= (const CDCDedxCosineCor &rhs)
	Combine payloads.

bool	isGrouped () const
	Check whether grouped mode is used.

unsigned int	getNGroups () const
	Get number of groups in grouped mode.

unsigned int	getNLayers () const
	Number of layers.

unsigned int	getGroup (unsigned int layer) const
	Get group index for layer.

unsigned int	getSize (unsigned int layer) const
	Get the number of bins.

const std::vector< double > &	getCosCor () const
	Get the old-style calibration constants.

const std::vector< std::vector< double > > &	getGroupCosCor () const
	Get the grouped calibration constants.

const std::vector< unsigned int > &	getLayerMap () const
	Get the Layer-to-group map.

void	setCosCor (unsigned int bin, double value)
	Set old-style cosine correction.

void	setCosCor (unsigned int group, unsigned int bin, double value)
	Set grouped cosine correction.

double	getMean (unsigned int bin) const
	Return dE/dx mean value for the given bin in old mode.

double	getMean (double costh) const
	Return dE/dx mean value for given cos(theta) in old mode.

double	getMean (unsigned int layer, unsigned int bin) const
	Return dE/dx mean value for the given layer and bin.

double	getMean (unsigned int layer, double costh) const
	Return dE/dx mean value for given layer and cos(theta)

Private Member Functions
double	getMeanFromVector (const std::vector< double > &gains, double costh) const
	Helper to interpolate/extrapolate from one vector of gains.

bool	isValidGroupedPayload () const
	Validate grouped payload content.

bool	multiplyGains (std::vector< double > &lhs, const std::vector< double > &rhs) const
	Multiply lhs by rhs with possible rebinning.

	ClassDef (CDCDedxCosineCor, 9)
	ClassDef.

Private Attributes
std::vector< double >	m_cosgains
	old-style dE/dx gains in cos(theta) bins

std::vector< std::vector< double > >	m_groupCosgains
	grouped dE/dx gains [group][bin]

std::vector< unsigned int >	m_layerToGroup
	map from layer index to group index

Detailed Description

dE/dx cosine gain calibration constants

Definition at line 26 of file CDCDedxCosineCor.h.

Constructor & Destructor Documentation

◆ CDCDedxCosineCor() [1/3]

CDCDedxCosineCor ( )

inline

Default constructor.

Definition at line 33 of file CDCDedxCosineCor.h.

33: m_cosgains(), m_groupCosgains(), m_layerToGroup() {};

◆ CDCDedxCosineCor() [2/3]

CDCDedxCosineCor ( const std::vector< double > & cosgains )

inlineexplicit

Old payloads Constructor.

Parameters

cosgains vector of calibration constants

Definition at line 39 of file CDCDedxCosineCor.h.

39 : m_cosgains(cosgains), m_groupCosgains(),

40 m_layerToGroup() {};

◆ CDCDedxCosineCor() [3/3]

CDCDedxCosineCor	(	const std::vector< std::vector< double > > &	groupCosgains,
		const std::vector< unsigned int > &	layerToGroup )

New-style constructor: grouped cosine corrections with layer-to-group mapping.

Parameters

groupCosgains	grouped calibration constants [group][bin]
layerToGroup	map from layer index to group index

Definition at line 15 of file CDCDedxCosineCor.cc.

{
 
  // 1. check groups exist
  if (groupCosgains.empty()) {
    B2ERROR("CDCDedxCosineCor: groupCosgains is empty.");
    return;
  }
 
  // 2. check layer mapping exists
  if (layerToGroup.empty()) {
    B2ERROR("CDCDedxCosineCor: layerToGroup is empty.");
    return;
  }
 
  for (size_t g = 0; g < groupCosgains.size(); ++g) {
    if (groupCosgains[g].empty()) {
      B2ERROR("CDCDedx1DCell: group " << g << " is empty.");
      return;
    }
  }
 
  // 4. check Layer -> group mapping
  for (size_t layer = 0; layer < layerToGroup.size(); layer++) {
 
    if (layerToGroup[layer] >= groupCosgains.size()) {
      B2ERROR("CDCDedxCosineCor: layer " << layer
              << " refers to invalid group "
              << layerToGroup[layer]);
      return;
    }
  }
 
  // 5. store data only after checks pass
  m_groupCosgains = groupCosgains;
  m_layerToGroup = layerToGroup;
 
// summary
  B2INFO("Cosine groups: " << m_groupCosgains.size());
  B2INFO("Cosine bins per group: " << m_groupCosgains[0].size());
 
  for (size_t layer = 0; layer < m_layerToGroup.size(); layer++) {
    B2INFO("layer " << layer << " -> group " << m_layerToGroup[layer]);
  }
 
}

◆ ~CDCDedxCosineCor()

~CDCDedxCosineCor ( )

inline

Destructor.

Definition at line 55 of file CDCDedxCosineCor.h.

55{};

Member Function Documentation

◆ getCosCor()

const std::vector< double > & getCosCor ( ) const

inline

Get the old-style calibration constants.

Returns: calibration constants

Definition at line 123 of file CDCDedxCosineCor.h.

    {
      return m_cosgains;
    }

◆ getGroup()

unsigned int getGroup ( unsigned int layer ) const

inline

Get group index for layer.

Definition at line 90 of file CDCDedxCosineCor.h.

    {
      if (layer >= getNLayers()) {
        B2ERROR("Layer out of range");
        return std::numeric_limits<unsigned int>::max();
      }
 
      if (!m_layerToGroup.empty()) {
        return m_layerToGroup[layer];
      }
 
      B2INFO("Invalid cosine correction payload state");
      return std::numeric_limits<unsigned int>::max();
    };

◆ getGroupCosCor()

const std::vector< std::vector< double > > & getGroupCosCor ( ) const

inline

Get the grouped calibration constants.

Returns: grouped calibration constants

Definition at line 132 of file CDCDedxCosineCor.h.

    {
      return m_groupCosgains;
    }

◆ getLayerMap()

const std::vector< unsigned int > & getLayerMap ( ) const

inline

Get the Layer-to-group map.

Returns: layer map

Definition at line 141 of file CDCDedxCosineCor.h.

    {
      return m_layerToGroup;
    }

◆ getMean() [1/4]

double getMean ( double costh ) const

Return dE/dx mean value for given cos(theta) in old mode.

Parameters

costh cos(theta)

Returns: mean value

Definition at line 122 of file CDCDedxCosineCor.cc.

{
  if (m_cosgains.empty()) return 1.0;
  return getMeanFromVector(m_cosgains, costh);
}

◆ getMean() [2/4]

double getMean ( unsigned int bin ) const

Return dE/dx mean value for the given bin in old mode.

Parameters

bin	cosine bin

Returns: mean value

Definition at line 115 of file CDCDedxCosineCor.cc.

{
  if (bin < m_cosgains.size()) return m_cosgains[bin];
  B2WARNING("CDCDedxCosineCor: bin out of range, returning value (1.0)");
  return 1.0;
}

◆ getMean() [3/4]

double getMean	(	unsigned int	layer,
		double	costh ) const

Return dE/dx mean value for given layer and cos(theta)

Parameters

layer	layer index
costh	cos(theta)

Returns: mean value

Definition at line 151 of file CDCDedxCosineCor.cc.

{
  if (isGrouped()) {
    if (!isValidGroupedPayload()) return 1.0;
 
    if (layer >= m_layerToGroup.size()) {
      B2ERROR("CDCDedxCosineCor: invalid layer index");
      return 1.0;
    }
 
    const unsigned int group = m_layerToGroup[layer];
    return getMeanFromVector(m_groupCosgains[group], costh);
  }
 
  return getMean(costh);
}

◆ getMean() [4/4]

double getMean	(	unsigned int	layer,
		unsigned int	bin ) const

Return dE/dx mean value for the given layer and bin.

Parameters

layer	layer index
bin	cosine bin

Returns: mean value

Definition at line 129 of file CDCDedxCosineCor.cc.

{
  if (isGrouped()) {
    if (!isValidGroupedPayload()) return 1.0;
 
    if (layer >= m_layerToGroup.size()) {
      B2ERROR("CDCDedxCosineCor: invalid layer index");
      return 1.0;
    }
 
    const unsigned int group = m_layerToGroup[layer];
    if (bin >= m_groupCosgains[group].size()) {
      B2ERROR("CDCDedxCosineCor: invalid bin number");
      return 1.0;
    }
 
    return m_groupCosgains[group][bin];
  }
 
  return getMean(bin);
}

◆ getMeanFromVector()

double getMeanFromVector	(	const std::vector< double > &	gains,
		double	costh ) const

private

Helper to interpolate/extrapolate from one vector of gains.

Parameters

gains	vector of gains
costh	cos(theta)

Returns: interpolated mean value

Definition at line 169 of file CDCDedxCosineCor.cc.

{
  if (std::abs(costh) > 1.0) return 0.0;
  if (gains.empty()) return 1.0;
 
  // gains are stored at the center of the bins
  // find the bin center immediately preceding this value of costh
  const double binsize = 2.0 / gains.size();
  const int bin = std::floor((costh - 0.5 * binsize + 1.0) / binsize);
 
  int thisbin = bin;
  int nextbin = bin + 1;
 
  // extrapolation
  // extrapolate backward for lowest half-bin and center positive half-bin
  // extrapolate forward for highest half-bin and center negative half-bin
  double halfBin = binsize / 2.0;
  if ((costh + 1.0) < halfBin || (costh > 0.0 && costh < halfBin)) {
    thisbin = bin + 1;
    nextbin = bin + 2;
  } else if ((costh - 1.0) > -1.0 * halfBin || (costh < 0.0 && costh > -1.0 * halfBin)) {
    thisbin = bin - 1;
    nextbin = bin;
  }
 
  const double frac = ((costh - 0.5 * binsize + 1.0) / binsize) - thisbin;
 
  if (thisbin < 0 || static_cast<unsigned int>(nextbin) >= gains.size()) {
    B2WARNING("Problem with extrapolation of CDC dE/dx cosine correction");
    return 1.0;
  }
 
  return (gains[nextbin] - gains[thisbin]) * frac + gains[thisbin];
}

◆ getNGroups()

unsigned int getNGroups ( ) const

inline

Get number of groups in grouped mode.

Returns: number of groups

Definition at line 75 of file CDCDedxCosineCor.h.

    {
      if (isGrouped()) return m_groupCosgains.size();
      return (m_cosgains.empty() ? 0 : 1);
    }

◆ getNLayers()

unsigned int getNLayers ( ) const

inline

Number of layers.

Definition at line 82 of file CDCDedxCosineCor.h.

    {
      if (!m_layerToGroup.empty()) return m_layerToGroup.size();
 
      return 0;
    };

◆ getSize()

unsigned int getSize ( unsigned int layer ) const

inline

Get the number of bins.

Returns: number of bins

Definition at line 109 of file CDCDedxCosineCor.h.

    {
      if (isGrouped()) {
        const unsigned int group = getGroup(layer);
        return m_groupCosgains[group].size();
      }
 
      return m_cosgains.size();
    }

◆ isGrouped()

bool isGrouped ( ) const

inline

Check whether grouped mode is used.

Returns: true if grouped constants are available

Definition at line 66 of file CDCDedxCosineCor.h.

    {
      return !m_groupCosgains.empty();
    }

◆ isValidGroupedPayload()

bool isValidGroupedPayload ( ) const

private

Validate grouped payload content.

Returns: true if grouped payload is consistent

Definition at line 85 of file CDCDedxCosineCor.cc.

{
  // Check that grouped cosine constants exist
  if (m_groupCosgains.empty()) {
    B2ERROR("CDCDedxCosineCor : no gain groups");
    return false;
  }
 
  // Check that the layer-to-group mapping exists
  if (m_layerToGroup.empty()) return false;
 
  // Verify that every layer refers to a valid group index
  for (unsigned int layer = 0; layer < m_layerToGroup.size(); ++layer) {
    if (m_layerToGroup[layer] >= m_groupCosgains.size()) {
      B2ERROR("CDCDedxCosineCor: layer-to-group map points to invalid group");
      return false;
    }
  }
 
  for (unsigned int g = 0; g < m_groupCosgains.size(); ++g) {
    if (m_groupCosgains[g].empty()) {
      B2ERROR("CDCDedxCosineCor: group " << g << " is empty");
      return false;
    }
  }
 
  // All checks passed
  return true;
}

◆ multiplyGains()

bool multiplyGains	(	std::vector< double > &	lhs,
		const std::vector< double > &	rhs ) const

private

Multiply lhs by rhs with possible rebinning.

If rhs has fewer bins, each rhs bin is applied to a block of lhs bins. This allows combining payloads with different binning (e.g. coarse => fine).

Definition at line 204 of file CDCDedxCosineCor.cc.

{
  if (rhs.empty() || lhs.size() % rhs.size() != 0) {
    return false;
  }
 
  const int scale = std::floor(static_cast<double>(lhs.size()) / rhs.size() + 0.001);
 
  for (unsigned int bin = 0; bin < lhs.size(); ++bin) {
    lhs[bin] *= rhs[std::floor(bin / static_cast<double>(scale) + 0.001)];
  }
 
  return true;
}

◆ operator*=()

CDCDedxCosineCor & operator*= ( const CDCDedxCosineCor & rhs )

Combine payloads.

Definition at line 219 of file CDCDedxCosineCor.cc.

{
  // old x old
  if (!isGrouped() && !rhs.isGrouped()) {
    if (!multiplyGains(m_cosgains, rhs.getCosCor())) {
      B2WARNING("Cosine gain parameters do not match, cannot merge!");
    }
    return *this;
  }
 
  // grouped x grouped
  if (isGrouped() && rhs.isGrouped()) {
    if (!isValidGroupedPayload() || !rhs.isValidGroupedPayload()) {
      B2WARNING("Invalid grouped cosine payload, cannot merge!");
      return *this;
    }
 
    if (m_layerToGroup != rhs.getLayerMap()) {
      B2WARNING("layer grouping does not match, cannot merge grouped cosine payloads!");
      return *this;
    }
 
    const std::vector<std::vector<double>>& rhsGroups = rhs.getGroupCosCor();
 
    if (m_groupCosgains.size() != rhsGroups.size()) {
      B2WARNING("Number of cosine groups does not match, cannot merge!");
      return *this;
    }
 
    for (unsigned int group = 0; group < m_groupCosgains.size(); ++group) {
      if (!multiplyGains(m_groupCosgains[group], rhsGroups[group])) {
        B2WARNING("Grouped cosine gain parameters do not match, cannot merge!");
        return *this;
      }
    }
    return *this;
  }
 
  B2WARNING("Cannot merge old-style and grouped cosine payloads directly!");
  return *this;
}

◆ setCosCor() [1/2]

void setCosCor	(	unsigned int	bin,
		double	value )

Set old-style cosine correction.

Parameters

bin	bin number
value	value to be set

Definition at line 64 of file CDCDedxCosineCor.cc.

{
  if (bin < m_cosgains.size()) m_cosgains[bin] = value;
  else B2ERROR("CDCDedxCosineCor: invalid bin number, value not set");
}

◆ setCosCor() [2/2]

void setCosCor	(	unsigned int	group,
		unsigned int	bin,
		double	value )

Set grouped cosine correction.

Parameters

group	group number
bin	bin number
value	value to be set

Definition at line 70 of file CDCDedxCosineCor.cc.

{
  if (group >= m_groupCosgains.size()) {
    B2ERROR("CDCDedxCosineCor: invalid group number, value not set");
    return;
  }
 
  if (bin >= m_groupCosgains[group].size()) {
    B2ERROR("CDCDedxCosineCor: invalid bin number, value not set");
    return;
  }
 
  m_groupCosgains[group][bin] = value;
}

Member Data Documentation

◆ m_cosgains

std::vector<double> m_cosgains

private

old-style dE/dx gains in cos(theta) bins

Definition at line 214 of file CDCDedxCosineCor.h.

◆ m_groupCosgains

std::vector<std::vector<double> > m_groupCosgains

private

grouped dE/dx gains [group][bin]

Definition at line 215 of file CDCDedxCosineCor.h.

◆ m_layerToGroup

std::vector<unsigned int> m_layerToGroup

private

map from layer index to group index

Definition at line 216 of file CDCDedxCosineCor.h.

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

cdc/dbobjects/include/CDCDedxCosineCor.h
cdc/dbobjects/src/CDCDedxCosineCor.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CDCDedxCosineCor() [1/3]

◆ CDCDedxCosineCor() [2/3]

◆ CDCDedxCosineCor() [3/3]

◆ ~CDCDedxCosineCor()

Member Function Documentation

◆ getCosCor()

◆ getGroup()

◆ getGroupCosCor()

◆ getLayerMap()

◆ getMean() [1/4]

◆ getMean() [2/4]

◆ getMean() [3/4]

◆ getMean() [4/4]

◆ getMeanFromVector()

◆ getNGroups()

◆ getNLayers()

◆ getSize()

◆ isGrouped()

◆ isValidGroupedPayload()

◆ multiplyGains()

◆ operator*=()

◆ setCosCor() [1/2]

◆ setCosCor() [2/2]

Member Data Documentation

◆ m_cosgains

◆ m_groupCosgains

◆ m_layerToGroup