CP::FFJetSmearingTool Class Reference

#include <FFJetSmearingTool.h>

Inheritance diagram for CP::FFJetSmearingTool:

Collaboration diagram for CP::FFJetSmearingTool:

Classes
struct	SysData

Public Member Functions
	FFJetSmearingTool (const std::string &name)
	Proper constructor for Athena. More...
virtual	~FFJetSmearingTool ()
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...
virtual CP::CorrectionCode	applyCorrection (xAOD::Jet &jet_reco) const override
	Apply a systematic variation of get a new copy. More...
virtual CP::CorrectionCode	correctedCopy (const xAOD::Jet &input, xAOD::Jet *&output) const override
virtual CP::CorrectionCode	applyContainerCorrection (xAOD::JetContainer &inputs) const override
StatusCode	getMatchedTruthJet (xAOD::Jet &jet_reco, xAOD::Jet &jet_truth_matched) const
virtual void	print () const
	Print the state of the tool. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const
Methods implementing the ISystematicsTool interface
virtual bool	isAffectedBySystematic (const CP::SystematicVariation &systematic) const override
	Specify whether tool is affected by provided systematic. More...
virtual CP::SystematicSet	affectingSystematics () const override
	List of all systematics affecting this tool. More...
virtual CP::SystematicSet	recommendedSystematics () const override
	List of all systematics recommended for this tool. More...
virtual StatusCode	applySystematicVariation (const CP::SystematicSet &systematics) override
	Configure tool to apply systematic variation. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	readFFJetSmearingToolSimplifiedData (TEnv &settings)
StatusCode	getJMSJMR (xAOD::Jet &jet_reco, double jet_mass, JetTools::FFJetAllowedMassDefEnum MassDef_of_syst, const std::string &jetTopology, double &JMS_err, double &JMR_err) const
StatusCode	getJetTopology (xAOD::Jet &jet_reco, std::string &jetTopology) const
double	Read3DHistogram (const TH3 *histo, double x, double y, double z) const
double	Interpolate2D (const TH2 *histo, double x, double y) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
bool	m_isInit {}
std::string	m_release
std::string	m_truth_jetColl
std::string	m_truthlabelaccessor
float	m_EtaRange {}
float	m_MaxMass {}
float	m_MaxPt {}
std::string	m_calibArea
std::string	m_histFileName
std::string	m_MassDef_string
JetTools::FFJetAllowedMassDefEnum	m_MassDef {}
std::string	m_configFile
std::string	m_path
std::string	m_HistogramsFilePath
std::unique_ptr< TH2 >	m_CALO_ResponseMap
std::unique_ptr< TH2 >	m_TA_ResponseMap
std::unique_ptr< TH3F >	m_caloMassWeight
std::unique_ptr< TH3F >	m_TAMassWeight
CP::SystematicSet	m_SysList
std::map< std::string, std::string >	m_Syst_MassDefAffected_map
std::map< std::string, std::string >	m_Syst_TopologyAffected_map
std::map< std::string, std::string >	m_Syst_HistPath_map
std::map< std::string, std::unique_ptr< TH2 > >	m_Syst_Hist_map
std::map< std::string, std::string >	m_Syst_HistTAPath_map
std::map< std::string, std::unique_ptr< TH2 > >	m_Syst_HistTA_map
std::map< std::string, std::string >	m_Syst_Affects_JMSorJMR
std::unordered_map< CP::SystematicSet, SysData >	m_sysData
SysData *	m_currentSysData {nullptr}
	Points to the current systematic configuration. More...
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Static Private Attributes
static constexpr float	m_MeVtoGeV = 1.e-3

Detailed Description

Definition at line 95 of file FFJetSmearingTool.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

FFJetSmearingTool()

CP::FFJetSmearingTool::FFJetSmearingTool

(

const std::string &

name

)

Proper constructor for Athena.

Definition at line 28 of file FFJetSmearingTool.cxx.

    : asg::AsgTool(name) 
    , m_isInit(false)
    , m_release("")
    , m_truth_jetColl("")
    , m_EtaRange(0)
    , m_calibArea("CalibArea-08")
    , m_histFileName("")
    {
    declareProperty( "MassDef", m_MassDef_string = ""                             );
    declareProperty( "ConfigFile", m_configFile = ""        );//Path to the config file. By default it points to XXX
    declareProperty("Path",m_path);
}

~FFJetSmearingTool()

CP::FFJetSmearingTool::~FFJetSmearingTool ( )

virtualdefault

Member Function Documentation

affectingSystematics()

CP::SystematicSet CP::FFJetSmearingTool::affectingSystematics ( ) const

overridevirtual

List of all systematics affecting this tool.

Implements CP::IReentrantSystematicsTool.

Definition at line 181 of file FFJetSmearingTool.cxx.

{
    CP::SystematicSet result;
    result.insert(m_SysList);
 
    return result;
}

applyContainerCorrection()

CP::CorrectionCode CP::FFJetSmearingTool::applyContainerCorrection ( xAOD::JetContainer &  inputs ) const

overridevirtual

Implements ICPJetCorrectionTool.

Definition at line 836 of file FFJetSmearingTool.cxx.

{
    CP::CorrectionCode result = CP::CorrectionCode::Ok;
 
    // Loop over the container
    for (size_t iJet = 0; iJet < inputs.size(); ++iJet)
    {
        result = applyCorrection(*inputs.at(iJet));
        if (result == CP::CorrectionCode::Error)
            break;
    }
    return result;
}

applyCorrection()

CP::CorrectionCode CP::FFJetSmearingTool::applyCorrection ( xAOD::Jet &  jet_reco ) const

overridevirtual

Apply a systematic variation of get a new copy.

Implements ICPJetCorrectionTool.

Definition at line 587 of file FFJetSmearingTool.cxx.

                                                                           {
 
    ATH_MSG_VERBOSE("//---------------------------------------------------------------//");
    ATH_MSG_VERBOSE("Reco Jet to Smear: pt = " << jet_reco.pt() << ", mass = " << jet_reco.m() << ", eta = " << jet_reco.eta());
 
    if(std::abs(jet_reco.eta()) > m_EtaRange){//JetCalibTools do not properly for jets with |eta|>2
        ATH_MSG_DEBUG("This jet exceeds the eta range that the tool allows (|eta|<" << m_EtaRange << ")");
        return CP::CorrectionCode::OutOfValidityRange; 
    }
    if(jet_reco.m() > m_MaxMass){
        ATH_MSG_DEBUG("This jet exceeds the mass range that the tool allows jet_mass <" << m_MaxMass << " MeV)");
        return CP::CorrectionCode::OutOfValidityRange;
    }
    if(jet_reco.pt() > m_MaxPt){
        ATH_MSG_DEBUG("This jet exceeds the maximum pt that the tool allows jet_pt <" << m_MaxPt << " MeV)");
        return CP::CorrectionCode::OutOfValidityRange;
    }
 
    //Find matched truth jet
    xAOD::Jet jet_truth_matched;
    jet_truth_matched.makePrivateStore();
 
    if(!(getMatchedTruthJet(jet_reco, jet_truth_matched).isSuccess())){
        ATH_MSG_VERBOSE("No truth jet match with this reco jet. The jet will not be smeared.");
        return CP::CorrectionCode::OutOfValidityRange; 
    }
 
    ATH_MSG_VERBOSE("Matched truth Jet: pt = " << jet_truth_matched.pt() << ", mass = " << jet_truth_matched.m() << ", eta = " << jet_truth_matched.eta());
 
    //Get the jet topology
    std::string jetTopology;
 
    if(!(getJetTopology( jet_reco, jetTopology)).isSuccess()){
        ATH_MSG_ERROR("Imposible to obtain the jetTopology");
        return CP::CorrectionCode::Error;
    }
    if(jetTopology == "no_match"){
        return CP::CorrectionCode::OutOfValidityRange;
    }
 
 
    //The TA mass is saved in an attribute so you can not access to it using ->m(). (if calibrated as Calo mass and not as Combined Mass), The Calo mass is not set as an attribute so you can not access it using ->getAttribute . 
 
    double jet_mass_CALO = 0;
    double jet_mass_TA = 0;
    double calo_mass_weight=1; // m_comb = Weight*m_Calo + (1-Weight)*m_TA
 
    float JetTrackAssistedMassCalibrated_from_JetCalibTools;
 
    if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Comb){
 
        xAOD::JetFourMom_t jet_reco_CALO;
        xAOD::JetFourMom_t jet_reco_TA;
        xAOD::JetFourMom_t jet_reco_Comb;
 
        jet_reco.getAttribute<xAOD::JetFourMom_t>("JetJMSScaleMomentumCalo",jet_reco_CALO);
        jet_reco.getAttribute<xAOD::JetFourMom_t>("JetJMSScaleMomentumTA",jet_reco_TA);
        jet_reco.getAttribute<xAOD::JetFourMom_t>("JetJMSScaleMomentumCombQCD",jet_reco_Comb);
 
        ATH_MSG_VERBOSE("CALO jet mass " << jet_reco_CALO.mass());
        ATH_MSG_VERBOSE("TA jet mass " << jet_reco_TA.mass() );
        ATH_MSG_VERBOSE("Comb jet mass " << jet_reco_Comb.mass() );
 
        jet_mass_CALO = jet_reco_CALO.mass();
        jet_mass_TA = jet_reco_TA.mass();
        jet_reco.getAttribute<float>("JetTrackAssistedMassCalibrated", JetTrackAssistedMassCalibrated_from_JetCalibTools);
    }
    if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Calo){
        jet_mass_CALO = jet_reco.m();
        calo_mass_weight = 1;
    }
    else if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::TA){
        jet_mass_TA = jet_reco.m();
    jet_reco.getAttribute<float>("JetTrackAssistedMassCalibrated", JetTrackAssistedMassCalibrated_from_JetCalibTools);
        calo_mass_weight = 0;
    }
 
 
 
 
    //Obtain the average mass response of the jet. The response will depend in the chosed topology (top,W or QCD) and also in the mass definition (CALO, TA, Combined). By default the map used correspond to QCD jets
 
    double avg_response_CALO=1;
    double avg_response_TA=1;
 
    if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Comb || m_MassDef==JetTools::FFJetAllowedMassDefEnum::Calo){
 
        avg_response_CALO = FFJetSmearingTool::Interpolate2D(m_CALO_ResponseMap.get(), jet_reco.pt()*m_MeVtoGeV, jet_truth_matched.m()*m_MeVtoGeV);
        if(avg_response_CALO==0) avg_response_CALO=1;//If we look outside the Th2 histogram, we would obtain a 0 so we apply the nominal response (1)
    }
 
    if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Comb || m_MassDef==JetTools::FFJetAllowedMassDefEnum::TA){
 
        avg_response_TA = FFJetSmearingTool::Interpolate2D(m_TA_ResponseMap.get(), jet_reco.pt()*m_MeVtoGeV, jet_truth_matched.m()*m_MeVtoGeV);
        if(avg_response_TA==0) avg_response_TA = 1;
    }
 
 
    //Obtain the jet mass scale (JMS) and the jet mass resolution (JMR) nominal values and variation that correspond to the jet_reco
 
    double JMS (1), JMS_err(0), JMR(1), JMR_err(0);
    double scale;
    double resolution;
 
    double smeared_CALO_mass = jet_mass_CALO;
    double smeared_TA_mass = jet_mass_TA;
 
    bool is_CALO_mass_smeared = false;
    bool is_TA_mass_smeared = false;
 
    if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Comb || m_MassDef==JetTools::FFJetAllowedMassDefEnum::Calo){
 
        if(!(getJMSJMR( jet_reco, jet_mass_CALO, JetTools::FFJetAllowedMassDefEnum::Calo,jetTopology, JMS_err, JMR_err)).isSuccess()){
            return CP::CorrectionCode::Ok;
        }
 
        scale = JMS + JMS_err;
        resolution = JMR + JMR_err;
 
        if(TMath::Abs(scale-1) > 0.0001 || TMath::Abs(resolution-1)  > 0.0001){
            is_CALO_mass_smeared = true;
 
            ATH_MSG_VERBOSE("Forward Folding CALO procedure will use scale=" << scale << ", resolution=" << resolution << " and average respose=" << avg_response_CALO);
 
            //FF procedure
            smeared_CALO_mass = jet_mass_CALO * scale + (jet_mass_CALO - avg_response_CALO*jet_truth_matched.m())*(resolution-scale);//FF formula
        }
 
    }
 
    if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Comb || m_MassDef==JetTools::FFJetAllowedMassDefEnum::TA){
        if(!(getJMSJMR( jet_reco, jet_mass_TA, JetTools::FFJetAllowedMassDefEnum::TA,jetTopology, JMS_err, JMR_err))){
            return CP::CorrectionCode::Ok;
        }
 
        scale = JMS + JMS_err;
        resolution = JMR + JMR_err;
 
        if(TMath::Abs(scale-1) > 0.0001 || TMath::Abs(resolution-1)  > 0.0001){
 
            is_TA_mass_smeared = true;
 
            ATH_MSG_VERBOSE("Forward Folding TA procedure will use scale=" << scale << ", resolution=" << resolution << " and average respose=" << avg_response_TA);
 
            //FF procedure
            smeared_TA_mass = jet_mass_TA * scale + (jet_mass_TA - avg_response_TA*jet_truth_matched.m())*(resolution-scale);//FF formula
        }
 
    }
 
    if(!is_CALO_mass_smeared && !is_TA_mass_smeared){//We only smear the jet if we have to. If not, avoid doing extra calculations
 
        ATH_MSG_VERBOSE("This jet is not affected by the systematic. The jet won't be modified");
        ATH_MSG_VERBOSE("//---------------------------------------------------------------//");
 
        return CP::CorrectionCode::Ok;
    }
 
 
    //Recalculate the weights after the smearing
    if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Comb && JetTrackAssistedMassCalibrated_from_JetCalibTools != 0 && jet_mass_CALO != 0){
                                        //we check that JetTrackAssistedMassCalibrated_from_JetCalibTools != 0 instead of jet_mass_TA != 0 becuase
                                        //there is a problem in the conversion between the mass itself and the four-vector representation (due to a
                                        //limitation of floating). This makes the value of jet_mass_TA!=0 in situations where it should be 0.
                                        //In order to work arround it we check JetTrackAssistedMassCalibrated_from_JetCalibTools != 0 insead.
        double caloRes;
        double TARes;
 
        xAOD::JetFourMom_t jet_reco_CALO;
        xAOD::JetFourMom_t jet_reco_TA;
 
        jet_reco.getAttribute<xAOD::JetFourMom_t>("JetJMSScaleMomentumCalo",jet_reco_CALO);
        jet_reco.getAttribute<xAOD::JetFourMom_t>("JetJMSScaleMomentumTA",jet_reco_TA);
 
 
        xAOD::JetFourMom_t p4_aux;
 
        //The smearing do not change the pt but it changes the mass (so the energy too) so, itf we want to perform the smearing properly, we have to change 
        //the Calo and TA foru momenta before looking at the weights map
        p4_aux = xAOD::JetFourMom_t(jet_reco_CALO.pt(),jet_reco_CALO.eta(),jet_reco_CALO.phi(),smeared_CALO_mass);//The smearing do not change the pt but it changes the Energy 
        jet_reco_CALO = p4_aux;
 
        p4_aux = xAOD::JetFourMom_t(jet_reco_TA.pt(),jet_reco_TA.eta(),jet_reco_TA.phi(),smeared_TA_mass);
        jet_reco_TA = p4_aux;
 
        caloRes=FFJetSmearingTool::Read3DHistogram(m_caloMassWeight.get() ,jet_reco_CALO.e()*m_MeVtoGeV,TMath::Log(jet_reco_CALO.M()/jet_reco_CALO.e()),std::abs(jet_reco_CALO.eta()));
 
        TARes=FFJetSmearingTool::Read3DHistogram(m_TAMassWeight.get() ,jet_reco_TA.e()*m_MeVtoGeV,TMath::Log(jet_reco_TA.M()/jet_reco_TA.e()),std::abs(jet_reco_TA.eta()));
 
        //The histograms with the weights that we are reading were defined with the code "e_LOGmOe_eta" which means that each axis correspond to:
        //-X: Jet Energy
        //-Y: Log(Jet_Energy/Jet_mass)
        //-Z:Eta
        //Domain is [200-6000],[-6,0],[0,2] but, the ReadHistogram function put the value of the extream of the histogram to the values outside the domain.
        //We have to use a custom "My_Interpolate" because the Z axis has just one bin (and this makes the Root Interpolate function fail) 
 
        double caloFactor;
        double TAFactor;
 
        if (caloRes == 0 ) { caloFactor = 0; TAFactor = 1;}
        else if( TARes == 0) { caloFactor = 1; TAFactor = 0;}
        else{
            caloFactor = 1./(caloRes*caloRes);
            TAFactor   = 1./(TARes*TARes);
        }
 
        calo_mass_weight = caloFactor /(caloFactor + TAFactor);
 
        ATH_MSG_VERBOSE(" Map Calo weight = " << calo_mass_weight  );
        ATH_MSG_VERBOSE(" Map TA weight = " << 1 - calo_mass_weight  );
    }
    else if(JetTrackAssistedMassCalibrated_from_JetCalibTools == 0){calo_mass_weight = 1;}
    else if(jet_mass_CALO == 0){calo_mass_weight = 0;}
 
    double smeared_mass = calo_mass_weight*smeared_CALO_mass + (1 - calo_mass_weight)*smeared_TA_mass;
 
    ATH_MSG_VERBOSE("Smeared CALO mass " << smeared_CALO_mass);
    ATH_MSG_VERBOSE("Smeared TA mass " << smeared_TA_mass);
 
    xAOD::JetFourMom_t p4 = jet_reco.jetP4();
 
    p4 = xAOD::JetFourMom_t(jet_reco.pt(),jet_reco.eta(),jet_reco.phi(),smeared_mass);
    jet_reco.setJetP4(p4);
 
 
    ATH_MSG_VERBOSE("Smeared Reco Jet: pt = " << jet_reco.pt() << ", mass = " << jet_reco.m() << ", eta = " << jet_reco.eta()); 
 
    ATH_MSG_VERBOSE("//---------------------------------------------------------------//");
 
    return CP::CorrectionCode::Ok;
}

applySystematicVariation()

StatusCode CP::FFJetSmearingTool::applySystematicVariation ( const CP::SystematicSet &  systematics )

overridevirtual

Configure tool to apply systematic variation.

Implements CP::ISystematicsTool.

Definition at line 223 of file FFJetSmearingTool.cxx.

{
    // First check if we already know this systematic configuration.
    // Look for it in our sysData map.
    auto iter = m_sysData.find (systematics);
 
    // If this is a new input set, we need to filter it.
    if(iter == m_sysData.end()){
        // Filter the input systematics with my affecting systematics.
        const CP::SystematicSet affectingSysts = affectingSystematics();
        CP::SystematicSet filteredSysts;
        if( CP::SystematicSet::
            filterForAffectingSystematics(systematics, affectingSysts, filteredSysts) !=
            StatusCode::SUCCESS ) 
        {
            ATH_MSG_ERROR("Received unsupported systematics: " << systematics.name());
            return StatusCode::FAILURE;
        }
 
        // At this point, we can do some additional checks for consistency
        // with the JMS/JMR functionality. For example, if the tool can only handle
        // one type of systematic at a time, we return an error if the filtered
        // set has more than one item:
        if(filteredSysts.size() > 1){
            ATH_MSG_ERROR("No support for more than one JMS/JMR sys at a time: " <<
                    filteredSysts.name());
            return StatusCode::FAILURE;
        }
 
        // Insert the new systematic data onto our map
        SysData myData;
 
        const CP::SystematicVariation& sys = *filteredSysts.begin();
 
        myData.SysParameter = sys.parameter(); //Up (+1) and Down (-1) systematic variation
        myData.SysBaseName = sys.basename(); //Name of the systematic variation
 
        iter = m_sysData.emplace (systematics, myData).first;
    }
 
    // Apply the filtered systematics
    m_currentSysData = &iter->second;
 
    return StatusCode::SUCCESS;
}

correctedCopy()

CP::CorrectionCode CP::FFJetSmearingTool::correctedCopy ( const xAOD::Jet &  input, xAOD::Jet *&  output  ) const

overridevirtual

Implements ICPJetCorrectionTool.

Definition at line 820 of file FFJetSmearingTool.cxx.

{
 
    xAOD::Jet* copy = new xAOD::Jet(input);
 
    // Call the implemented function
    if (applyCorrection(*copy) == CP::CorrectionCode::Error)
    {
        delete copy;
        return CP::CorrectionCode::Error;
    }
    output = copy;
    return CP::CorrectionCode::Ok;
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyArrayType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
  }

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                 {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase &  ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

getJetTopology()

StatusCode CP::FFJetSmearingTool::getJetTopology ( xAOD::Jet &  jet_reco, std::string &  jetTopology  ) const

private

Definition at line 458 of file FFJetSmearingTool.cxx.

{
 
    const SG::AuxElement::ConstAccessor<int> accTruthLabel(m_truthlabelaccessor);
    if (!accTruthLabel.isAvailable(jet_reco) )
    {
        ATH_MSG_ERROR("Unable to retrieve the FatjetTruthLabel from the jet.  Please call the BoostedJetTaggers decorateTruthLabel() function before calling this function.");
        return StatusCode::FAILURE;
    }
 
 
LargeRJetTruthLabel::TypeEnum jetTruthLabel = LargeRJetTruthLabel::intToEnum(accTruthLabel(jet_reco));
 
    if(jetTruthLabel == LargeRJetTruthLabel::tqqb || jetTruthLabel == LargeRJetTruthLabel::other_From_t)
    {
        jetTopology="Top";
    }
 
    else if(jetTruthLabel == LargeRJetTruthLabel::Wqq || jetTruthLabel == LargeRJetTruthLabel::Zqq || jetTruthLabel == LargeRJetTruthLabel::Wqq_From_t || jetTruthLabel == LargeRJetTruthLabel::other_From_V)
    {
        jetTopology="V";
    }
 
    else if(jetTruthLabel == LargeRJetTruthLabel::qcd)   
    {
        jetTopology="QCD";
    }
 
    else if(jetTruthLabel == LargeRJetTruthLabel::Hbb || jetTruthLabel == LargeRJetTruthLabel::other_From_H)
    {
        jetTopology="H";
    }
 
    else if(jetTruthLabel == LargeRJetTruthLabel::notruth)    
    {
        jetTopology="no_match";
        ATH_MSG_DEBUG("No truth jet match with this reco jet. The jet will not be smeared.");
    }
  
    else jetTopology="QCD"; //We should never arrive here 
 
    ATH_MSG_VERBOSE("The topology of this jet correspond to a " << jetTopology << " large-R jet");
 
    return StatusCode::SUCCESS;
}

getJMSJMR()

StatusCode CP::FFJetSmearingTool::getJMSJMR ( xAOD::Jet &  jet_reco, double  jet_mass, JetTools::FFJetAllowedMassDefEnum  MassDef_of_syst, const std::string &  jetTopology, double &  JMS_err, double &  JMR_err  ) const

private

Definition at line 510 of file FFJetSmearingTool.cxx.

                                                                                                                                                                                                        {
 
    //JMS/JMR systematic variations
    JMS_err=0;
    JMR_err=0;
 
    //Some variables to simplify the logic in the "if" structure found below
    auto calo = JetTools::FFJetAllowedMassDefEnum::Calo;
    auto ta = JetTools::FFJetAllowedMassDefEnum::TA;
    auto massAffectedSys = m_Syst_MassDefAffected_map.at(m_currentSysData->SysBaseName);
 
    if(m_Syst_MassDefAffected_map.at(m_currentSysData->SysBaseName) ==  JetTools::enumToString(MassDef_of_syst) || massAffectedSys ==  JetTools::enumToString(JetTools::FFJetAllowedMassDefEnum::Comb) ){
      ATH_MSG_VERBOSE("This uncertainty affects to the " << JetTools::enumToString(MassDef_of_syst) << " mass");
    } //Only apply the systematic to the proper mass definition
    else{return StatusCode::SUCCESS;}
 
    if(m_Syst_TopologyAffected_map.at(m_currentSysData->SysBaseName) != "All" && m_Syst_TopologyAffected_map.at(m_currentSysData->SysBaseName) != jetTopology){
        ATH_MSG_VERBOSE("The systematic do not affects to this jet topology");
        return StatusCode::SUCCESS;
    }
 
 
    float jet_mass = jet_mass_value*m_MeVtoGeV;//jet_reco->m()*m_MeVtoGeV; The TA mass can not be extracted this way
    float jet_pT = jet_reco.pt()*m_MeVtoGeV;
 
    if(m_Syst_Affects_JMSorJMR.at(m_currentSysData->SysBaseName) == "JMS"){
        JMR_err= 0;
 
        const TH2* hist = nullptr; //This variable will contain the pointer to the proper histogram to use in the interpolation
 
        if(m_Syst_MassDefAffected_map.at(m_currentSysData->SysBaseName)== JetTools::enumToString(calo) || massAffectedSys== JetTools::enumToString(ta) ){//TA and Calo mass defs take values from one hisogram only
 
            hist = m_Syst_Hist_map.at(m_currentSysData->SysBaseName).get();
        }
        else if(m_Syst_MassDefAffected_map.at(m_currentSysData->SysBaseName)==JetTools::enumToString(JetTools::FFJetAllowedMassDefEnum::Comb) ){//Comb mass defs can take values from two histograms, depending ifits Calo- or TA- part is affected
            if(MassDef_of_syst==calo)
                hist = m_Syst_Hist_map.at(m_currentSysData->SysBaseName).get();
            else if(MassDef_of_syst==ta)
                hist = m_Syst_HistTA_map.at(m_currentSysData->SysBaseName).get();
        }
        JMS_err = FFJetSmearingTool::Interpolate2D(hist, jet_pT, jet_mass) * m_currentSysData->SysParameter;
    }
 
    else if(m_Syst_Affects_JMSorJMR.at(m_currentSysData->SysBaseName) == "JMR"){           
    JMS_err=0;
 
        const TH2* hist = nullptr;
 
    if(m_Syst_MassDefAffected_map.at(m_currentSysData->SysBaseName)== JetTools::enumToString(calo) || massAffectedSys== JetTools::enumToString(ta) ){//TA and Calo mass defs take values from one hisogram only
 
            hist = m_Syst_Hist_map.at(m_currentSysData->SysBaseName).get();
        }
 
        else if(m_Syst_MassDefAffected_map.at(m_currentSysData->SysBaseName)==JetTools::enumToString(JetTools::FFJetAllowedMassDefEnum::Comb) ){//Comb mass defs can take values from two histograms, depending ifits Calo- or TA- part is affected
        if(MassDef_of_syst==calo)
                hist = m_Syst_Hist_map.at(m_currentSysData->SysBaseName).get();
        else if(MassDef_of_syst==ta)
                hist = m_Syst_HistTA_map.at(m_currentSysData->SysBaseName).get();
        }
        JMR_err = FFJetSmearingTool::Interpolate2D(hist, jet_pT, jet_mass) * m_currentSysData->SysParameter; 
    }
 
    
    ATH_MSG_DEBUG("Systematic applied: " << m_currentSysData->SysBaseName);
 
    ATH_MSG_VERBOSE("JMS_err: " << JMS_err);
    ATH_MSG_VERBOSE("JMR_err: " << JMR_err);
 
    return StatusCode::SUCCESS;
}

getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void *  ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                    {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getKey( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      return ( proxy == nullptr ? 0 : proxy->sgkey() );
#endif // XAOD_STANDALONE
   }

getMatchedTruthJet()

StatusCode CP::FFJetSmearingTool::getMatchedTruthJet	(	xAOD::Jet &	jet_reco,
		xAOD::Jet &	jet_truth_matched
	)		const

Definition at line 425 of file FFJetSmearingTool.cxx.

{
 
    // Get the truth jets of the event
    const xAOD::JetContainer* jets_truth = nullptr;
 
    ATH_CHECK(evtStore()->retrieve( jets_truth, m_truth_jetColl));//If fail, it means that we are "Unable to retrieve jetColl Info". It shows an Error message and exits
 
    double dRmax_truthJet = 0.75;// matching condition
    double dRmin=9999; //we will take the closest jet reco-truth
 
    //Loop over the truth jets in the event to match
    const xAOD::Jet* close_jet = nullptr;
    for (const auto *const jet_truth : *jets_truth) {
        float dR_Test = jet_reco.p4().DeltaR(jet_truth->p4());
        if ( dR_Test < dRmax_truthJet){
            if(dR_Test < dRmin){
                close_jet = jet_truth;
                dRmin = dR_Test;
            }
        }
    }
    if(dRmin > 999){ return StatusCode::FAILURE;}
 
    jet_truth_matched.setJetP4(close_jet->jetP4());
    return StatusCode::SUCCESS;
} 

getName()

const std::string & asg::AsgTool::getName ( const void *  ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also

asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns

The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                            {
 
#ifdef XAOD_STANDALONE
      // In case we use @c xAOD::TEvent, we have a direct function call
      // for this.
      return evtStore()->event()->getName( ptr );
#else
      const SG::DataProxy* proxy = evtStore()->proxy( ptr );
      static const std::string dummy = "";
      return ( proxy == nullptr ? dummy : proxy->name() );
#endif // XAOD_STANDALONE
   }

getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string &  name ) const

inherited

Get one of the tool's properties.

initialize()

StatusCode CP::FFJetSmearingTool::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 49 of file FFJetSmearingTool.cxx.

{
 
    // Ensure it hasn't been initialized already
    if (m_isInit)
    {
        ATH_MSG_FATAL(Form("Blocking re-initialization of tool named %s",AsgTool::name().c_str())); //AsgTool::name() calls the name
        return StatusCode::FAILURE;
    }
 
    ATH_MSG_INFO(Form("Preparing to initialize the FFJetSmearingTool named %s",AsgTool::name().c_str()));
 
    if (AsgTool::name().empty())
    {
        ATH_MSG_FATAL("No name specified.  Aborting.");
        return StatusCode::FAILURE;
    }
    if (m_MassDef_string.empty())
    {
        ATH_MSG_FATAL("No kind of jet mass specified.  Aborting.");
        return StatusCode::FAILURE;
    }
 
    // Make sure we have a valid mass definition
    ATH_CHECK(JetTools::stringToEnum(m_MassDef_string, m_MassDef)); //If it fails it means that there is No Systematic Uncertainties derived for to the given mass definition.
                                                                     //The mass definition should be 'Calo', 'TA' or 'Comb'. Show an error and exits.
 
    //reading the config file as in JetUncertaintiesTool
    TEnv settings;
 
    const TString configFilePath = jet::utils::findFilePath(m_configFile.c_str(),m_path.c_str(),m_calibArea.c_str());
 
    if (settings.ReadFile( configFilePath.Data(),kEnvGlobal))
    {
        ATH_MSG_ERROR("Cannot read config file: " << configFilePath.Data());
        return StatusCode::FAILURE;
    }
    // We can read it - start printing
    ATH_MSG_INFO("================================================");
    ATH_MSG_INFO(Form("  Initializing the FFJetSmearingTool named %s",AsgTool::name().c_str()));
    ATH_MSG_INFO("  Configuration file: " << m_configFile);
    ATH_MSG_INFO("    Location: " << configFilePath.Data());
 
 
    m_release = settings.GetValue("UncertaintyRelease","UNKNOWN");
    ATH_MSG_INFO("  Uncertainty release: " << m_release.c_str());
 
    // Check the jet definition
    m_truth_jetColl = settings.GetValue("TruthJetColl","");
    if (m_truth_jetColl.empty())
    {
        ATH_MSG_ERROR("Cannot find the truth jet collection to use in config");
        return StatusCode::FAILURE;
    }
    ATH_MSG_INFO("  Truth Jet Collection: " << m_truth_jetColl);
    // Check the name of the truth label accessor for BoostjetTaggers
    m_truthlabelaccessor = settings.GetValue("TruthLabelAccessor","");
    if (m_truthlabelaccessor.empty())
    {
        ATH_MSG_ERROR("Cannot find the TruthLabelAccessor to use in config");
        return StatusCode::FAILURE;
    }
    ATH_MSG_INFO("  Truth Label Accessor: " << m_truthlabelaccessor);
    //eta range of the tool  
    m_EtaRange = settings.GetValue("EtaRange",0);
    if (m_EtaRange == 0)
    {
        ATH_MSG_ERROR("Cannot find the EtaRange parameter in the config file");
        return StatusCode::FAILURE;
    }
    ATH_MSG_INFO("  EtaRange : Abs(eta) < " << m_EtaRange);
    //mass range of the tool  
    m_MaxMass = settings.GetValue("MaxMass",0);
    if (m_MaxMass == 0)
    {
        ATH_MSG_ERROR("Cannot find the MaxMass parameter in the config file");
        return StatusCode::FAILURE;
    }
    ATH_MSG_INFO("  MaxMass : jet_mass < " << m_MaxMass);
    //pt range of the tool 
    m_MaxPt = settings.GetValue("MaxPt",0);
    if (m_MaxPt == 0)
    {
        ATH_MSG_ERROR("Cannot find the MaxPt parameter in the config file");
        return StatusCode::FAILURE;
    }
    ATH_MSG_INFO("  MaxPt : jet_pt < " << m_MaxPt);
    // Get the file to read uncertainties in from
    m_histFileName = settings.GetValue("UncertaintyRootFile","");
    m_HistogramsFilePath = jet::utils::findFilePath(m_histFileName.c_str(),m_path.c_str(),m_calibArea.c_str());
    if (m_histFileName.empty())
    {
        ATH_MSG_ERROR("Cannot find uncertainty histogram file in the config file");
        return StatusCode::FAILURE;
    }
    ATH_MSG_INFO("  UncertaintyFile: " << m_histFileName);
    ATH_MSG_INFO("    Location: " << m_HistogramsFilePath);
 
 
 
    //Read all the histogram files where the jms jmr variations are saved
    ATH_CHECK(readFFJetSmearingToolSimplifiedData(settings));//If fail, it shows an Error message and exits
 
    // Add the affecting systematics to the global registry
    CP::SystematicRegistry& registry = CP::SystematicRegistry::getInstance();
    if(registry.registerSystematics(*this) != StatusCode::SUCCESS){
      ATH_MSG_ERROR("Unable to register systematics!");
      return StatusCode::FAILURE;
    }
 
    m_isInit = true;
 
   // ANA_CHECK (applySystematicVariation (CP::SystematicSet()));
 
    return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

Interpolate2D()

double CP::FFJetSmearingTool::Interpolate2D ( const TH2 *  histo, double  x, double  y  ) const

private

Definition at line 889 of file FFJetSmearingTool.cxx.

{
    if (not histo){
      ATH_MSG_ERROR("Histogram pointer is null in FFJetSmearingTool::Interpolate2D");
      return 0.;
    }
    Int_t bin_x = histo->GetXaxis()->FindFixBin(x);
    Int_t bin_y = histo->GetYaxis()->FindFixBin(y);
    if(bin_x<1 || bin_x>histo->GetNbinsX() || bin_y<1 || bin_y>histo->GetNbinsY()) {
       ATH_MSG_VERBOSE("The point is outside the histogram domain.");
       return 0.;
    }
    
    double interpolated_value = JetHelpers::Interpolate(histo, x, y);
    return interpolated_value;
}

isAffectedBySystematic()

bool CP::FFJetSmearingTool::isAffectedBySystematic ( const CP::SystematicVariation &  systematic ) const

overridevirtual

Specify whether tool is affected by provided systematic.

Implements CP::ISystematicsTool.

Definition at line 171 of file FFJetSmearingTool.cxx.

{
    // Using 'find' is sufficient until this tool supports continuous
    //   // variations, at which point I'll need to use the 'match' method.
    CP::SystematicSet sys = affectingSystematics();
    return sys.find(systematic) != sys.end();
}

msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns

The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                  {
 
      return MSG::name( msg().level() );
   }

msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, top::TopObjectSelection, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                             {
 
      ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
      return;
   }

Read3DHistogram()

double CP::FFJetSmearingTool::Read3DHistogram ( const TH3 *  histo, double  x, double  y, double  z  ) const

private

Definition at line 856 of file FFJetSmearingTool.cxx.

{
 
  double aux_x = x;
  double aux_y = y;
  double aux_z = z;
 
 
  // Asymptotic values
  //If the value is outside the histogram region, we take the closest value to that one
 
  double xMax = histo->GetXaxis()->GetBinLowEdge(histo->GetNbinsX()+1);
  double xMin = histo->GetXaxis()->GetBinLowEdge(1);
  double yMax = histo->GetYaxis()->GetBinLowEdge(histo->GetNbinsY()+1);
  double yMin = histo->GetYaxis()->GetBinLowEdge(1);
  double zMax = histo->GetZaxis()->GetBinLowEdge(histo->GetNbinsZ()+1);
  double zMin = histo->GetZaxis()->GetBinLowEdge(1);
 
  if(x >= xMax) aux_x = xMax-1e-6 ; //so it fits the up-most x-bin
  if(x <= xMin) aux_x = xMin+1e-6 ; //so it fits the low-most x-bin
  if ( std::isnan(y)) return 0; // no weight if the input is NaN, can happen for log(X)
  if(y >= yMax) aux_y = yMax-1e-6 ; //so it fits the up-most y-bin
  if(y <= yMin) aux_y = yMin+1e-6 ; //so it fits the low-most y-bin
  if(z >= zMax) aux_z = zMax-1e-6 ; //so it fits the up-most z-bin
  if(z <= zMin) aux_z = zMin+1e-6 ; //so it fits the low-most z-bin
 
  //Use the interpolate function from JetHelpers.cxx
  double weight = JetHelpers::Interpolate(histo, aux_x, aux_y, aux_z);
 
 
  return weight;
}

readFFJetSmearingToolSimplifiedData()

StatusCode CP::FFJetSmearingTool::readFFJetSmearingToolSimplifiedData ( TEnv &  settings )

private

Definition at line 276 of file FFJetSmearingTool.cxx.

                                                                               {
 
    std::unique_ptr<TFile> data_file ( TFile::Open(m_HistogramsFilePath.c_str()));
    if(!data_file || data_file->IsZombie()){
        ATH_MSG_FATAL( "Could not open the first input file: " << m_HistogramsFilePath );
        return StatusCode::FAILURE;
    }
 
 
 
    if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Comb || m_MassDef==JetTools::FFJetAllowedMassDefEnum::Calo){
      TString CaloResponseMap_path = settings.GetValue("CaloResponseMap","");
      
      if(CaloResponseMap_path.IsNull())
    {
      ATH_MSG_ERROR("Cannot find the CaloResponseMap in the config file");
      return StatusCode::FAILURE;
    }
      
      m_CALO_ResponseMap  = std::unique_ptr<TH2>(dynamic_cast<TH2*>(data_file->Get( CaloResponseMap_path )));
      m_CALO_ResponseMap->SetDirectory(nullptr);
    }
 
    if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Comb || m_MassDef==JetTools::FFJetAllowedMassDefEnum::TA){
        TString TAResponseMap_path = settings.GetValue("TAResponseMap","");
 
        if(TAResponseMap_path.IsNull())
        {
            ATH_MSG_ERROR("Cannot find the TAResponseMap in the config file");
            return StatusCode::FAILURE;
        }
 
        m_TA_ResponseMap  = std::unique_ptr<TH2>(dynamic_cast<TH2*>(data_file->Get( TAResponseMap_path )));
        m_TA_ResponseMap->SetDirectory(nullptr);//To keep it open when we close the .root file
    }
 
 
 
    //JMS systematics
    for (size_t iComp = 0; iComp < 999; ++iComp)
    {
        const TString prefix = Form("JMSComponent.%zu.",iComp);
 
        std::string Syst_Name = settings.GetValue(prefix+"Name","");
 
        if( !Syst_Name.empty()){
            m_SysList.insert( CP::SystematicVariation(Syst_Name, 1) );
            m_SysList.insert( CP::SystematicVariation(Syst_Name, -1) );
            m_Syst_MassDefAffected_map[Syst_Name] = settings.GetValue(prefix+"MassDef","");
            m_Syst_TopologyAffected_map[Syst_Name] = settings.GetValue(prefix+"Topology","");
            m_Syst_Affects_JMSorJMR[Syst_Name] = "JMS";
            m_Syst_HistPath_map[Syst_Name] = settings.GetValue(prefix+"Hist","");
            m_Syst_Hist_map[Syst_Name] = std::unique_ptr<TH2>(dynamic_cast<TH2*>(data_file->Get(m_Syst_HistPath_map[Syst_Name].c_str())));
            m_Syst_Hist_map[Syst_Name]->SetDirectory(nullptr);
        if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Comb){//for comb mass we need to read two histograms
          m_Syst_HistTAPath_map[Syst_Name] = settings.GetValue(prefix+"HistTA","");
          if(!m_Syst_HistTAPath_map[Syst_Name].empty()){
          m_Syst_HistTA_map[Syst_Name] = std::unique_ptr<TH2>(dynamic_cast<TH2*>(data_file->Get(m_Syst_HistTAPath_map[Syst_Name].c_str())));
          m_Syst_HistTA_map[Syst_Name]->SetDirectory(nullptr);
          }
        }
    }
    }
    //JMR Systematics
    for (size_t iComp = 0; iComp < 999; ++iComp)
    {
        const TString prefix = Form("JMRComponent.%zu.",iComp);
 
        std::string Syst_Name = settings.GetValue(prefix+"Name","");
 
        if( !Syst_Name.empty()){
            m_SysList.insert( CP::SystematicVariation(Syst_Name, 1) );
            m_SysList.insert( CP::SystematicVariation(Syst_Name, -1) );
            m_Syst_MassDefAffected_map[Syst_Name] = settings.GetValue(prefix+"MassDef","");
            m_Syst_TopologyAffected_map[Syst_Name] = settings.GetValue(prefix+"Topology","");
            m_Syst_Affects_JMSorJMR[Syst_Name] = "JMR";
            m_Syst_HistPath_map[Syst_Name] = settings.GetValue(prefix+"Hist","");
            m_Syst_Hist_map[Syst_Name] = std::unique_ptr<TH2>(dynamic_cast<TH2*>(data_file->Get(m_Syst_HistPath_map[Syst_Name].c_str())));
            m_Syst_Hist_map[Syst_Name]->SetDirectory(nullptr);
        if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Comb){//for comb mass we need to read two histograms
          m_Syst_HistTAPath_map[Syst_Name] = settings.GetValue(prefix+"HistTA","");
          if(!m_Syst_HistTAPath_map[Syst_Name].empty()){
        m_Syst_HistTA_map[Syst_Name] = std::unique_ptr<TH2>(dynamic_cast<TH2*>(data_file->Get(m_Syst_HistTAPath_map[Syst_Name].c_str())));
        m_Syst_HistTA_map[Syst_Name]->SetDirectory(nullptr);
          }
        }      
    }
    }
 
    data_file->Close();
 
 
    //Read the Calo and TA mass weight histograms from the same file that JetUncertainties uses
 
 
    TString Calo_TA_weight_file_name = settings.GetValue("JetUncertainties_UncertaintyRootFile","");
    const TString Calo_TA_weight_file_path = jet::utils::findFilePath(Calo_TA_weight_file_name.Data(),m_path.c_str(),m_calibArea.c_str());
 
    if (Calo_TA_weight_file_path.IsNull())
    {
        ATH_MSG_ERROR("Cannot find the file with the Calo and TA weights");
        return StatusCode::FAILURE;
    }
 
    TString Calo_weight_hist_name = settings.GetValue("CombMassWeightCaloHist","");
    if (Calo_weight_hist_name.IsNull())
    {
        ATH_MSG_ERROR("Cannot find the histogram name that contains the Calo weights in the config file");
        return StatusCode::FAILURE;
    }
 
    TString TA_weight_hist_name = settings.GetValue("CombMassWeightTAHist","");
    if (TA_weight_hist_name.IsNull())
    {
        ATH_MSG_ERROR("Cannot find the histogram name that contains the TA weights in the config file");
        return StatusCode::FAILURE;
    }
 
    ATH_MSG_INFO(Form("  Calo weights hist: \"%s\"",Calo_weight_hist_name.Data()));
    ATH_MSG_INFO(Form("  TA weights hist: \"%s\"",TA_weight_hist_name.Data()));
    ATH_MSG_INFO(Form("    Location: %s",Calo_TA_weight_file_path.Data()));
 
 
    std::unique_ptr<TFile> Calo_TA_weight_file ( TFile::Open(Calo_TA_weight_file_path));
    if(!Calo_TA_weight_file || Calo_TA_weight_file->IsZombie()){
        ATH_MSG_FATAL( "Could not open the first input file: " << Calo_TA_weight_file_path );
        return StatusCode::FAILURE;
    }
 
    m_caloMassWeight = std::unique_ptr<TH3F>(dynamic_cast<TH3F*>(Calo_TA_weight_file->Get(Calo_weight_hist_name)));
    m_TAMassWeight = std::unique_ptr<TH3F>(dynamic_cast<TH3F*>(Calo_TA_weight_file->Get(TA_weight_hist_name)));
 
    m_caloMassWeight->SetDirectory(nullptr);
    m_TAMassWeight->SetDirectory(nullptr);//To keep it open when we close the .root file
 
 
    Calo_TA_weight_file->Close();
 
    return StatusCode::SUCCESS;
}

recommendedSystematics()

CP::SystematicSet CP::FFJetSmearingTool::recommendedSystematics ( ) const

overridevirtual

List of all systematics recommended for this tool.

Implements CP::IReentrantSystematicsTool.

Definition at line 189 of file FFJetSmearingTool.cxx.

{
    
  CP::SystematicSet filteredSysts;
  if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Calo){//take only Calo-like syst
    for (auto ci = m_SysList.begin(); ci != m_SysList.end(); ci++) {
      if ((*ci).basename().find("CALO_")!=std::string::npos)
    filteredSysts.insert(*ci);
    }
    return filteredSysts;    
  }
  if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::TA){//take only TA-like syst 
    for (auto ci = m_SysList.begin(); ci != m_SysList.end(); ci++) {
      if ((*ci).basename().find("TA_") !=std::string::npos)
    filteredSysts.insert(*ci);
    }
    return filteredSysts;    
  }
  if(m_MassDef==JetTools::FFJetAllowedMassDefEnum::Comb){//take only TA-like syst 
    for (auto ci = m_SysList.begin(); ci != m_SysList.end(); ci++) {
      if ((*ci).basename().find("COMB_")!=std::string::npos){
    filteredSysts.insert(*ci);
      }
    }
    return filteredSysts;    
  }
  
  return m_SysList;
}

renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T &  h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray &  handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase &  )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_calibArea

std::string CP::FFJetSmearingTool::m_calibArea

private

Definition at line 157 of file FFJetSmearingTool.h.

m_CALO_ResponseMap

std::unique_ptr<TH2> CP::FFJetSmearingTool::m_CALO_ResponseMap

private

Definition at line 166 of file FFJetSmearingTool.h.

m_caloMassWeight

std::unique_ptr<TH3F> CP::FFJetSmearingTool::m_caloMassWeight

private

Definition at line 170 of file FFJetSmearingTool.h.

m_configFile

std::string CP::FFJetSmearingTool::m_configFile

private

Definition at line 161 of file FFJetSmearingTool.h.

m_currentSysData

SysData* CP::FFJetSmearingTool::m_currentSysData {nullptr}

private

Points to the current systematic configuration.

Definition at line 194 of file FFJetSmearingTool.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_EtaRange

float CP::FFJetSmearingTool::m_EtaRange {}

private

Definition at line 154 of file FFJetSmearingTool.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_histFileName

std::string CP::FFJetSmearingTool::m_histFileName

private

Definition at line 158 of file FFJetSmearingTool.h.

m_HistogramsFilePath

std::string CP::FFJetSmearingTool::m_HistogramsFilePath

private

Definition at line 163 of file FFJetSmearingTool.h.

m_isInit

bool CP::FFJetSmearingTool::m_isInit {}

private

Definition at line 150 of file FFJetSmearingTool.h.

m_MassDef

JetTools::FFJetAllowedMassDefEnum CP::FFJetSmearingTool::m_MassDef {}

private

Definition at line 160 of file FFJetSmearingTool.h.

m_MassDef_string

std::string CP::FFJetSmearingTool::m_MassDef_string

private

Definition at line 159 of file FFJetSmearingTool.h.

m_MaxMass

float CP::FFJetSmearingTool::m_MaxMass {}

private

Definition at line 155 of file FFJetSmearingTool.h.

m_MaxPt

float CP::FFJetSmearingTool::m_MaxPt {}

private

Definition at line 156 of file FFJetSmearingTool.h.

m_MeVtoGeV

constexpr float CP::FFJetSmearingTool::m_MeVtoGeV = 1.e-3

staticconstexprprivate

Definition at line 196 of file FFJetSmearingTool.h.

m_path

std::string CP::FFJetSmearingTool::m_path

private

Definition at line 162 of file FFJetSmearingTool.h.

m_release

std::string CP::FFJetSmearingTool::m_release

private

Definition at line 151 of file FFJetSmearingTool.h.

m_sysData

std::unordered_map<CP::SystematicSet,SysData> CP::FFJetSmearingTool::m_sysData

private

Definition at line 192 of file FFJetSmearingTool.h.

m_SysList

CP::SystematicSet CP::FFJetSmearingTool::m_SysList

private

Definition at line 175 of file FFJetSmearingTool.h.

m_Syst_Affects_JMSorJMR

std::map<std::string,std::string> CP::FFJetSmearingTool::m_Syst_Affects_JMSorJMR

private

Definition at line 184 of file FFJetSmearingTool.h.

m_Syst_Hist_map

std::map<std::string,std::unique_ptr<TH2> > CP::FFJetSmearingTool::m_Syst_Hist_map

private

Definition at line 181 of file FFJetSmearingTool.h.

m_Syst_HistPath_map

std::map<std::string,std::string> CP::FFJetSmearingTool::m_Syst_HistPath_map

private

Definition at line 180 of file FFJetSmearingTool.h.

m_Syst_HistTA_map

std::map<std::string,std::unique_ptr<TH2> > CP::FFJetSmearingTool::m_Syst_HistTA_map

private

Definition at line 183 of file FFJetSmearingTool.h.

m_Syst_HistTAPath_map

std::map<std::string,std::string> CP::FFJetSmearingTool::m_Syst_HistTAPath_map

private

Definition at line 182 of file FFJetSmearingTool.h.

m_Syst_MassDefAffected_map

std::map<std::string,std::string> CP::FFJetSmearingTool::m_Syst_MassDefAffected_map

private

Definition at line 178 of file FFJetSmearingTool.h.

m_Syst_TopologyAffected_map

std::map<std::string,std::string> CP::FFJetSmearingTool::m_Syst_TopologyAffected_map

private

Definition at line 179 of file FFJetSmearingTool.h.

m_TA_ResponseMap

std::unique_ptr<TH2> CP::FFJetSmearingTool::m_TA_ResponseMap

private

Definition at line 167 of file FFJetSmearingTool.h.

m_TAMassWeight

std::unique_ptr<TH3F> CP::FFJetSmearingTool::m_TAMassWeight

private

Definition at line 171 of file FFJetSmearingTool.h.

m_truth_jetColl

std::string CP::FFJetSmearingTool::m_truth_jetColl

private

Definition at line 152 of file FFJetSmearingTool.h.

m_truthlabelaccessor

std::string CP::FFJetSmearingTool::m_truthlabelaccessor

private

Definition at line 153 of file FFJetSmearingTool.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• FFJetSmearingTool.h
• FFJetSmearingTool.cxx