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

#include <APReweight3D.h>

Inheritance diagram for APReweight3D:

Collaboration diagram for APReweight3D:

Public Member Functions
	APReweight3D ()
	Default constructor.
	APReweight3D (TH3 denominator_in, TH3 numerator_in, bool isTrig=false)
	Constructor for histograms (numerator/denominator) to read in.
virtual	~APReweight3D ()
	Default destructor.
void	ReadEfficiency (TH3 efficiency_in, TH3 err_low_in, TH3 *err_high_in=0)
	Read efficiencies and upper/lower uncertainty (if numerator/denominator not applicable (e.g.
APWeightEntry *	GetBinWeight (unsigned int bin_x, unsigned int bin_y, unsigned int bin_z) const
	Get Weight entry for a given triplet of bin numbers.
APWeightEntry *	GetWeight (double value_x, double value_y, double value_z) const
	Get Weight entry for a given triplet of values.
double	GetSampleScale () const
	Get scale factor that was calculated from sample sizes upon instantiation.
unsigned int	NBins () const
	Get amount of bins.
unsigned int	GetBinX (double value_x) const
	Get bin number in X that corresponds to a given value.
unsigned int	GetBinY (double value_y) const
	Get bin number in Y that corresponds to a given value.
unsigned int	GetBinZ (double value_z) const
	Get bin number in Z that corresponds to a given value.
const TH3D *	GetDenominatorHist () const
	Get original denominator histogram.
const TH3D *	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(APReweight3D, 1) private TH3D *	m_numerator_hist
	< Holds the original denominator histogram.
std::vector< std::vector< std::vector< APWeightEntry * > > >	m_weights
	Holds all weight entries.
unsigned int	m_n_bins_x
	Holds the amount of bins in X.
unsigned int	m_n_bins_y
	Holds the amount of bins in Y.
unsigned int	m_n_bins_z
	Holds the amount of bins in Z.
TAxis *	m_axis_x
	Holds the X axis of the APReweight3D instance (from input histograms).
TAxis *	m_axis_y
	Holds the Y axis of the APReweight3D instance (from input histograms).
TAxis *	m_axis_z
	Holds the Z axis of the APReweight3D 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 3D parameterized weight maps.

Stores a 3D 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 29 of file APReweight3D.h.

Constructor & Destructor Documentation

◆ APReweight3D() [1/2]

APReweight3D::APReweight3D ( )

Default constructor.

Definition at line 15 of file APReweight3D.cxx.

                           :
  APReweightBase(),
  m_denominator_hist(0),
  m_numerator_hist(0),
  m_n_bins_x(0),
  m_n_bins_y(0),
  m_n_bins_z(0),
  m_axis_x(0),
  m_axis_y(0),
  m_axis_z(0)
{
  m_isQuiet = false;
}

◆ APReweight3D() [2/2]

APReweight3D::APReweight3D	(	TH3 *	denominator_in,
		TH3 *	numerator_in,
		bool	isTrig = false )

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

Definition at line 29 of file APReweight3D.cxx.

                                                                              : APReweightBase() {
  m_empty_weight = new APWeightEntry(0, 0, 1.);
  m_denominator_hist = (TH3D*) denominator_in->Clone("");
  m_numerator_hist = (TH3D*) numerator_in->Clone("");
  m_axis_x = (TAxis*) m_denominator_hist->GetXaxis()->Clone("");
  m_axis_y = (TAxis*) m_denominator_hist->GetYaxis()->Clone("");
  m_axis_z = (TAxis*) m_denominator_hist->GetZaxis()->Clone("");
  m_n_bins_x = m_denominator_hist->GetNbinsX();
  m_n_bins_y = m_denominator_hist->GetNbinsY();
  m_n_bins_z = m_denominator_hist->GetNbinsZ();
  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_x; ++i) {
    m_weights.push_back(vector< vector<APWeightEntry*> >());
    for (unsigned int j = 0; j < m_n_bins_y; ++j) {
      m_weights[i].push_back(vector<APWeightEntry*>());
      for (unsigned int k = 0; k < m_n_bins_z; ++k) {
        APWeightEntry* temp_entry = new APWeightEntry((unsigned int) m_denominator_hist->GetBinContent(i + 1, j + 1, k + 1), (unsigned int) m_numerator_hist->GetBinContent(i + 1, j + 1, k + 1), m_scale, m_isTrig);
        vector<int> temp_vec(3,0);
        vector<int> temp_vec_axes(3,0);
        temp_vec[0] = i+1;
        temp_vec[1] = j+1;
        temp_vec[2] = k+1;
        temp_vec_axes[0] = m_n_bins_x;
        temp_vec_axes[1] = m_n_bins_y;
        temp_vec_axes[2] = m_n_bins_z;
        temp_entry->SetCoordinates(temp_vec,temp_vec_axes);
        temp_entry->SetID(m_ID);
        m_weights[i][j].push_back(temp_entry);
      }
    }
  }
 
  if( m_isTrig ) {
    for( int i = 1; i < m_numerator_hist->GetNbinsX()*m_numerator_hist->GetNbinsY()*m_numerator_hist->GetNbinsZ(); ++i ) {
      if( m_numerator_hist->GetBinContent(i) > m_denominator_hist->GetBinContent(i) ) {
        std::cout << "WARNING in APReweight3D::~APReweight3D(TH3* denominator_in, TH3* 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);
      }
    }
  }
 
 
}

◆ ~APReweight3D()

APReweight3D::~APReweight3D ( )

virtual

Default destructor.

Definition at line 111 of file APReweight3D.cxx.

                            {
  delete m_denominator_hist;
  delete m_numerator_hist;
  delete m_empty_weight;
  delete m_axis_x;
  delete m_axis_y;
  delete m_axis_z;
  for (unsigned int i = 0; i < m_n_bins_x; ++i) {
    for (unsigned int j = 0; j < m_n_bins_y; ++j) {
      for (vector<APWeightEntry*>::reverse_iterator it = m_weights[i][j].rbegin(); it != m_weights[i][j].rend(); ++it) {
        delete *it;
      }
    }
  }
  m_weights.clear();
}

Member Function Documentation

◆ GetBinWeight()

APWeightEntry * APReweight3D::GetBinWeight	(	unsigned int	bin_x,
		unsigned int	bin_y,
		unsigned int	bin_z ) const

Get Weight entry for a given triplet of bin numbers.

Definition at line 128 of file APReweight3D.cxx.

                                                                                                          {
  if (bin_x == 0 || bin_y == 0 || bin_z == 0) return m_empty_weight;
  return m_weights[bin_x - 1][bin_y - 1][bin_z - 1];
}

◆ GetBinX()

unsigned int APReweight3D::GetBinX ( double value_x ) const

Get bin number in X that corresponds to a given value.

Definition at line 153 of file APReweight3D.cxx.

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

◆ GetBinY()

unsigned int APReweight3D::GetBinY ( double value_y ) const

Get bin number in Y that corresponds to a given value.

Definition at line 163 of file APReweight3D.cxx.

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

◆ GetBinZ()

unsigned int APReweight3D::GetBinZ ( double value_z ) const

Get bin number in Z that corresponds to a given value.

Definition at line 173 of file APReweight3D.cxx.

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

◆ GetDenominatorHist()

const TH3D * APReweight3D::GetDenominatorHist ( ) const

Get original denominator histogram.

Definition at line 137 of file APReweight3D.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 TH3D * APReweight3D::GetNumeratorHist ( ) const

Get original numerator histogram.

Definition at line 141 of file APReweight3D.cxx.

                                                 {
  return m_numerator_hist;
}

◆ GetSampleScale()

double APReweight3D::GetSampleScale ( ) const

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

Definition at line 145 of file APReweight3D.cxx.

                                          {
  return m_scale;
}

◆ GetWeight()

APWeightEntry * APReweight3D::GetWeight	(	double	value_x,
		double	value_y,
		double	value_z ) const

Get Weight entry for a given triplet of values.

Definition at line 133 of file APReweight3D.cxx.

                                                                                           {
  return GetBinWeight(GetBinX(value_x), GetBinY(value_y), GetBinZ(value_z));
}

◆ NBins()

unsigned int APReweight3D::NBins ( ) const

Get amount of bins.

Definition at line 149 of file APReweight3D.cxx.

                                       {
  return m_n_bins_x * m_n_bins_y*m_n_bins_z;
}

◆ ReadEfficiency()

void APReweight3D::ReadEfficiency	(	TH3 *	efficiency_in,
		TH3 *	err_low_in,
		TH3 *	err_high_in = 0 )

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

Bootstrap)).

Definition at line 75 of file APReweight3D.cxx.

                                                                                       {
  if (err_high_in == 0) err_high_in = err_low_in;
  m_empty_weight = new APWeightEntry(0, 0, 1.);
  m_denominator_hist = new TH3D("", "", 1, 0., 1., 1, 0., 1., 1, 0., 1.);
  m_numerator_hist = new TH3D("", "", 1, 0., 1., 1, 0., 1., 1, 0., 1.);
  m_axis_x = (TAxis*) efficiency_in->GetXaxis()->Clone("");
  m_axis_y = (TAxis*) efficiency_in->GetYaxis()->Clone("");
  m_axis_z = (TAxis*) efficiency_in->GetZaxis()->Clone("");
  m_n_bins_x = efficiency_in->GetNbinsX();
  m_n_bins_y = efficiency_in->GetNbinsY();
  m_n_bins_z = efficiency_in->GetNbinsZ();
  m_scale = 1.0;
  m_isTrig = true;
  for (unsigned int i = 0; i < m_n_bins_x; ++i) {
    m_weights.push_back(vector< vector<APWeightEntry*> >());
    for (unsigned int j = 0; j < m_n_bins_y; ++j) {
      m_weights[i].push_back(vector<APWeightEntry*>());
      for (unsigned int k = 0; k < m_n_bins_z; ++k) {
        APWeightEntry *temp_entry = new APWeightEntry();
        temp_entry->ReadEfficiency(efficiency_in->GetBinContent(i + 1, j + 1, k + 1), err_low_in->GetBinContent(i + 1, j + 1, k + 1), err_high_in->GetBinContent(i + 1, j + 1, k + 1));
        vector<int> temp_vec(3,0);
        vector<int> temp_vec_axes(3,0);
        temp_vec[0] = i+1;
        temp_vec[1] = j+1;
        temp_vec[2] = k+1;
        temp_vec_axes[0] = m_n_bins_x;
        temp_vec_axes[1] = m_n_bins_y;
        temp_vec_axes[2] = m_n_bins_z;
        temp_entry->SetCoordinates(temp_vec,temp_vec_axes);
        temp_entry->SetID(m_ID);
        m_weights[i][j].push_back(temp_entry);
      }
    }
  }
}

◆ SetQuietMode()

void APReweight3D::SetQuietMode ( bool isQuiet = true )

Sets the flag to turn off messages.

Definition at line 193 of file APReweight3D.cxx.

                                            {
  m_isQuiet = isQuiet;
}

◆ SetSystUncert()

void APReweight3D::SetSystUncert ( double rel_uncert )

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

Definition at line 183 of file APReweight3D.cxx.

                                                  {
  for (unsigned int i = 0; i < m_n_bins_x; ++i) {
    for (unsigned int j = 0; j < m_n_bins_y; ++j) {
      for (unsigned int k = 0; k < m_n_bins_z; ++k) {
        GetBinWeight(i, j, k)->SetSystUncert(rel_uncert);
      }
    }
  }
}

Member Data Documentation

◆ m_axis_x

TAxis* APReweight3D::m_axis_x

Holds the X axis of the APReweight3D instance (from input histograms).

Definition at line 62 of file APReweight3D.h.

◆ m_axis_y

TAxis* APReweight3D::m_axis_y

Holds the Y axis of the APReweight3D instance (from input histograms).

Definition at line 63 of file APReweight3D.h.

◆ m_axis_z

TAxis* APReweight3D::m_axis_z

Holds the Z axis of the APReweight3D instance (from input histograms).

Definition at line 64 of file APReweight3D.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_x

unsigned int APReweight3D::m_n_bins_x

Holds the amount of bins in X.

Definition at line 59 of file APReweight3D.h.

◆ m_n_bins_y

unsigned int APReweight3D::m_n_bins_y

Holds the amount of bins in Y.

Definition at line 60 of file APReweight3D.h.

◆ m_n_bins_z

unsigned int APReweight3D::m_n_bins_z

Holds the amount of bins in Z.

Definition at line 61 of file APReweight3D.h.

◆ m_numerator_hist

ClassDef (APReweight3D,1) private TH3D* APReweight3D::m_numerator_hist

< Holds the original denominator histogram.

Holds the original numerator histogram.

Definition at line 57 of file APReweight3D.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< std::vector< std::vector< APWeightEntry* > > > APReweight3D::m_weights

Holds all weight entries.

Definition at line 58 of file APReweight3D.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

◆ APReweight3D() [1/2]

◆ APReweight3D() [2/2]

◆ ~APReweight3D()

Member Function Documentation

◆ GetBinWeight()

◆ GetBinX()

◆ GetBinY()

◆ GetBinZ()

◆ GetDenominatorHist()

◆ GetID()

◆ GetNumeratorHist()

◆ GetSampleScale()

◆ GetWeight()

◆ NBins()

◆ ReadEfficiency()

◆ SetQuietMode()

◆ SetSystUncert()

Member Data Documentation

◆ m_axis_x

◆ m_axis_y

◆ m_axis_z

◆ m_empty_weight

◆ m_isQuiet

◆ m_isTrig

◆ m_n_bins_x

◆ m_n_bins_y

◆ m_n_bins_z

◆ m_numerator_hist

◆ m_scale

◆ m_syst_uncert_global

◆ m_weights

◆ s_NID