Class to store a single weight entry (one bin). More...

#include <APWeightEntry.h>

Collaboration diagram for APWeightEntry:

Public Member Functions
	APWeightEntry ()
	Default constructor.
	APWeightEntry (unsigned int val_denominator, unsigned int val_numerator, double scale, bool isTrig=false)
	Constructor, takes n_denom, n_num, the relative scale of the used samples or an additional user scale and a bool if the entry is a trigger weight.
virtual	~APWeightEntry ()
	Default destructor.
void	ReadEfficiency (double efficiency, double err_low, double err_high)
	Read efficiencies and upper/lower uncertainty (if numerator/denominator not applicable (e.g.
void	SetCoordinates (const std::vector< int > &coords, const std::vector< int > &n_dim_origin)
unsigned int	GetValDenominator () const
	Get value of original denominator.
unsigned int	GetValNumerator () const
	Get value of original numerator.
double	GetExpectancy () const
	Get Expectancy value of efficiency/weight.
double	GetVariance () const
	Get Variance of efficiency/weight (classical binomial/poisson model).
double	GetStatUncertLow () const
	Get lower bound of asymmetric statistical uncertainty.
double	GetStatUncertHigh () const
	Get upper bound of asymmetric statistical uncertainty.
double	GetSysUncert () const
	Get absolute systematic uncertainty value of efficiency/weight.
double	GetSysUncert2 () const
	Get absolute systematic uncertainty squared value of efficiency/weight.
double	GetRandom ()
	Get random number from PDF.
TH1F *	GetPDF ()
	Returns the calculated PDF.
unsigned int	GetID () const
	Returns the internal ID (used by APReweight/APReweight2D/APReweight3D/APReweightND).
const std::vector< int > &	GetCoords () const
	Returns the coordinates of the current entry in the original histogram.
const std::vector< int > &	GetOriginalDimensions () const
	Returns the dimensions and amounts of bins for each dimension of the original histogram.
bool	IsNaN () const
	Returns true if instance is NaN.
bool	IsTrig () const
	Returns true if instance is trigger based.
void	SetSystUncert (double rel_uncert)
	Set the relative (!) systematic uncertainty for the efficiency/weight.
void	SetID (unsigned int id)
	Set the internal ID (used by APReweight/APReweight2D/APReweight3D/APReweightND).

Private Member Functions
	APWeightEntry (const APWeightEntry &)
APWeightEntry &	operator= (const APWeightEntry &)
void	_CreateHist ()
	Creates a TH1F instance from the arrays if necessary.
void	_ComputeCum ()
	Calculates the cumulative function of the pdf if necessary.

Private Attributes
unsigned int	m_val_denominator
	Holds the value of original denominator.
unsigned int	m_val_numerator
	Holds the value of original numerator.
double	m_expectancy_val
	Holds the Expectancy value of efficiency/weight.
double	m_variance
	Holds Variance of efficiency/weight (classical binomial/poisson model).
double	m_stat_uncert_low
	Holds lower bound of asymmetric statistical uncertainty.
double	m_stat_uncert_high
	Holds upper bound of asymmetric statistical uncertainty.
double	m_sys_uncert
	Holds absolute systematic uncertainty value of efficiency/weight.
double	m_sys_uncert2
	Holds absolute systematic uncertainty squared value of efficiency/weight.
bool	m_is_trig
	Flag, set to true if weight entry is trigger based.
bool	m_is_nan
	Flag, set to true if denominator is zero.
unsigned int	m_ID
	Holds internal ID (used by APReweight/APReweight2D/APReweight3D/APReweightND).
double	m_integral
	Holds the integral of the probability distribution.
double *	m_pdf
double *	m_bins
double *	m_cumul
	Histograms to hold the probability distribution and the cumulative distribution.
TH1F *	m_hist
	Holds the TH1F instance from the arrays if computed.
std::vector< int >	m_coords
	Holds the coordinates of the current entry in the original histogram.
std::vector< int >	m_n_dim_origin
	Holds the amount of dimensions and bins per axis in the original histogram.

Detailed Description

Class to store a single weight entry (one bin).

Stores a single binned weight, corresponding to a pair of bins from the underlying numerator and denominator histograms. Allows access to quantities like central values, uncertainties and PDFs.

Author: fabia.nosp@m.n.Ko.nosp@m.hn@ce.nosp@m.rn.c.nosp@m.h

Definition at line 25 of file APWeightEntry.h.

Constructor & Destructor Documentation

◆ APWeightEntry() [1/3]

APWeightEntry::APWeightEntry ( )

Default constructor.

Definition at line 20 of file APWeightEntry.cxx.

  : m_val_denominator(0),
    m_val_numerator(0),
    m_expectancy_val(0),
    m_variance(0),
    m_stat_uncert_low(0),
    m_stat_uncert_high(0),
    m_sys_uncert(0),
    m_sys_uncert2(0),
    m_is_trig(0),
    m_is_nan(0),
    m_integral(0)
{
  m_hist = 0;
  m_cumul = 0;
  m_pdf = 0;
  m_bins = 0;
  m_ID = 0;
  //m_coords = 0;
}

◆ APWeightEntry() [2/3]

APWeightEntry::APWeightEntry	(	unsigned int	val_denominator,
		unsigned int	val_numerator,
		double	scale,
		bool	isTrig = false )

Constructor, takes n_denom, n_num, the relative scale of the used samples or an additional user scale and a bool if the entry is a trigger weight.

Definition at line 41 of file APWeightEntry.cxx.

  : m_stat_uncert_low(0),
    m_stat_uncert_high(0)
{
  m_val_denominator = val_denominator;
  double val_denominator_f = (double) val_denominator;
  m_val_numerator = val_numerator;
  double val_numerator_f = (double) val_numerator;
  m_sys_uncert = 0.;
  m_sys_uncert2 = 0.;
  m_integral = 0.;
  m_hist = 0;
  m_cumul = 0;
  m_bins = 0;
  m_pdf = 0;
  m_is_trig = isTrig;
  m_ID = 0;
  //m_coords = 0;
 
  if (!isTrig) {
    if (m_val_numerator == 0 || m_val_denominator == 0) {
      m_expectancy_val = 0.;
      m_variance = 0.;
      m_stat_uncert_low = 0.;
      m_stat_uncert_high = 0.;
      m_is_nan = true;
    } else {
      m_is_nan = false;
      m_pdf = new double[1000];
      m_bins = new double[1001];
 
      m_expectancy_val = scale * (val_numerator_f / val_denominator_f);
      m_variance = (val_numerator_f / (val_denominator_f * val_denominator_f)) + ((val_numerator_f * val_numerator_f) / (val_denominator_f * val_denominator_f * val_denominator_f));
      m_stat_uncert_low = m_variance;
      m_stat_uncert_high = m_variance;
 
      double sig_low = (std::max((double) 0.0, (m_expectancy_val - 5. * scale * sqrt(m_variance))));
      double sig_high = (m_expectancy_val + 5. * scale * sqrt(m_variance));
      double step = (sig_high - sig_low) * 1e-3;
      const double inv_scale = 1. / scale;
      double shift = val_numerator_f * log(m_expectancy_val * inv_scale)+(-val_numerator_f - val_denominator_f - 2.) * log((m_expectancy_val * inv_scale) + 1.);
      //double shift = ln_factorialApp(m_val_numerator);
 
      double temp_value = sig_low;
      double arr_position = sig_low;
 
      for (int i = 0; i < 1000; ++i) {
        temp_value = exp(m_val_numerator * log(arr_position * inv_scale)+(-val_numerator_f - val_denominator_f - 2.) * log((arr_position * inv_scale) + 1.) - shift);
        if (temp_value != temp_value) temp_value = 0.;
        m_pdf[i] = temp_value;
        m_integral += temp_value;
        m_bins[i] = arr_position;
        arr_position += step;
      }
      m_bins[1000] = arr_position;
    }
  } else {
    if (m_val_denominator == 0) {
      m_expectancy_val = 0.;
      m_variance = 0.;
      m_stat_uncert_low = 0.;
      m_stat_uncert_high = 0.;
      m_is_nan = true;
    } else {
      m_is_nan = false;
      m_pdf = new double[1000];
      m_bins = new double[1001];
 
      const double inv_val_denominator_f = 1. / val_denominator_f;
      m_expectancy_val = val_numerator_f * inv_val_denominator_f;
      m_variance = (m_expectancy_val * (1. - m_expectancy_val)) * inv_val_denominator_f;
      double var_sqrt = sqrt(m_variance);
      double sig_low = std::max(0., m_expectancy_val - 5. * var_sqrt);
      double sig_high = std::min(1., m_expectancy_val + 5. * var_sqrt);
      if (val_numerator_f == 0) {
        sig_low = 0.;
        sig_high = std::min(1., (8. * inv_val_denominator_f));
      }
      if (val_numerator_f == val_denominator_f) {
        sig_low = std::max(0., (1. - 8. * inv_val_denominator_f));
        sig_high = 1.;
      }
 
      double step = fabs(sig_high - sig_low) * 1e-3;
      double shift = 0.;
      if (val_numerator_f == 0 || val_numerator_f == val_denominator_f) {
        shift = 0.;
      } else {
        shift = val_numerator_f * log(m_expectancy_val) + (val_denominator_f - val_numerator_f) * log(1. - m_expectancy_val);
      }
 
      double temp_value = sig_low;
      double arr_position = sig_low;
 
      if (val_numerator_f == 0) {
        for (int i = 0; i < 1000; ++i) {
          temp_value = exp(val_denominator_f * log(1. - arr_position) - shift);
          m_pdf[i] = temp_value;
          m_integral += temp_value;
          m_bins[i] = arr_position;
          arr_position += step;
        }
      } else {
        if (val_numerator_f == val_denominator_f) {
          for (int i = 0; i < 1000; ++i) {
            temp_value = exp(val_numerator_f * log(arr_position) - shift);
            m_pdf[i] = temp_value;
            m_integral += temp_value;
            m_bins[i] = arr_position;
            arr_position += step;
          }
        } else {
          for (int i = 0; i < 1000; ++i) {
            temp_value = exp(val_numerator_f * log(arr_position) + (val_denominator_f - val_numerator_f) * log(1. - arr_position) - shift);
            m_pdf[i] = temp_value;
            m_integral += temp_value;
            m_bins[i] = arr_position;
            arr_position += step;
          }
        }
      }
      m_bins[1000] = arr_position;
    }
  }
 
}

◆ ~APWeightEntry()

APWeightEntry::~APWeightEntry ( )

virtual

Default destructor.

Definition at line 188 of file APWeightEntry.cxx.

                              {
  delete [] m_pdf;
  m_pdf = 0;
  delete [] m_bins;
  m_bins = 0;
  delete [] m_cumul;
  m_cumul = 0;
  delete m_hist;
}

◆ APWeightEntry() [3/3]

APWeightEntry::APWeightEntry ( const APWeightEntry & )

private

Member Function Documentation

◆ _ComputeCum()

void APWeightEntry::_ComputeCum ( )

private

Calculates the cumulative function of the pdf if necessary.

Definition at line 286 of file APWeightEntry.cxx.

                                {
  if (m_cumul) delete [] m_cumul;
  m_cumul = new double[1001];
  m_cumul[0] = 0.;
  for (int i = 0; i < 1000; ++i) {
    m_cumul[i + 1] = m_cumul[i] + m_pdf[i];
  }
  const double inv_normalize = 1. / m_cumul[1000];
  for (int i = 1; i < 1000; ++i) {
    m_cumul[i] *= inv_normalize;
  }
}

◆ _CreateHist()

void APWeightEntry::_CreateHist ( )

private

Creates a TH1F instance from the arrays if necessary.

Definition at line 277 of file APWeightEntry.cxx.

                                {
  m_hist = new TH1F("", "", 1000, m_bins);
  if (m_is_nan == false) {
    for (int i = 0; i < 1000; ++i) {
      m_hist->SetBinContent(i + 1, m_pdf[i]);
    }
  }
}

◆ GetCoords()

const vector< int > & APWeightEntry::GetCoords ( ) const

Returns the coordinates of the current entry in the original histogram.

Definition at line 252 of file APWeightEntry.cxx.

                                                   {
  return m_coords;
}

◆ GetExpectancy()

double APWeightEntry::GetExpectancy ( ) const

Get Expectancy value of efficiency/weight.

Definition at line 206 of file APWeightEntry.cxx.

                                          {
  return m_expectancy_val;
}

◆ GetID()

unsigned int APWeightEntry::GetID ( ) const

Returns the internal ID (used by APReweight/APReweight2D/APReweight3D/APReweightND).

Definition at line 248 of file APWeightEntry.cxx.

                                        {
  return m_ID;
}

◆ GetOriginalDimensions()

const vector< int > & APWeightEntry::GetOriginalDimensions ( ) const

Returns the dimensions and amounts of bins for each dimension of the original histogram.

Definition at line 256 of file APWeightEntry.cxx.

                                                                 {
  return m_n_dim_origin;
}

◆ GetPDF()

TH1F * APWeightEntry::GetPDF ( )

Returns the calculated PDF.

Definition at line 243 of file APWeightEntry.cxx.

                            {
  if (!m_hist) _CreateHist();
  return m_hist;
}

◆ GetRandom()

double APWeightEntry::GetRandom ( )

Get random number from PDF.

Definition at line 230 of file APWeightEntry.cxx.

                                {
 
  static RootUtils::TRandomTLS<TRandom3> random ATLAS_THREAD_SAFE;
  if (m_is_nan || m_integral < std::numeric_limits<double>::epsilon()) {
    return 1e-100;
  }
  if (!m_cumul) _ComputeCum();
  double rn = random->Rndm();
  int ibin = TMath::BinarySearch(1000, m_cumul, rn);
  return m_bins[ibin];
  //if (rn > m_cumul[ibin]) x += fabs(m_bins[1]-m_bins[0]) * (rn-m_cumul[ibin])/(m_cumul[ibin+1] - m_cumul[ibin]);
}

◆ GetStatUncertHigh()

double APWeightEntry::GetStatUncertHigh ( ) const

Get upper bound of asymmetric statistical uncertainty.

Definition at line 218 of file APWeightEntry.cxx.

                                              {
  return m_stat_uncert_high;
}

◆ GetStatUncertLow()

double APWeightEntry::GetStatUncertLow ( ) const

Get lower bound of asymmetric statistical uncertainty.

Definition at line 214 of file APWeightEntry.cxx.

                                             {
  return m_stat_uncert_low;
}

◆ GetSysUncert()

double APWeightEntry::GetSysUncert ( ) const

Get absolute systematic uncertainty value of efficiency/weight.

Definition at line 222 of file APWeightEntry.cxx.

                                         {
  return m_sys_uncert;
}

◆ GetSysUncert2()

double APWeightEntry::GetSysUncert2 ( ) const

Get absolute systematic uncertainty squared value of efficiency/weight.

Definition at line 226 of file APWeightEntry.cxx.

                                          {
  return m_sys_uncert2;
}

◆ GetValDenominator()

unsigned int APWeightEntry::GetValDenominator ( ) const

Get value of original denominator.

Definition at line 198 of file APWeightEntry.cxx.

                                                    {
  return m_val_denominator;
}

◆ GetValNumerator()

unsigned int APWeightEntry::GetValNumerator ( ) const

Get value of original numerator.

Definition at line 202 of file APWeightEntry.cxx.

                                                  {
  return m_val_numerator;
}

◆ GetVariance()

double APWeightEntry::GetVariance ( ) const

Get Variance of efficiency/weight (classical binomial/poisson model).

Definition at line 210 of file APWeightEntry.cxx.

                                        {
  return m_variance;
}

◆ IsNaN()

bool APWeightEntry::IsNaN ( ) const

Returns true if instance is NaN.

Definition at line 260 of file APWeightEntry.cxx.

                                {
  return m_is_nan;
}

◆ IsTrig()

bool APWeightEntry::IsTrig ( ) const

Returns true if instance is trigger based.

Definition at line 264 of file APWeightEntry.cxx.

                                 {
  return m_is_trig;
}

◆ operator=()

APWeightEntry & APWeightEntry::operator= ( const APWeightEntry & )

private

◆ ReadEfficiency()

void APWeightEntry::ReadEfficiency	(	double	efficiency,
		double	err_low,
		double	err_high )

Read efficiencies and upper/lower uncertainty (if numerator/denominator not applicable (e.g.

Bootstrap)).

Definition at line 168 of file APWeightEntry.cxx.

                                                                                     {
  m_val_denominator = 0;
  m_val_numerator = 0;
  m_sys_uncert = 0.;
  m_sys_uncert2 = 0.;
  m_expectancy_val = efficiency;
  m_stat_uncert_low = fabs(err_low);
  m_stat_uncert_high = fabs(err_high);
  m_variance = (m_stat_uncert_low + m_stat_uncert_high) / 2.0;
  m_variance *= m_variance;
}

◆ SetCoordinates()

void APWeightEntry::SetCoordinates	(	const std::vector< int > &	coords,
		const std::vector< int > &	n_dim_origin )

Definition at line 180 of file APWeightEntry.cxx.

                                                                       {
  m_coords.clear();
  m_n_dim_origin.clear();
  m_coords = coords;
  m_n_dim_origin = n_dim_origin;
}

◆ SetID()

void APWeightEntry::SetID ( unsigned int id )

Set the internal ID (used by APReweight/APReweight2D/APReweight3D/APReweightND).

Definition at line 273 of file APWeightEntry.cxx.

                                         {
  m_ID = id;
}

◆ SetSystUncert()

void APWeightEntry::SetSystUncert ( double rel_uncert )

Set the relative (!) systematic uncertainty for the efficiency/weight.

Definition at line 268 of file APWeightEntry.cxx.

                                                   {
  m_sys_uncert = m_expectancy_val*rel_uncert;
  m_sys_uncert2 = m_sys_uncert*m_sys_uncert;
}

Member Data Documentation

◆ m_bins

double * APWeightEntry::m_bins

private

Definition at line 76 of file APWeightEntry.h.

◆ m_coords

std::vector<int> APWeightEntry::m_coords

private

Holds the coordinates of the current entry in the original histogram.

Definition at line 78 of file APWeightEntry.h.

◆ m_cumul

double * APWeightEntry::m_cumul

private

Histograms to hold the probability distribution and the cumulative distribution.

Definition at line 76 of file APWeightEntry.h.

◆ m_expectancy_val

double APWeightEntry::m_expectancy_val

private

Holds the Expectancy value of efficiency/weight.

Definition at line 65 of file APWeightEntry.h.

◆ m_hist

TH1F* APWeightEntry::m_hist

private

Holds the TH1F instance from the arrays if computed.

Definition at line 77 of file APWeightEntry.h.

◆ m_ID

unsigned int APWeightEntry::m_ID

private

Holds internal ID (used by APReweight/APReweight2D/APReweight3D/APReweightND).

Definition at line 74 of file APWeightEntry.h.

◆ m_integral

double APWeightEntry::m_integral

private

Holds the integral of the probability distribution.

Definition at line 75 of file APWeightEntry.h.

◆ m_is_nan

bool APWeightEntry::m_is_nan

private

Flag, set to true if denominator is zero.

Definition at line 73 of file APWeightEntry.h.

◆ m_is_trig

bool APWeightEntry::m_is_trig

private

Flag, set to true if weight entry is trigger based.

Definition at line 72 of file APWeightEntry.h.

◆ m_n_dim_origin

std::vector< int > APWeightEntry::m_n_dim_origin

private

Holds the amount of dimensions and bins per axis in the original histogram.

Definition at line 79 of file APWeightEntry.h.

◆ m_pdf

double* APWeightEntry::m_pdf

private

Definition at line 76 of file APWeightEntry.h.

◆ m_stat_uncert_high

double APWeightEntry::m_stat_uncert_high

private

Holds upper bound of asymmetric statistical uncertainty.

Definition at line 68 of file APWeightEntry.h.

◆ m_stat_uncert_low

double APWeightEntry::m_stat_uncert_low

private

Holds lower bound of asymmetric statistical uncertainty.

Definition at line 67 of file APWeightEntry.h.

◆ m_sys_uncert

double APWeightEntry::m_sys_uncert

private

Holds absolute systematic uncertainty value of efficiency/weight.

Definition at line 69 of file APWeightEntry.h.

◆ m_sys_uncert2

double APWeightEntry::m_sys_uncert2

private

Holds absolute systematic uncertainty squared value of efficiency/weight.

Definition at line 70 of file APWeightEntry.h.

◆ m_val_denominator

unsigned int APWeightEntry::m_val_denominator

private

Holds the value of original denominator.

Definition at line 63 of file APWeightEntry.h.

◆ m_val_numerator

unsigned int APWeightEntry::m_val_numerator

private

Holds the value of original numerator.

Definition at line 64 of file APWeightEntry.h.

◆ m_variance

double APWeightEntry::m_variance

private

Holds Variance of efficiency/weight (classical binomial/poisson model).

Definition at line 66 of file APWeightEntry.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ APWeightEntry() [1/3]

◆ APWeightEntry() [2/3]

◆ ~APWeightEntry()

◆ APWeightEntry() [3/3]

Member Function Documentation

◆ _ComputeCum()

◆ _CreateHist()

◆ GetCoords()

◆ GetExpectancy()

◆ GetID()

◆ GetOriginalDimensions()

◆ GetPDF()

◆ GetRandom()

◆ GetStatUncertHigh()

◆ GetStatUncertLow()

◆ GetSysUncert()

◆ GetSysUncert2()

◆ GetValDenominator()

◆ GetValNumerator()

◆ GetVariance()

◆ IsNaN()

◆ IsTrig()

◆ operator=()

◆ ReadEfficiency()

◆ SetCoordinates()

◆ SetID()

◆ SetSystUncert()

Member Data Documentation

◆ m_bins

◆ m_coords

◆ m_cumul

◆ m_expectancy_val

◆ m_hist

◆ m_ID

◆ m_integral

◆ m_is_nan

◆ m_is_trig

◆ m_n_dim_origin

◆ m_pdf

◆ m_stat_uncert_high

◆ m_stat_uncert_low

◆ m_sys_uncert

◆ m_sys_uncert2

◆ m_val_denominator

◆ m_val_numerator

◆ m_variance