APReweightND Class Reference

Class to store n-dimensionally parameterized weight maps. More...

#include <APReweightND.h>

Inheritance diagram for APReweightND:

Collaboration diagram for APReweightND:

Public Member Functions
	APReweightND ()
	Default constructor.
	APReweightND (THnSparse *denominator_in, THnSparse *numerator_in, bool isTrig=false)
	Constructor for histograms (numerator/denominator) to read in.
virtual	~APReweightND ()
	Default destructor.
void	ReadEfficiency (THnSparse *efficiency_in, THnSparse *err_low_in, THnSparse *err_high_in=0)
	Read efficiencies and upper/lower uncertainty (if numerator/denominator not applicable (e.g.
APWeightEntry *	GetBinWeight (const int bin[])
	Get Weight entry for a given n-tuple of bin numbers.
APWeightEntry *	GetWeight (double value[])
	Get Weight entry for a given n-tuple of values.
double	GetSampleScale () const
	Get scale factor that was calculated from sample sizes upon instantiation.
unsigned int	NBins () const
	Get amount of bins.
const THnSparse *	GetDenominatorHist () const
	Get original denominator histogram.
const THnSparse *	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(APReweightND, 1) private THnSparse *	m_denominator_hist
	< Holds the amount of dimensions.
THnSparse *	m_numerator_hist
	Holds the original numerator histogram.
std::map< std::vector< int >, APWeightEntry * >	m_weights
	Holds all weight entries.
std::vector< TAxis * >	m_axes
	Holds all axes of the APReweightND 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 n-dimensionally parameterized weight maps.

Stores a n-dimensional 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 APReweightND.h.

Constructor & Destructor Documentation

APReweightND() [1/2]

APReweightND::APReweightND

(

)

Default constructor.

Definition at line 17 of file APReweightND.cxx.

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

APReweightND() [2/2]

APReweightND::APReweightND	(	THnSparse *	denominator_in,
		THnSparse *	numerator_in,
		bool	isTrig = false )

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

Definition at line 26 of file APReweightND.cxx.

                                                                                          : APReweightBase() {
  m_empty_weight = new APWeightEntry(0,0,1.);
  m_denominator_hist = (THnSparse*)denominator_in->Clone("");
  m_numerator_hist = (THnSparse*)numerator_in->Clone("");
  m_n_dim = m_denominator_hist->GetNdimensions();
  for (unsigned int i = 0; i < m_n_dim; ++i) m_axes.push_back( (TAxis*)m_denominator_hist->GetAxis(i)->Clone("") );
  m_scale = (double)denominator_in->GetEntries() / (double)numerator_in->GetEntries();
  m_isTrig = isTrig;
  m_isQuiet = false;
  m_syst_uncert_global = 0.;
  
  if( m_isTrig ) {
    std::vector<int> coords(m_n_dim);
    for( unsigned int i = 0; i < m_n_dim; ++i ) coords[i] = 1;
    bool checkComplete = false;
    while( 1 ) {
      if( m_numerator_hist->GetBinContent(coords.data()) > m_denominator_hist->GetBinContent(coords.data()) ) {
        std::cout << "WARNING in APReweightND::~APReweightND(THnSparse* denominator_in, THnSparse* numerator_in, bool isTrig) : Using histograms " << m_numerator_hist->GetName() << " and " << m_denominator_hist->GetName() << " the efficiency is larger than 1 for coordinates [ "; for( unsigned int j = 0; j < m_n_dim; ++j ) { std::cout << coords[j] << " "; } std::cout << " ]! This is inconsisten 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(coords.data(), 0);
      }
 
      checkComplete = true;
      for( unsigned int j = 0; j < m_n_dim; ++j ) {
        if( coords[j] != m_numerator_hist->GetAxis(j)->GetNbins() ) checkComplete = false;
      }
      if( checkComplete ) break;
 
      int completeDimension = -1;
      for( unsigned int j = 0; j < m_n_dim; ++j ) {
        if( coords[j] == m_numerator_hist->GetAxis(j)->GetNbins() ) {
          bool isComplete = true;
          for( int k = (int)j-1; k >= 0; --k ) {
            if( coords[k] != m_numerator_hist->GetAxis(k)->GetNbins() ) isComplete = false;
          }
          if( isComplete ) completeDimension = j;
        }
      }
      
      if( completeDimension != -1 ) {
        for( int j = 0; j <= completeDimension; ++j ) coords[j] = 1;
        coords[completeDimension+1] += 1;
      }
      else {
        coords[0] += 1;
      }
      
    }
  }
 
}

~APReweightND()

APReweightND::~APReweightND ( )

virtual

Default destructor.

Definition at line 100 of file APReweightND.cxx.

                            {
  delete m_denominator_hist;
  delete m_numerator_hist;
  delete m_empty_weight;
  for (vector<TAxis*>::reverse_iterator it=m_axes.rbegin(); it != m_axes.rend(); ++it) {
    delete *it;
  }
  for (map< vector<int>, APWeightEntry* >::reverse_iterator it=m_weights.rbegin(); it != m_weights.rend(); ++it) {
    delete it->second;
  }
  m_weights.clear();
  m_axes.clear();
}

Member Function Documentation

GetBinWeight()

APWeightEntry * APReweightND::GetBinWeight

(

const int

bin[]

)

Get Weight entry for a given n-tuple of bin numbers.

Definition at line 114 of file APReweightND.cxx.

                                                         {
  vector<int> temp_vec(&bin[0],&bin[m_n_dim]);
  map< vector<int> , APWeightEntry* >::iterator temp_it = m_weights.find(temp_vec);
  if ( temp_it == m_weights.end() ) {
      APWeightEntry* temp_weight = new APWeightEntry((unsigned int)m_denominator_hist->GetBinContent(m_denominator_hist->GetBin(bin)),(unsigned int)m_numerator_hist->GetBinContent(m_numerator_hist->GetBin(bin)),m_scale, m_isTrig);
      vector<int> temp_vec_axes(m_n_dim,0);
      for (unsigned int i = 0; i < m_n_dim; ++i) temp_vec_axes[i] = m_denominator_hist->GetAxis(i)->GetNbins();
      temp_weight->SetCoordinates(temp_vec,temp_vec_axes);
      temp_weight->SetSystUncert(m_syst_uncert_global);
      temp_weight->SetID(m_ID);
      m_weights[temp_vec] = temp_weight;
      return temp_weight;
  }
  return (*temp_it).second;
}

GetDenominatorHist()

const THnSparse * APReweightND::GetDenominatorHist

(

)

const

Get original denominator histogram.

Definition at line 141 of file APReweightND.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 THnSparse * APReweightND::GetNumeratorHist

(

)

const

Get original numerator histogram.

Definition at line 145 of file APReweightND.cxx.

                                                      {
  return m_numerator_hist;
}

GetSampleScale()

double APReweightND::GetSampleScale

(

)

const

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

Definition at line 149 of file APReweightND.cxx.

                                          {
  return m_scale;
}

GetWeight()

APWeightEntry * APReweightND::GetWeight

(

double

value[]

)

Get Weight entry for a given n-tuple of values.

Definition at line 130 of file APReweightND.cxx.

                                                     {
  vector<int> temp_bin;
  for (unsigned int i = 0; i < m_n_dim; ++i) {
    if ( value[i] < (m_axes[i])->GetXmin() || value[i] > (m_axes[i])->GetXmax() ) {
      if (!m_isQuiet) cout << "WARNING in APReweightND::GetBin: Value out of range! Dim: " << i << ", value: " << value[i] << ", return value: " << (m_axes[i])->FindFixBin(value[i]) << endl;
    }
    temp_bin.push_back((m_axes[i])->FindFixBin(value[i]));
  }
  return GetBinWeight(&temp_bin[0]);
}

NBins()

unsigned int APReweightND::NBins

(

)

const

Get amount of bins.

Definition at line 153 of file APReweightND.cxx.

                                       {
  unsigned int ret = 0;
  for (unsigned int i = 0; i < m_n_dim; ++i) ret += (m_axes[i])->GetNbins();
  return ret;
}

ReadEfficiency()

void APReweightND::ReadEfficiency	(	THnSparse *	efficiency_in,
		THnSparse *	err_low_in,
		THnSparse *	err_high_in = 0 )

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

Bootstrap)).

Definition at line 77 of file APReweightND.cxx.

                                                                                                         {
  if (err_high_in == 0) err_high_in = err_low_in;
  m_empty_weight = new APWeightEntry(0,0,1.);
  m_denominator_hist = new THnSparseD();
  m_numerator_hist = new THnSparseD();
  m_n_dim = efficiency_in->GetNdimensions();
  for (unsigned int i = 0; i < m_n_dim; ++i) m_axes.push_back( (TAxis*)efficiency_in->GetAxis(i)->Clone("") );
  m_scale = 1.0;
  m_isTrig = true;
  m_syst_uncert_global = 0.;
  vector<int> temp_vec_axes(m_n_dim,0);
  for (unsigned int j = 0; j < m_n_dim; ++j) temp_vec_axes[j] = efficiency_in->GetAxis(j)->GetNbins();
  for (int i = 0, I = efficiency_in->GetNbins(); i < I; ++i) {
    std::vector<int> coords (m_n_dim);
    double efficiency = efficiency_in->GetBinContent( i,coords.data() );
    APWeightEntry *temp_entry = new APWeightEntry();
    temp_entry->ReadEfficiency(efficiency,err_low_in->GetBinContent(err_low_in->GetBin(coords.data())),err_high_in->GetBinContent(err_high_in->GetBin(coords.data())));
    temp_entry->SetCoordinates(coords,temp_vec_axes);
    temp_entry->SetID(m_ID);
    m_weights[coords] = temp_entry;
  }
}

SetQuietMode()

void APReweightND::SetQuietMode

(

bool

isQuiet = true

)

Sets the flag to turn off messages.

Definition at line 166 of file APReweightND.cxx.

                                            {
  m_isQuiet = isQuiet;
}

SetSystUncert()

void APReweightND::SetSystUncert

(

double

rel_uncert

)

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

Definition at line 159 of file APReweightND.cxx.

                                                  {
  m_syst_uncert_global = rel_uncert;
  for ( map< vector<int> , APWeightEntry* >::const_iterator temp_it = m_weights.begin(); temp_it != m_weights.end(); ++temp_it ) {
    ((*temp_it).second)->SetSystUncert(rel_uncert);
  }
}

Member Data Documentation

m_axes

std::vector< TAxis* > APReweightND::m_axes

Holds all axes of the APReweightND instance (from input histograms).

Definition at line 57 of file APReweightND.h.

m_denominator_hist

ClassDef (APReweightND, 1) private THnSparse* APReweightND::m_denominator_hist

< Holds the amount of dimensions.

Holds the original denominator histogram.

Definition at line 54 of file APReweightND.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_numerator_hist

THnSparse* APReweightND::m_numerator_hist

Holds the original numerator histogram.

Definition at line 55 of file APReweightND.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::map< std::vector<int> , APWeightEntry* > APReweightND::m_weights

Holds all weight entries.

Definition at line 56 of file APReweightND.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:

• APReweightND.h
• APReweightND.cxx