FakeBkgTools::Yield Struct Reference

a structure to hold an event yield together with a statistical uncertainty and a variable number of systematic uncertainties More...

#include <FakeBkgInternals.h>

Inheritance diagram for FakeBkgTools::Yield:

Collaboration diagram for FakeBkgTools::Yield:

Public Member Functions
Yield &	add (const Yield &rhs, float weight=1.f)
	add() treats systematic uncertainties as correlated and updates (or creates) the total statistical uncertainty (RMS) More...
Yield &	add (const Weight &rhs, float weight=1.f)
float	stat () const
	Helper function to extract the total statistical uncertainty from the 'uncertainties' field; it returns the symmetrized uncertainties[Uncertainty::totalStat()] if present, else fabs(value) (not 0!) More...
float	syst () const
	Helper function to extract the total systematic uncertainty from the 'uncertainties' field; it is computed as the quadratic sum of all symmetrized systematic uncertainties. More...
float	value (const CP::BaseFakeBkgTool *tool) const
Efficiency &	add (const Efficiency &rhs, float weight=1.f)
	key = source of uncertainty (ID), value = up/down More...
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 More...
Efficiency &	multiply (float weight)
Efficiency &	setToConst (float value=1.f)
	setToConst() sets the nominal and all varied values to the same constant More...
Efficiency &	subFromOne ()
	subFromOne() sets nominal and varied values to 1 - previous value. More...

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

Detailed Description

a structure to hold an event yield together with a statistical uncertainty and a variable number of systematic uncertainties

Definition at line 69 of file FakeBkgInternals.h.

Member Function Documentation

add() [1/3]

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

inlineinherited

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;
}

add() [2/3]

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

inline

Systematic uncertainties

Statistical uncertainty ("RMS of weights")

Central value

Definition at line 173 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;
    }
    float ds2 = pow(weight * rhs.nominal, 2);
    stat2.up += ds2;
    stat2.down += ds2;
    nominal += weight * rhs.nominal;
    return *this;
}

add() [3/3]

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

inline

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

Systematic uncertainties

Statistical uncertainty ("RMS of weights")

Central value

Definition at line 191 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;
    }
    stat2.up += weight * weight * rhs.stat2.up;
    stat2.down += weight * weight * rhs.stat2.down;
    nominal += weight * rhs.nominal;
    return *this;
}

multiply() [1/2]

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

inlineinherited

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 )

inlineinherited

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 )

inlineinherited

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;
}

stat()

float FakeBkgTools::Yield::stat ( ) const

inline

Helper function to extract the total statistical uncertainty from the 'uncertainties' field; it returns the symmetrized uncertainties[Uncertainty::totalStat()] if present, else fabs(value) (not 0!)

Definition at line 279 of file FakeBkgInternals.h.

{
    return 0.5f*sqrt(stat2.up) + 0.5f*sqrt(stat2.down);
}

subFromOne()

Efficiency & FakeBkgTools::Efficiency::subFromOne ( )

inlineinherited

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;
}

syst()

float FakeBkgTools::Yield::syst ( ) const

inline

Helper function to extract the total systematic uncertainty from the 'uncertainties' field; it is computed as the quadratic sum of all symmetrized systematic uncertainties.

Definition at line 284 of file FakeBkgInternals.h.

{
    double syst2 = 0;
    for(auto& kv : uncertainties) syst2 += std::pow(0.5*(kv.second.up+kv.second.down), 2);
    return sqrt(syst2);
}

value()

float Efficiency::value ( const CP::BaseFakeBkgTool *  tool ) const

inherited

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

inherited

Definition at line 42 of file FakeBkgInternals.h.

stat2

Uncertainty FakeBkgTools::Yield::stat2

Definition at line 71 of file FakeBkgInternals.h.

uncertainties

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

inherited

Definition at line 43 of file FakeBkgInternals.h.

---

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

• FakeBkgInternals.h