FakeBkgTools::Efficiency Struct Reference

a structure to hold an efficiency together with a variable number of uncertainties More...

#include <FakeBkgInternals.h>

Inheritance diagram for FakeBkgTools::Efficiency:

Collaboration diagram for FakeBkgTools::Efficiency:

Public Member Functions
float	value (const CP::BaseFakeBkgTool *tool) const
Efficiency &	add (const Efficiency &rhs, float weight=1.f)
	key = source of uncertainty (ID), value = up/down
Efficiency &	multiply (const Efficiency &rhs, float weight=1.f)
	the first version of multiply() takes the product of two Efficiencies, setting the up and down variations for each uncertainty to give the correct variation for the product
Efficiency &	multiply (float weight)
Efficiency &	setToConst (float value=1.f)
	setToConst() sets the nominal and all varied values to the same constant
Efficiency &	subFromOne ()
	subFromOne() sets nominal and varied values to 1 - previous value.

Public Attributes
float	nominal = 0
std::map< uint16_t, FakeBkgTools::Uncertainty >	uncertainties

Detailed Description

a structure to hold an efficiency together with a variable number of uncertainties

Definition at line 39 of file FakeBkgInternals.h.

Member Function Documentation

add()

Efficiency & FakeBkgTools::Efficiency::add ( const Efficiency & rhs, float weight = 1.f )

inline

key = source of uncertainty (ID), value = up/down

add() treats systematic uncertainties as correlated and updates (or creates) the total statistical uncertainty (RMS)

Systematic uncertainties

Central value

Definition at line 208 of file FakeBkgInternals.h.

{
  for(auto& kv : rhs.uncertainties)
    {
      auto r = uncertainties.emplace(kv);
      if(r.second) r.first->second *= weight;
      else r.first->second += weight * kv.second;
    }
  nominal += weight * rhs.nominal;
  return *this;
}

multiply() [1/2]

Efficiency & FakeBkgTools::Efficiency::multiply ( const Efficiency & rhs, float weight = 1.f )

inline

the first version of multiply() takes the product of two Efficiencies, setting the up and down variations for each uncertainty to give the correct variation for the product

Systematic uncertainties

Central value

Definition at line 222 of file FakeBkgInternals.h.

{
  for(auto& kv : rhs.uncertainties)
    {
      auto r = uncertainties.emplace(kv);
      if(!r.second) {
    Uncertainty u_init = r.first->second;
    r.first->second = nominal*kv.second;
    r.first->second += (rhs.nominal*u_init); 
    r.first->second += (u_init*=kv.second);
      }
    }
  nominal *= weight * rhs.nominal;
  return *this;
}

multiply() [2/2]

Efficiency & FakeBkgTools::Efficiency::multiply ( float weight )

inline

Systematic uncertainties

Central value

Definition at line 240 of file FakeBkgInternals.h.

{
  for(auto& kv : uncertainties)
    {
      kv.second*= weight;
    }
    nominal *= weight;
    return *this;
}

setToConst()

Efficiency & FakeBkgTools::Efficiency::setToConst ( float value = 1.f )

inline

setToConst() sets the nominal and all varied values to the same constant

Systematic uncertainties

Central value

Definition at line 252 of file FakeBkgInternals.h.

{
    for(auto& kv : uncertainties)
    {
      kv.second.up = 0.;
      kv.second.down = 0.;
    }
    nominal = val;
    return *this;
}

subFromOne()

Efficiency & FakeBkgTools::Efficiency::subFromOne ( )

inline

subFromOne() sets nominal and varied values to 1 - previous value.

Systematic uncertainties

Central value

Definition at line 265 of file FakeBkgInternals.h.

{
    for(auto& kv : uncertainties)
    {
      kv.second.up = -kv.second.up;
      kv.second.down = -kv.second.down;
    }
    nominal = 1.-nominal;
    return *this;
}

value()

float Efficiency::value

(

const CP::BaseFakeBkgTool *

tool

)

const

Definition at line 17 of file FakeBkgInternals.cxx.

{
    float val = nominal;
    for(const auto* su = tool->m_selectedUncertainties; su; su = su->next())
    {
        auto unc = uncertainties.find(su->UID);
        if(unc != uncertainties.end())
        {
            val += su->sigma * ((su->sigma>=0)? unc->second.up : unc->second.down);
        }
    }
    return val;
}

Member Data Documentation

nominal

float FakeBkgTools::Efficiency::nominal = 0

Definition at line 42 of file FakeBkgInternals.h.

uncertainties

std::map<uint16_t, FakeBkgTools::Uncertainty> FakeBkgTools::Efficiency::uncertainties

Definition at line 43 of file FakeBkgInternals.h.

---

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

• FakeBkgInternals.h
• FakeBkgInternals.cxx