Class to store 1D parameterized weight maps. More...

#include <APReweight.h>

Inheritance diagram for APReweight:

Collaboration diagram for APReweight:

Public Member Functions
	APReweight ()
	Default constructor.
	APReweight (TTree denominator, const std::string &denominator_branch, TTree numerator, const std::string &numerator_branch, unsigned int n_bins, double x_min, double x_max, bool isTrig=false)
	Constructor for whole branches (numerator/denominator) to read in.
	APReweight (std::vector< double > denominator, std::vector< double > numerator, unsigned int n_bins, double x_min, double x_max, bool isTrig=false)
	Constructor for vectors (numerator/denominator) to read in.
	APReweight (TH1 denominator_in, TH1 numerator_in, bool isTrig=false)
	Constructor for histograms (numerator/denominator) to read in.
virtual	~APReweight ()
	Default destructor.
void	ReadEfficiency (TH1 efficiency_in, TH1 err_low_in, TH1 *err_high_in=0)
	Read efficiencies and upper/lower uncertainty (if numerator/denominator not applicable (e.g.
APWeightEntry *	GetBinWeight (unsigned int bin) const
	Get Weight entry for a given bin number.
APWeightEntry *	GetWeight (double value) const
	Get Weight entry for a given value.
double	GetSampleScale () const
	Get scale factor that was calculated from sample sizes upon instantiation.
unsigned int	NBins () const
	Get amount of bins.
unsigned int	GetBin (double value) const
	Get bin number that corresponds to a given value.
const TH1D *	GetDenominatorHist () const
	Get original denominator histogram.
const TH1D *	GetNumeratorHist () const
	Get original numerator histogram.
void	SetSystUncert (double rel_uncert)
	Set the global relative (!) systematic uncertainty of all efficiencies/weights.
void	SetQuietMode (bool isQuiet=true)
	Sets the flag to turn off messages.
unsigned int	GetID () const
	Returns the unique ID for assignment of APWeightEntries to source.

Public Attributes
ClassDef(APReweight, 1) private TH1D *	m_numerator_hist
	< Holds the original denominator histogram.
std::vector< APWeightEntry * >	m_weights
	Holds all weight entries.
unsigned int	m_n_bins
	Holds the amount of bins.
TAxis *	m_axis
	Holds the axis of the APReweight instance (from input histograms).
double	m_scale
	Holds the scale factor that was calculated from sample sizes upon instantiation.
bool	m_isTrig
	Flag to determine if the class holds trigger efficiencies or "simple" MC weights.
bool	m_isQuiet
	Flag to turn off messages.
double	m_syst_uncert_global
	Holds the global relative (!) systematic uncertainty of all efficiencies/weights.
APWeightEntry *	m_empty_weight
	Dummy weight (equals 0.) to return if value out of range is provided.

Static Public Attributes
static ClassDef(APReweightBase, 1) protected std::atomic< unsigned int >	s_NID = 0
	< Holds the unique ID for assignment of APWeightEntries to source.

Detailed Description

Class to store 1D parameterized weight maps.

Stores a 1D parameterization of APWeightEntries from numerator and denominator histograms or from an efficiency histogram and uncertainties.

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

Definition at line 30 of file APReweight.h.

Constructor & Destructor Documentation

◆ APReweight() [1/4]

APReweight::APReweight ( )

Default constructor.

Definition at line 15 of file APReweight.cxx.

                       :
  APReweightBase(),
  m_denominator_hist(0),
  m_numerator_hist(0),
  m_n_bins(0),
  m_axis(0)
{
  m_isQuiet = false;
}

◆ APReweight() [2/4]

APReweight::APReweight	(	TTree *	denominator,
		const std::string &	denominator_branch,
		TTree *	numerator,
		const std::string &	numerator_branch,
		unsigned int	n_bins,
		double	x_min,
		double	x_max,
		bool	isTrig = false )

Constructor for whole branches (numerator/denominator) to read in.

Definition at line 25 of file APReweight.cxx.

                                                                                                                                                                                                 : APReweightBase() {
  m_empty_weight = new APWeightEntry(0, 0, 1.);
  m_denominator_hist = new TH1D("", "denominator_hist", n_bins, x_min, x_max);
  m_numerator_hist = new TH1D("", "numerator_hist", n_bins, x_min, x_max);
  m_axis = (TAxis*) m_denominator_hist->GetXaxis()->Clone("");
  m_n_bins = m_denominator_hist->GetNbinsX();
 
  //Readout from Trees and fill histograms
  vector<double> *denominator_vec = 0, *numerator_vec = 0;
  TBranch *b_denominator_vec, *b_numerator_vec;
  denominator->SetBranchAddress(denominator_branch.c_str(), &denominator_vec, &b_denominator_vec);
  numerator->SetBranchAddress(numerator_branch.c_str(), &numerator_vec, &b_numerator_vec);
  unsigned long nentries_denominator = denominator->GetEntries(), nentries_numerator = numerator->GetEntries(), counter = 0;
  while (counter < nentries_denominator) {
    denominator->GetEntry(counter);
    for (unsigned int i = 0, I = denominator_vec->size(); i < I; ++i) m_denominator_hist->Fill((*denominator_vec)[i]);
    ++counter;
  }
  counter = 0;
  while (counter < nentries_numerator) {
    numerator->GetEntry(counter);
    for (unsigned int i = 0, I = numerator_vec->size(); i < I; ++i) m_numerator_hist->Fill((*numerator_vec)[i]);
    ++counter;
  }
 
  //Cleanup
  denominator->ResetBranchAddress(b_denominator_vec);
  numerator->ResetBranchAddress(b_numerator_vec);
  delete b_denominator_vec;
  delete b_numerator_vec;
  denominator_vec->clear();
  delete denominator_vec;
  numerator_vec->clear();
  delete numerator_vec;
 
  m_scale = (double) nentries_denominator / (double) nentries_numerator;
  m_isTrig = isTrig;
  m_isQuiet = false;
  for (unsigned int i = 0; i < m_n_bins; ++i) {
    APWeightEntry* temp_entry = new APWeightEntry((unsigned int) m_denominator_hist->GetBinContent(i + 1), (unsigned int) m_numerator_hist->GetBinContent(i + 1), m_scale, m_isTrig);
    temp_entry->SetCoordinates(vector<int>(1,i+1),vector<int>(1,m_n_bins));
    temp_entry->SetID(m_ID);
    m_weights.push_back(temp_entry);
  }
}

◆ APReweight() [3/4]

APReweight::APReweight	(	std::vector< double >	denominator,
		std::vector< double >	numerator,
		unsigned int	n_bins,
		double	x_min,
		double	x_max,
		bool	isTrig = false )

Constructor for vectors (numerator/denominator) to read in.

Definition at line 71 of file APReweight.cxx.

                                                                                                                                         : APReweightBase() {
  m_empty_weight = new APWeightEntry(0, 0, 1.);
  m_denominator_hist = new TH1D("", "denominator_hist", n_bins, x_min, x_max);
  m_numerator_hist = new TH1D("", "numerator_hist", n_bins, x_min, x_max);
  m_axis = (TAxis*) m_denominator_hist->GetXaxis()->Clone("");
  m_n_bins = m_denominator_hist->GetNbinsX();
 
  //Readout from vectors and fill histograms
  for (unsigned long i = 0, I = denominator.size(); i < I; ++i) m_denominator_hist->Fill(denominator[i]);
  for (unsigned long i = 0, I = numerator.size(); i < I; ++i) m_numerator_hist->Fill(numerator[i]);
 
  m_scale = (double) denominator.size() / (double) numerator.size();
  m_isTrig = isTrig;
  m_isQuiet = false;
  for (unsigned int i = 0; i < m_n_bins; ++i) {
    APWeightEntry* temp_entry = new APWeightEntry((unsigned int) m_denominator_hist->GetBinContent(i + 1), (unsigned int) m_numerator_hist->GetBinContent(i + 1), m_scale, m_isTrig);
    temp_entry->SetCoordinates(vector<int>(1,i+1),vector<int>(1,m_n_bins));
    temp_entry->SetID(m_ID);
    m_weights.push_back(temp_entry);
  }
}

◆ APReweight() [4/4]

APReweight::APReweight	(	TH1 *	denominator_in,
		TH1 *	numerator_in,
		bool	isTrig = false )

Constructor for histograms (numerator/denominator) to read in.

Definition at line 93 of file APReweight.cxx.

                                                                          : APReweightBase() {
  m_empty_weight = new APWeightEntry(0, 0, 1.);
  m_denominator_hist = (TH1D*) denominator_in->Clone("");
  m_numerator_hist = (TH1D*) numerator_in->Clone("");
  m_axis = (TAxis*) m_denominator_hist->GetXaxis()->Clone("");
  m_n_bins = m_denominator_hist->GetNbinsX();
  m_scale = (double) denominator_in->GetEntries() / (double) numerator_in->GetEntries();
  m_isTrig = isTrig;
  m_isQuiet = false;
  for (unsigned int i = 0; i < m_n_bins; ++i) {
    APWeightEntry* temp_entry = new APWeightEntry((unsigned int) m_denominator_hist->GetBinContent(i + 1), (unsigned int) m_numerator_hist->GetBinContent(i + 1), m_scale, m_isTrig);
    temp_entry->SetCoordinates(vector<int>(1,i+1),vector<int>(1,m_n_bins));
    temp_entry->SetID(m_ID);
    m_weights.push_back(temp_entry);
  }
  
  if( m_isTrig ) {
    for( int i = 1; i < m_numerator_hist->GetNbinsX(); ++i ) {
      if( m_numerator_hist->GetBinContent(i) > m_denominator_hist->GetBinContent(i) ) {
        std::cout << "WARNING in APReweight::~APReweight(TH1* denominator_in, TH1* numerator_in, bool isTrig) : Using histograms " << m_numerator_hist->GetName() << " and " << m_denominator_hist->GetName() << " the efficiency is larger than 1 for bin " << i << "! This is inconsistent and can lead to unwanted behaviour (weights > 1, variance < 0 )! Please check your input histograms. In order to avoid negative variances, the efficiency in this bin will be set to 0. " << std::endl;
        m_numerator_hist->SetBinContent(i,0);
      }
    }
  }
 
}

◆ ~APReweight()

APReweight::~APReweight ( )

virtual

Default destructor.

Definition at line 138 of file APReweight.cxx.

                        {
  delete m_denominator_hist;
  delete m_numerator_hist;
  delete m_empty_weight;
  delete m_axis;
  for (vector<APWeightEntry*>::reverse_iterator it = m_weights.rbegin(); it != m_weights.rend(); ++it) {
    delete *it;
  }
  m_weights.clear();
}

Member Function Documentation

◆ GetBin()

unsigned int APReweight::GetBin ( double value ) const

Get bin number that corresponds to a given value.

Definition at line 174 of file APReweight.cxx.

                                                  {
  for (unsigned int i = 1; i <= m_n_bins; ++i) {
    if (value >= m_axis->GetBinLowEdge(i) && value <= m_axis->GetBinUpEdge(i)) {
      return i;
    }
  }
  if (!m_isQuiet) cout << "WARNING in APReweight::GetBin: Value out of range! Returning 0." << endl;
  return 0;
}

◆ GetBinWeight()

APWeightEntry * APReweight::GetBinWeight ( unsigned int bin ) const

Get Weight entry for a given bin number.

Definition at line 149 of file APReweight.cxx.

                                                              {
  if (bin == 0) return m_empty_weight;
  return m_weights[bin - 1];
}

◆ GetDenominatorHist()

const TH1D * APReweight::GetDenominatorHist ( ) const

Get original denominator histogram.

Definition at line 158 of file APReweight.cxx.

                                                 {
  return m_denominator_hist;
}

◆ GetID()

unsigned int APReweightBase::GetID ( ) const

inherited

Returns the unique ID for assignment of APWeightEntries to source.

Definition at line 23 of file APReweightBase.cxx.

                                         {
  return m_ID;
}

◆ GetNumeratorHist()

const TH1D * APReweight::GetNumeratorHist ( ) const

Get original numerator histogram.

Definition at line 162 of file APReweight.cxx.

                                               {
  return m_numerator_hist;
}

◆ GetSampleScale()

double APReweight::GetSampleScale ( ) const

Get scale factor that was calculated from sample sizes upon instantiation.

Definition at line 166 of file APReweight.cxx.

                                        {
  return m_scale;
}

◆ GetWeight()

APWeightEntry * APReweight::GetWeight ( double value ) const

Get Weight entry for a given value.

Definition at line 154 of file APReweight.cxx.

                                                       {
  return GetBinWeight(GetBin(value));
}

◆ NBins()

unsigned int APReweight::NBins ( ) const

Get amount of bins.

Definition at line 170 of file APReweight.cxx.

                                     {
  return m_n_bins;
}

◆ ReadEfficiency()

void APReweight::ReadEfficiency	(	TH1 *	efficiency_in,
		TH1 *	err_low_in,
		TH1 *	err_high_in = 0 )

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

Bootstrap)).

Definition at line 120 of file APReweight.cxx.

                                                                                     {
  if (err_high_in == 0) err_high_in = err_low_in;
  m_empty_weight = new APWeightEntry(0, 0, 1.);
  m_denominator_hist = new TH1D("", "", 1, 0., 1.);
  m_numerator_hist = new TH1D("", "", 1, 0., 1.);
  m_axis = (TAxis*) efficiency_in->GetXaxis()->Clone("");
  m_n_bins = efficiency_in->GetNbinsX();
  m_scale = 1.0;
  m_isTrig = true;
  for (unsigned int i = 0; i < m_n_bins; ++i) {
    APWeightEntry *temp_entry = new APWeightEntry();
    temp_entry->ReadEfficiency(efficiency_in->GetBinContent(i + 1), err_low_in->GetBinContent(i + 1), err_high_in->GetBinContent(i + 1));
    temp_entry->SetCoordinates(vector<int>(1,i+1),vector<int>(1,m_n_bins));
    temp_entry->SetID(m_ID);
    m_weights.push_back(temp_entry);
  }
}

◆ SetQuietMode()

void APReweight::SetQuietMode ( bool isQuiet = true )

Sets the flag to turn off messages.

Definition at line 190 of file APReweight.cxx.

                                          {
  m_isQuiet = isQuiet;
}

◆ SetSystUncert()

void APReweight::SetSystUncert ( double rel_uncert )

Set the global relative (!) systematic uncertainty of all efficiencies/weights.

Definition at line 184 of file APReweight.cxx.

                                                {
  for (unsigned int i = 1; i <= m_n_bins; ++i) {
    GetBinWeight(i)->SetSystUncert(rel_uncert);
  }
}

Member Data Documentation

◆ m_axis

TAxis* APReweight::m_axis

Holds the axis of the APReweight instance (from input histograms).

Definition at line 61 of file APReweight.h.

◆ m_empty_weight

APWeightEntry* APReweightBase::m_empty_weight

inherited

Dummy weight (equals 0.) to return if value out of range is provided.

Definition at line 40 of file APReweightBase.h.

◆ m_isQuiet

bool APReweightBase::m_isQuiet

inherited

Flag to turn off messages.

Definition at line 38 of file APReweightBase.h.

◆ m_isTrig

bool APReweightBase::m_isTrig

inherited

Flag to determine if the class holds trigger efficiencies or "simple" MC weights.

Definition at line 37 of file APReweightBase.h.

◆ m_n_bins

unsigned int APReweight::m_n_bins

Holds the amount of bins.

Definition at line 60 of file APReweight.h.

◆ m_numerator_hist

ClassDef (APReweight, 1) private TH1D* APReweight::m_numerator_hist

< Holds the original denominator histogram.

Holds the original numerator histogram.

Definition at line 58 of file APReweight.h.

◆ m_scale

double APReweightBase::m_scale

inherited

Holds the scale factor that was calculated from sample sizes upon instantiation.

Definition at line 36 of file APReweightBase.h.

◆ m_syst_uncert_global

double APReweightBase::m_syst_uncert_global

inherited

Holds the global relative (!) systematic uncertainty of all efficiencies/weights.

Definition at line 39 of file APReweightBase.h.

◆ m_weights

std::vector< APWeightEntry* > APReweight::m_weights

Holds all weight entries.

Definition at line 59 of file APReweight.h.

◆ s_NID

std::atomic< unsigned int > APReweightBase::s_NID = 0

staticinherited

< Holds the unique ID for assignment of APWeightEntries to source.

Holds the overall number of assigned IDs.

Definition at line 35 of file APReweightBase.h.

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

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ APReweight() [1/4]

◆ APReweight() [2/4]

◆ APReweight() [3/4]

◆ APReweight() [4/4]

◆ ~APReweight()

Member Function Documentation

◆ GetBin()

◆ GetBinWeight()

◆ GetDenominatorHist()

◆ GetID()

◆ GetNumeratorHist()

◆ GetSampleScale()

◆ GetWeight()

◆ NBins()

◆ ReadEfficiency()

◆ SetQuietMode()

◆ SetSystUncert()

Member Data Documentation

◆ m_axis

◆ m_empty_weight

◆ m_isQuiet

◆ m_isTrig

◆ m_n_bins

◆ m_numerator_hist

◆ m_scale

◆ m_syst_uncert_global

◆ m_weights

◆ s_NID