pat::JetCorrFactors Class Reference

Class for the storage of jet correction factors. More...

#include "DataFormats/PatCandidates/interface/JetCorrFactors.h"

Public Types
typedef std::pair< std::string, std::vector< float > >	CorrectionFactor
enum	Flavor {   GLUON, UDS, CHARM, BOTTOM,   NONE }

Public Member Functions
float	correction (unsigned int level, Flavor flavor=NONE) const
std::string	correctionLabel (unsigned int level) const
std::vector< std::string >	correctionLabels () const
std::string	correctionLabelString () const
bool	flavorDependent (unsigned int level) const
std::string	jecFlavor (const Flavor &flavor) const
Flavor	jecFlavor (std::string flavor) const
std::string	jecLevel (const unsigned int &level) const
int	jecLevel (const std::string &level) const
std::string	jecSet () const
	JetCorrFactors ()
	JetCorrFactors (const std::string &label, const std::vector< CorrectionFactor > &jec)
unsigned int	numberOfCorrectionLevels () const
void	print () const

Static Public Attributes
static const unsigned int	MAX_FLAVORS = 4

Private Member Functions
bool	flavorDependent (const CorrectionFactor &jec) const
bool	flavorIndependent (const CorrectionFactor &jec) const
bool	isValid (const CorrectionFactor &jec) const

Private Attributes
std::vector< CorrectionFactor >	jec_
std::string	label_

Detailed Description

Class for the storage of jet correction factors.

Class for the storage of jet correction factors that have been calculated during pat tuple production. The class is created to deal with a flexible number and order of the JES correction factors, which are expected to be nested. I.e. each correction level implies that all previous correction have been applied in advance. This scheme corresponds to the jet energy correction scheme propagated by the JetMET PAG. In dividual levels of JEC are safed as CorrectionFactor, which is a

std::pair<std::string, std::vector<float> >.

The std::string contains a human readable label indicating the corection level, the std::vector<float> contains the JEC factors, which are expected to have a length of 1 or 5. In this scheme the vector of length 1 is reserved for flavor independent CorrectionFactors, while the vector of length 5 corresponds to flavor dependent CorrectionFactors. The individual positions within the vector are expected to be distributed according to the Flavor enumerator of the class as:

GLUON, UDS, CHARM, BOTTOM, NONE

The structure is checked in the constructor of the class. The function correction returns potentially flavor dependent correction factor of the JES relative to an uncorrected jet. To move from one correction level to another correction level the initial correction level of the jet need to be uncorrected before applying the final correction factor. The class is expected to be used from within the pat::Jet only, this is taken care of automatically.

Definition at line 37 of file JetCorrFactors.h.

Member Typedef Documentation

typedef std::pair<std::string, std::vector<float> > pat::JetCorrFactors::CorrectionFactor

Definition at line 45 of file JetCorrFactors.h.

Member Enumeration Documentation

enum pat::JetCorrFactors::Flavor

Enumerator
GLUON
UDS
CHARM
BOTTOM
NONE

Definition at line 47 of file JetCorrFactors.h.

{ GLUON, UDS, CHARM, BOTTOM, NONE };

Constructor & Destructor Documentation

pat::JetCorrFactors::JetCorrFactors ( )

inline

Definition at line 53 of file JetCorrFactors.h.

{};

JetCorrFactors::JetCorrFactors	(	const std::string &	label,
		const std::vector< CorrectionFactor > &	jec
	)

Definition at line 14 of file JetCorrFactors.cc.

References Exception, and isValid().

                                                                                            : label_(label), jec_(jec)
{
  for(std::vector<CorrectionFactor>::const_iterator corrFactor=jec.begin(); corrFactor!=jec.end(); ++corrFactor){
    if(!isValid(*corrFactor)){
      throw cms::Exception("InvalidRequest") << "You try to create a CorrectionFactor which is neither flavor dependent nor \n"
                         << "flavor independent. The CorrectionFactor should obey the following rules:  \n"
                         << "\n"
                         << " * CorrectionFactor is a std::pair<std::string, std::vector<float> >.      \n"
                         << " * The std::string holds the label of the correction level (following the  \n"
                         << "   conventions of JetMET.                                                  \n"
                         << " * The std::vector<float> holds the correction factors, these factors are  \n"
                         << "   up to the given level. They include all previous correction steps.      \n"
                         << " * The vector has the length *1* for flavor independent correction factors \n"
                         << "   or *5* for flavor dependent correction factors.                         \n"
                         << " * The expected order of flavor dependent correction factors is: NONE,     \n"
                         << "   GLUON, UDS, CHARM, BOTTOM. If follows the JetMET conventions and is     \n"
                         << "   in the Flavor enumerator of the JetCorrFactos class.                    \n"
                         << " * For flavor depdendent correction factors the first entry in the vector  \n"
                         << "   (corresponding to NONE) is invalid and should be set to -1. It will not \n"
                         << "   be considered by the class structure though.                            \n"
                         << "\n"
                         << "Make sure that all elements of the argument vector to this contructor are  \n"
                         << "in accordance with these rules.\n";
    }
  }
}

Member Function Documentation

float JetCorrFactors::correction	(	unsigned int	level,
		Flavor	flavor = NONE
	)		const

Definition at line 72 of file JetCorrFactors.cc.

References correctionLabelString(), Exception, flavorDependent(), jec_, and NONE.

Referenced by print().

{
  if(!(level<jec_.size())){
    throw cms::Exception("InvalidRequest") << "You try to call a jet energy correction level wich does not exist. \n"
                       << "Available jet energy correction levels are:                        \n" 
                       << correctionLabelString();    
  }
  if(flavorDependent(jec_.at(level)) && flavor==NONE){
    throw cms::Exception("InvalidRequest") << "You try to call a flavor dependent jet energy correction level:    \n"
                       << "level : " << level << " label: " << jec_.at(level).first << "      \n"
                       << "You need to specify one of the following flavors: GLUON, UDS,      \n"
                       << "CHARM, BOTTOM. \n";
  }
  return flavorDependent(jec_.at(level)) ? jec_.at(level).second.at(flavor) : jec_.at(level).second.at(0);
}

std::string pat::JetCorrFactors::correctionLabel ( unsigned int  level ) const

inline

Definition at line 75 of file JetCorrFactors.h.

References jec_, and AlCaHLTBitMon_QueryRunRegistry::string.

{ return (level<jec_.size() ? jec_.at(level).first : std::string("ERROR")); };

std::vector< std::string > JetCorrFactors::correctionLabels

(

)

const

Definition at line 100 of file JetCorrFactors.cc.

References jec_, and HLT_25ns14e33_v1_cff::labels.

{
  std::vector<std::string> labels;
  for(std::vector<CorrectionFactor>::const_iterator corrFactor=jec_.begin(); corrFactor!=jec_.end(); ++corrFactor){
    labels.push_back(corrFactor->first);
  }
  return labels;
}

std::string JetCorrFactors::correctionLabelString

(

)

const

Definition at line 89 of file JetCorrFactors.cc.

References python.multivaluedict::append(), customizeTrackingMonitorSeedNumber::idx, jec_, HLT_25ns14e33_v1_cff::labels, and AlCaHLTBitMon_QueryRunRegistry::string.

Referenced by correction().

{
  std::string labels;
  for(std::vector<CorrectionFactor>::const_iterator corrFactor=jec_.begin(); corrFactor!=jec_.end(); ++corrFactor){
    std::stringstream idx; idx << (corrFactor-jec_.begin());
    labels.append(idx.str()).append(" ").append(corrFactor->first).append("\n");
  }
  return labels;
}

bool pat::JetCorrFactors::flavorDependent ( unsigned int  level ) const

inline

Definition at line 77 of file JetCorrFactors.h.

References jec_, and MAX_FLAVORS.

Referenced by correction(), isValid(), and print().

{ return (level<jec_.size() ? jec_.at(level).second.size()==MAX_FLAVORS : false); };

bool pat::JetCorrFactors::flavorDependent ( const CorrectionFactor &  jec ) const

inlineprivate

Definition at line 85 of file JetCorrFactors.h.

References MAX_FLAVORS.

{ return (jec.second.size()==MAX_FLAVORS); }

bool pat::JetCorrFactors::flavorIndependent ( const CorrectionFactor &  jec ) const

inlineprivate

Definition at line 87 of file JetCorrFactors.h.

Referenced by isValid().

{ return (jec.second.size()==1); }

bool pat::JetCorrFactors::isValid ( const CorrectionFactor &  jec ) const

inlineprivate

Definition at line 89 of file JetCorrFactors.h.

References flavorDependent(), and flavorIndependent().

Referenced by JetCorrFactors(), and core.AutoHandle.AutoHandle::ReallyLoad().

{ return (flavorDependent(jec) || flavorIndependent(jec)); }    

std::string JetCorrFactors::jecFlavor

(

const Flavor &

flavor

)

const

Definition at line 42 of file JetCorrFactors.cc.

References BOTTOM, CHARM, GLUON, NONE, and UDS.

{
  std::map<Flavor, std::string> flavors;
  flavors[UDS]="uds"; flavors[CHARM]="charm"; flavors[BOTTOM]="bottom"; flavors[GLUON]="gluon"; flavors[NONE]="none"; 
  return flavors.find(flavor)->second;
}

JetCorrFactors::Flavor JetCorrFactors::jecFlavor

(

std::string

flavor

)

const

Definition at line 50 of file JetCorrFactors.cc.

References BOTTOM, CHARM, Exception, GLUON, NONE, create_public_lumi_plots::transform, and UDS.

{
  std::map<std::string, Flavor> flavors;
  std::transform(flavor.begin(), flavor.end(), flavor.begin(), std::ptr_fun<int,int>(std::tolower));
  flavors["uds"]=UDS; flavors["charm"]=CHARM; flavors["bottom"]=BOTTOM; flavors["gluon"]=GLUON; flavors["none"]=NONE;
  if(flavors.find(flavor)==flavors.end()){
    throw cms::Exception("InvalidRequest") << "You ask for a flavor, which does not exist. Available flavors are: \n"
                       << "'uds', 'charm', 'bottom', 'gluon', 'none', (not case sensitive).   \n";
  }
  return flavors.find(flavor)->second;
}

std::string pat::JetCorrFactors::jecLevel ( const unsigned int &  level ) const

inline

Definition at line 60 of file JetCorrFactors.h.

References jec_.

{ return jec_.at(level).first; };

int JetCorrFactors::jecLevel

(

const std::string &

level

)

const

Definition at line 63 of file JetCorrFactors.cc.

References jec_.

{
  for(std::vector<CorrectionFactor>::const_iterator corrFactor=jec_.begin(); corrFactor!=jec_.end(); ++corrFactor){
    if(corrFactor->first==level) return (corrFactor-jec_.begin());
  }
  return -1;
}

std::string pat::JetCorrFactors::jecSet ( ) const

inline

Definition at line 58 of file JetCorrFactors.h.

References label_.

{ return label_; }

unsigned int pat::JetCorrFactors::numberOfCorrectionLevels ( ) const

inline

Definition at line 79 of file JetCorrFactors.h.

References jec_.

{ return jec_.size(); };

void JetCorrFactors::print

(

void

)

const

Definition at line 110 of file JetCorrFactors.cc.

References correction(), flavorDependent(), jec_, python.rootplot.argparse::message, and NONE.

{
  edm::LogInfo message( "JetCorrFactors" );
  for(std::vector<CorrectionFactor>::const_iterator corrFactor=jec_.begin(); corrFactor!=jec_.end(); ++corrFactor){
    unsigned int corrFactorIdx=corrFactor-jec_.begin();
    message << std::setw(3) << corrFactorIdx << "  " << corrFactor->first;
    if( flavorDependent(*corrFactor) ){
      for(std::vector<float>::const_iterator flavor=corrFactor->second.begin(); flavor!=corrFactor->second.end(); ++flavor){
    unsigned int flavorIdx=flavor-corrFactor->second.begin();
    message << std::setw(10) << correction(corrFactorIdx, (Flavor)flavorIdx);
      }
    }
    else{
      message << std::setw(10) << correction (corrFactor-jec_.begin(), NONE); 
    }
    message << "\n";
  }
}

Member Data Documentation

std::vector<CorrectionFactor> pat::JetCorrFactors::jec_

private

Definition at line 101 of file JetCorrFactors.h.

Referenced by correction(), correctionLabel(), correctionLabels(), correctionLabelString(), flavorDependent(), jecLevel(), numberOfCorrectionLevels(), and print().

std::string pat::JetCorrFactors::label_

private

Definition at line 93 of file JetCorrFactors.h.

Referenced by Mixins._Labelable::_findDependencies(), jecSet(), and Mixins._Labelable::setLabel().

const unsigned int pat::JetCorrFactors::MAX_FLAVORS = 4

static

Definition at line 49 of file JetCorrFactors.h.

Referenced by flavorDependent().