Analysis::CalibrationDataInterfaceBase Class Reference

This class provides some common functionality for other classes wishing to access Flavour Tagging performance estimates. More...

#include <CalibrationDataInterfaceBase.h>

Inheritance diagram for Analysis::CalibrationDataInterfaceBase:

Collaboration diagram for Analysis::CalibrationDataInterfaceBase:

Public Types
enum	variableType { kEta , kAbsEta , kPt }
	known variable types that can be used as function arguments More...

Public Member Functions
	CalibrationDataInterfaceBase ()
virtual	~CalibrationDataInterfaceBase ()=0
	default destructor
const std::string &	EffCalibrationName (const std::string &flavour, unsigned int mapIndex=0) const
	Main interface methods accessing the flavour tagging performance information.
void	setEffCalibrationNames (const std::map< std::string, std::vector< std::string > > &names)
const std::string &	SFCalibrationName (const std::string &flavour) const
void	setSFCalibrationNames (const std::map< std::string, std::string > &names)

Protected Member Functions
std::string	getContainername (const std::string &flavour, bool SF, unsigned int mapIndex=0) const
	auxiliary function for string concatenation
std::string	getBasename (const std::string &name) const
	auxiliary function for retrieval of name within the directory
double	combinedUncertainty (double stat, const std::pair< double, double > &syst) const
	utility function for combination of statistical and (a priori asymmetric) systematic uncertainty.

Protected Attributes
std::string	m_taggerName
	tagging algorithm name

Private Attributes
std::map< std::string, std::vector< std::string > >	m_calibrationEffNames
	this simply collects the per-flavour properties.
std::map< std::string, std::string >	m_calibrationSFNames

Detailed Description

This class provides some common functionality for other classes wishing to access Flavour Tagging performance estimates.

Author

Frank Filthaut F.Fil.nosp@m.thau.nosp@m.t@sci.nosp@m.ence.nosp@m..ru.n.nosp@m.l

Definition at line 47 of file CalibrationDataInterfaceBase.h.

Member Enumeration Documentation

variableType

enum Analysis::CalibrationDataInterfaceBase::variableType

known variable types that can be used as function arguments

Enumerator
kEta
kAbsEta
kPt

Definition at line 67 of file CalibrationDataInterfaceBase.h.

{ kEta, kAbsEta, kPt };

Constructor & Destructor Documentation

CalibrationDataInterfaceBase()

Analysis::CalibrationDataInterfaceBase::CalibrationDataInterfaceBase

(

)

~CalibrationDataInterfaceBase()

Analysis::CalibrationDataInterfaceBase::~CalibrationDataInterfaceBase ( )

pure virtual

default destructor

Definition at line 41 of file CalibrationDataInterfaceBase.cxx.

{}

Member Function Documentation

combinedUncertainty()

double Analysis::CalibrationDataInterfaceBase::combinedUncertainty ( double stat, const std::pair< double, double > & syst ) const

protected

utility function for combination of statistical and (a priori asymmetric) systematic uncertainty.

NB perhaps this should be in its own

Definition at line 147 of file CalibrationDataInterfaceBase.cxx.

{
  // Return the total (combined statistical and systematic) uncertainty started from
  // its individual components. The result is symmetrised by using only the larger of
  // the (a priori asymmetric) up- and downward systematic uncertainties.
 
  // The systematic uncertainty is (a priori) asymmetric, but this interface doesn't
  // at present allow for asymmetric uncertainties.
  // Address this by taking the larger (absolute) value of the two.
  double largest = syst.first;
  if (TMath::Abs(syst.second) > TMath::Abs(largest)) largest = syst.second;
 
  return TMath::Sqrt(stat*stat + largest*largest);
}

EffCalibrationName()

const std::string & Analysis::CalibrationDataInterfaceBase::EffCalibrationName	(	const std::string &	flavour,
		unsigned int	mapIndex = 0 ) const

Main interface methods accessing the flavour tagging performance information.

Note that for both of the following, the label is assumed to adhere to the TruthInfo conventions (see package PhysicsAnalysis/JetTagging/JetTagInfo).

Definition at line 47 of file CalibrationDataInterfaceBase.cxx.

{
  // Return the MC efficiency name for the given flavour.
  // Note that no check is performed on the validity of the flavour.
  
  try {
    return m_calibrationEffNames.at(flavour)[mapIndex];
  }
  catch (const std::out_of_range& e) {
    std::cerr << "EffCalibrationName: flavour '" << flavour << "' is not known." << std::endl;
    throw e;
  }
}

getBasename()

std::string Analysis::CalibrationDataInterfaceBase::getBasename ( const std::string & name ) const

protected

auxiliary function for retrieval of name within the directory

Definition at line 138 of file CalibrationDataInterfaceBase.cxx.

{
  // Retrieve the name within the directory starting from the full name
 
  return name.substr(name.find_last_of('/')+1, std::string::npos);
}

getContainername()

std::string Analysis::CalibrationDataInterfaceBase::getContainername ( const std::string & flavour, bool SF, unsigned int mapIndex = 0 ) const

protected

auxiliary function for string concatenation

auxiliary function for retrieval of container name

Definition at line 118 of file CalibrationDataInterfaceBase.cxx.

{
  // Construct the full pathname corresponding to the container indicated by the combination
  // of tagging operating point, jet flavour, and a possible extra extension. The calibration
  // container name (stored internally) is also attached.
 
  const std::vector<std::string>& effNames = m_calibrationEffNames.at(flavour);
  if (!SF && mapIndex >= effNames.size()) {
    std::cerr << "getContainername: given mapIndex=" << mapIndex << " incompatible with array size "
          << effNames.size() << "; resetting to 0" << std::endl;
    mapIndex = 0;
  }
  std::string name = SF ? m_calibrationSFNames.at(flavour) : effNames[mapIndex];
  name += SF ? "_SF" : "_Eff";
 
  return name;
}

setEffCalibrationNames()

void Analysis::CalibrationDataInterfaceBase::setEffCalibrationNames

(

const std::map< std::string, std::vector< std::string > > &

names

)

Definition at line 63 of file CalibrationDataInterfaceBase.cxx.

{
  // Set the MC efficiency names.
 
  m_calibrationEffNames = names;
}

setSFCalibrationNames()

void Analysis::CalibrationDataInterfaceBase::setSFCalibrationNames

(

const std::map< std::string, std::string > &

names

)

Definition at line 87 of file CalibrationDataInterfaceBase.cxx.

{
  // Set the efficiency scale factor calibration names.
 
  m_calibrationSFNames = names;
}

SFCalibrationName()

const std::string & Analysis::CalibrationDataInterfaceBase::SFCalibrationName

(

const std::string &

flavour

)

const

Definition at line 72 of file CalibrationDataInterfaceBase.cxx.

{
  // Return the efficiency scale factor calibration name for the given flavour.
  // Note that no check is performed on the validity of the flavour.
 
  try {
    return m_calibrationSFNames.at(flavour);
  }
  catch (const std::out_of_range& e) {
    std::cerr << "SFCalibrationName: flavour '" << flavour << "' is not known." << std::endl;
    throw e;
  }
}

Member Data Documentation

m_calibrationEffNames

std::map<std::string, std::vector<std::string> > Analysis::CalibrationDataInterfaceBase::m_calibrationEffNames

private

this simply collects the per-flavour properties.

Definition at line 72 of file CalibrationDataInterfaceBase.h.

m_calibrationSFNames

std::map<std::string, std::string> Analysis::CalibrationDataInterfaceBase::m_calibrationSFNames

private

Definition at line 73 of file CalibrationDataInterfaceBase.h.

m_taggerName

std::string Analysis::CalibrationDataInterfaceBase::m_taggerName

protected

tagging algorithm name

Definition at line 94 of file CalibrationDataInterfaceBase.h.

---

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

• CalibrationDataInterfaceBase.h
• CalibrationDataInterfaceBase.cxx