#include <GSCCalibStep.h>

Inheritance diagram for GSCCalibStep:

Collaboration diagram for GSCCalibStep:

Public Member Functions
	GSCCalibStep (const std::string &name="GSCCalibStep")
	Constructor with parameters:
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual StatusCode	calibrate (xAOD::JetContainer &) const override
	Apply calibration to a jet container.
virtual void	print () const
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
virtual StatusCode	getNominalResolutionData (const xAOD::Jet &, const JetHelper::JetContext &, double &) const
virtual StatusCode	getNominalResolutionMC (const xAOD::Jet &, const JetHelper::JetContext &, double &) const
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
float	getChargedFractionResponse (const xAOD::Jet &jet, const JetHelper::JetContext &jc, uint etabin) const
	Functions for retrieving the correction factors.
float	getTile0Response (const xAOD::Jet &jet, const JetHelper::JetContext &jc, uint etabin) const
float	getEM3Response (const xAOD::Jet &jet, const JetHelper::JetContext &jc, uint etabin) const
float	getPunchThroughResponse (const xAOD::Jet &jet, const JetHelper::JetContext &jc, double eta_det) const
float	getNTrkResponse (const xAOD::Jet &jet, const JetHelper::JetContext &jc, uint etabin) const
float	getTrackWIDTHResponse (const xAOD::Jet &jet, const JetHelper::JetContext &jc, uint etabin) const
const xAOD::Vertex *	findHSVertex (const xAOD::VertexContainer &vertices) const
	Retrieve hard scatter vertex for its index. Return nullptr if one cannot be found.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
Gaudi::Property< std::string >	m_jetInScale {this, "InScale", "JetEtaJESScaleMomentum", "Starting jet scale"}
Gaudi::Property< std::string >	m_jetOutScale {this, "OutScale", "JetGSCScaleMomentum", "Ending jet scale"}
ToolHandleArray< JetHelper::IVarTool >	m_histTool_EM3 = {this , "histTool_EM3", {}, "EM3 histo reader" }
ToolHandleArray< JetHelper::IVarTool >	m_histTool_ChargedFraction = {this , "histTool_CharFrac", {}, "ChargedFraction histo reader" }
ToolHandleArray< JetHelper::IVarTool >	m_histTool_Tile0 = {this , "histTool_Tile0", {}, "Tile0 histo reader" }
ToolHandleArray< JetHelper::IVarTool >	m_histTool_PunchThrough = {this , "histTool_PunchThrough", {}, "PunchThrough histo reader" }
ToolHandleArray< JetHelper::IVarTool >	m_histTool_nTrk = {this , "histTool_nTrk", {}, "nTrk histo reader" }
ToolHandleArray< JetHelper::IVarTool >	m_histTool_trackWIDTH = {this , "histTool_trackWIDTH", {}, "trackWIDTH histo reader" }
Gaudi::Property< bool >	m_applyChargedFraction {this, "applyChargedFraction", true, "Boolean to turn on/off chargedFraction corretion"}
	Booleans to apply calibration steps:
Gaudi::Property< bool >	m_applyTile0 {this, "applyTile0", true, "Boolean to turn on/off Tile0 corretion"}
Gaudi::Property< bool >	m_applyEM3 {this, "applyEM3", true, "Boolean to turn on/off EM3 corretion"}
Gaudi::Property< bool >	m_applyNtrk {this, "applyNtrk", true, "Boolean to turn on/off Ntrk corretion"}
Gaudi::Property< bool >	m_applyTrackWidth {this, "applyTrackWidth", true, "Boolean to turn on/off trackWidth corretion"}
Gaudi::Property< bool >	m_applyPunchThrough {this, "applyPunchThrough", false, "Boolean to turn on punch-through corretion"}
	Properties for the punch-through correction:
Gaudi::Property< std::vector< double > >	m_punchThroughEtaBins {this, "PunchThroughEtaBins", {}, "Eta bins for punch through correction"}
Gaudi::Property< float >	m_punchThroughMinPt { this, "punchThroughMinPt", 50000., "Threshold for punch-through correction"}
SG::ReadHandleKey< xAOD::VertexContainer >	m_vertexContainer_key {this, "VertexContainer", "PrimaryVertices", "SG key for input vertex container"}
SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfo_key {this, "EventInfoKey", "EventInfo"}
	EventInfo to retrieve PV index for analyses choosing their own PV (e.g. H to yy).
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 29 of file GSCCalibStep.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

◆ GSCCalibStep()

GSCCalibStep::GSCCalibStep ( const std::string & name = "GSCCalibStep" )

Constructor with parameters:

Definition at line 13 of file GSCCalibStep.cxx.

14 : asg::AsgTool( name ){ }

Member Function Documentation

◆ calibrate()

StatusCode GSCCalibStep::calibrate ( xAOD::JetContainer & jets ) const

overridevirtual

Apply calibration to a jet container.

Implements IJetCalibStep.

Definition at line 51 of file GSCCalibStep.cxx.

                                                               {
 
  ATH_MSG_DEBUG("Calibrating jet collection with GSC.");
 
  // Retrieve the primary vertex location:
  int PVindex = 0;
 
  // Check if an analysis choose their own PV vertex ("PVIndex")
  static const SG::AuxElement::ConstAccessor<int> pvIndexAccessor("PVIndex");
  SG::ReadHandle<xAOD::EventInfo> eventInfo(m_eventInfo_key);
  if(eventInfo.isValid()) {
    if(pvIndexAccessor.isAvailable(*eventInfo)){
      PVindex = pvIndexAccessor(*eventInfo);
    }
  }
  else{
    // Get the PV index directly from the vertices
    SG::ReadHandle<xAOD::VertexContainer> vertexHandle = SG::makeHandle (m_vertexContainer_key);
    const xAOD::VertexContainer& vertices = *vertexHandle;
    const xAOD::Vertex *HSvertex = findHSVertex(vertices);
    if(!HSvertex) {
      ATH_MSG_WARNING("Invalid primary vertex found, will not continue applying the GSC.");
      return StatusCode::FAILURE;
    }
    PVindex = HSvertex->index();
  }
 
  ATH_MSG_DEBUG("PV index:" << PVindex);
 
  // Needed for per-vertex reconstructed jets
  static const SG::ConstAccessor<xAOD::Vertex> originVertexAcc("OriginVertex");
 
  // Calibrate the jets
  for (xAOD::Jet* jet : jets){ 
 
    JetHelper::JetContext jc;
 
    // For the per-vertex reconstructed jets, use the vertex the jet was reconstructed with respect to
    if(originVertexAcc.isAvailable(*jet)){
      PVindex = jet->getAssociatedObject<xAOD::Vertex>("OriginVertex")->index();
    }
 
    // get trackWIDTHPVX
    float trackWIDTHPVX = 0;
    static const SG::ConstAccessor<std::vector<float> > TrackWidthPt1000Acc ("TrackWidthPt1000");
    if(TrackWidthPt1000Acc.isAvailable(*jet))
    {
        trackWIDTHPVX = TrackWidthPt1000Acc(*jet).at(PVindex);
        ATH_MSG_DEBUG("trackWIDTHPVX found set to: " << trackWIDTHPVX);
    }
    jc.setValue("trackWIDTH", trackWIDTHPVX);
 
    // get nTrkPVX
    int nTrkPVX = 0;
    static const SG::ConstAccessor<std::vector<int>> NumTrkPt1000Acc ("NumTrkPt1000");
    if(NumTrkPt1000Acc.isAvailable(*jet))
    {
        nTrkPVX = NumTrkPt1000Acc(*jet).at(PVindex);
        ATH_MSG_DEBUG("nTrkPVX found set to: " << nTrkPVX);
    }
    jc.setValue("nTrk", nTrkPVX);
 
    // get Charged Fraction
    xAOD::JetFourMom_t jetconstitP4 = jet->getAttribute<xAOD::JetFourMom_t>("JetConstitScaleMomentum");
    float ChargedFraction = 0;
    static const SG::ConstAccessor<std::vector<float>> SumPtChargedPFOPt500Acc ("SumPtChargedPFOPt500");
    if(SumPtChargedPFOPt500Acc.isAvailable(*jet))
    {
        ChargedFraction = SumPtChargedPFOPt500Acc(*jet).at(PVindex)/jetconstitP4.Pt();
        ATH_MSG_DEBUG("ChargedFraction found set to: " << ChargedFraction);
    }
    jc.setValue("ChargedFraction", ChargedFraction);
 
    std::vector<float> samplingFrac = jet->getAttribute<std::vector<float> >("EnergyPerSampling");
    // get EM3
    float EM3 = (samplingFrac[3]+samplingFrac[7])/jetconstitP4.e();
    ATH_MSG_DEBUG("EM3 found set to: " << EM3);
    jc.setValue("EM3", EM3);
    // get Tile0
    float Tile0 = (samplingFrac[12]+samplingFrac[18])/jetconstitP4.e();
    ATH_MSG_DEBUG("Tile0 found set to: " << Tile0);
    jc.setValue("Tile0", Tile0);
 
    // get Muon segments
    int Nsegments = 0;
    static const SG::ConstAccessor<int> GhostMuonSegmentCountAcc ("GhostMuonSegmentCount");
    if(GhostMuonSegmentCountAcc.isAvailable(*jet))
    {
        Nsegments = GhostMuonSegmentCountAcc(*jet);
        ATH_MSG_DEBUG("Nsegments found set to: " << Nsegments);
    }
    jc.setValue("Nsegments", Nsegments);
 
    float getGSCCorrection = 1.0;
 
    // get detector eta to determine bin
    float detectorEta = jet->getAttribute<float>("DetectorEta");
    int etabin = std::abs(detectorEta)/0.1;// m_binSize in old version
 
    const xAOD::JetFourMom_t startingP4 = jet->getAttribute<xAOD::JetFourMom_t>(m_jetInScale);
    jet->setJetP4(startingP4);
 
    ATH_MSG_DEBUG("Jet pt original ("<<m_jetInScale<<"): " << jet->pt()*1e-3);
 
    ATH_MSG_DEBUG("ChargedFraction Response: " << getChargedFractionResponse(*jet, jc, etabin));
    ATH_MSG_DEBUG("Tile0 Response: " <<getTile0Response(*jet, jc, etabin));
    ATH_MSG_DEBUG("EM3 Response: " << getEM3Response(*jet, jc, etabin));
    ATH_MSG_DEBUG("NTrk Response: " <<getNTrkResponse(*jet, jc, etabin));
    ATH_MSG_DEBUG("TrkWidth Response: " <<getTrackWIDTHResponse(*jet, jc, etabin));
 
    if(m_applyChargedFraction){
      getGSCCorrection*=1./getChargedFractionResponse(*jet, jc, etabin);
      jet->setJetP4( startingP4*getGSCCorrection );
    }
    if(m_applyTile0){
      getGSCCorrection*=1./getTile0Response(*jet, jc, etabin);
      jet->setJetP4( startingP4*getGSCCorrection );
    }
    if(m_applyEM3){
      getGSCCorrection*=1./getEM3Response(*jet, jc, etabin);
      jet->setJetP4( startingP4*getGSCCorrection );
    }
    if(m_applyNtrk){
      getGSCCorrection*=1./getNTrkResponse(*jet, jc, etabin);
      jet->setJetP4( startingP4*getGSCCorrection );
    }
    if(m_applyTrackWidth){
      getGSCCorrection*=1./getTrackWIDTHResponse(*jet, jc, etabin);
      jet->setJetP4( startingP4*getGSCCorrection );
    }
    if(m_applyPunchThrough && startingP4.Pt() >= m_punchThroughMinPt){
      jet->setJetP4( startingP4*getGSCCorrection );
      getGSCCorrection*=1./getPunchThroughResponse(*jet, jc, std::abs(detectorEta));
    }
 
    ATH_MSG_DEBUG("GSC full correction: " << getGSCCorrection);
 
    jet->setAttribute<xAOD::JetFourMom_t>(m_jetOutScale,startingP4*getGSCCorrection);
    jet->setJetP4( startingP4*getGSCCorrection );
 
    ATH_MSG_DEBUG("Jet pt calibrated:" << jet->pt()*1e-3);
 
  }// loop jets
 
  return StatusCode::SUCCESS;
}

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & 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.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

◆ findHSVertex()

const xAOD::Vertex * GSCCalibStep::findHSVertex ( const xAOD::VertexContainer & vertices ) const

private

Retrieve hard scatter vertex for its index. Return nullptr if one cannot be found.

Definition at line 252 of file GSCCalibStep.cxx.

                                                                                      {
  for ( const xAOD::Vertex* vertex : vertices ) {
    if(vertex->vertexType() == xAOD::VxType::PriVtx) {
      ATH_MSG_VERBOSE("GSCCalibStep " << name() << " Found HS vertex at index: "<< vertex->index());
      return vertex;
    }
  }
  if (vertices.size()==1) {
    ATH_MSG_VERBOSE("GSCCalibStep " << name() << " Found no HS vertex, return dummy");
    if (vertices.back()->vertexType() == xAOD::VxType::NoVtx)
      return vertices.back();
  }
  ATH_MSG_VERBOSE("No vertex found in container.");
  return nullptr;
}

◆ getChargedFractionResponse()

float GSCCalibStep::getChargedFractionResponse	(	const xAOD::Jet &	jet,
		const JetHelper::JetContext &	jc,
		uint	etabin ) const

private

Functions for retrieving the correction factors.

Definition at line 198 of file GSCCalibStep.cxx.

                                                                                                                   {
  if (jc.getValue<float>("ChargedFraction")<=0) return 1; //ChargedFraction < 0 is unphysical, ChargedFraction = 0 is a special case, so we return 1 for ChargedFraction <= 0
  if ( etabin >= m_histTool_ChargedFraction.size() ) return 1.;
  double ChargedFractionResponse = m_histTool_ChargedFraction[etabin]->getValue(jet, jc);
  return ChargedFractionResponse;
}

◆ getEM3Response()

float GSCCalibStep::getEM3Response	(	const xAOD::Jet &	jet,
		const JetHelper::JetContext &	jc,
		uint	etabin ) const

private

Definition at line 212 of file GSCCalibStep.cxx.

                                                                                                       {
  if (jc.getValue<float>("EM3")<=0) return 1; //EM3 < 0 is unphysical, EM3 = 0 is a special case, so we return 1 for EM3 <= 0
  if ( etabin >= m_histTool_EM3.size() ) return 1.;
  float EM3Response = m_histTool_EM3[etabin]->getValue(jet, jc);
  return EM3Response;
}

◆ 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::Event 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::Event, 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
   }

◆ 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::Event 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::Event, 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
   }

◆ getNominalResolutionData()

virtual StatusCode IJetCalibStep::getNominalResolutionData	(	const xAOD::Jet &	,
		const JetHelper::JetContext &	,
		double &	) const

inlinevirtualinherited

Reimplemented in SmearingCalibStep.

Definition at line 38 of file IJetCalibStep.h.

38{ return StatusCode::FAILURE; }

◆ getNominalResolutionMC()

virtual StatusCode IJetCalibStep::getNominalResolutionMC	(	const xAOD::Jet &	,
		const JetHelper::JetContext &	,
		double &	) const

inlinevirtualinherited

Reimplemented in SmearingCalibStep.

Definition at line 39 of file IJetCalibStep.h.

39{ return StatusCode::FAILURE; }

◆ getNTrkResponse()

float GSCCalibStep::getNTrkResponse	(	const xAOD::Jet &	jet,
		const JetHelper::JetContext &	jc,
		uint	etabin ) const

private

Definition at line 237 of file GSCCalibStep.cxx.

                                                                                                        {
  if (jc.getValue<int>("nTrk")<=0) return 1; //nTrk < 0 is unphysical, nTrk = 0 is a special case, so return 1 for nTrk <= 0
  if ( etabin >= m_histTool_nTrk.size() ) return 1.;
  double nTrkResponse = m_histTool_nTrk[etabin]->getValue(jet, jc);
  return nTrkResponse;
}

◆ getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

◆ getPunchThroughResponse()

float GSCCalibStep::getPunchThroughResponse	(	const xAOD::Jet &	jet,
		const JetHelper::JetContext &	jc,
		double	eta_det ) const

private

Definition at line 219 of file GSCCalibStep.cxx.

                                                                                                                   {
  int etabin=-99;
  if (m_punchThroughEtaBins.empty() || m_histTool_PunchThrough.size() != m_punchThroughEtaBins.size()-1)
    ATH_MSG_WARNING("Please check that the punch through eta binning is properly set in your config file");
  if ( eta_det >= m_punchThroughEtaBins[m_punchThroughEtaBins.size()-1] || jc.getValue<int>("Nsegments") < 20 ) return 1;
  for (uint i=0; i<m_punchThroughEtaBins.size()-1; ++i) {
    if(eta_det >= m_punchThroughEtaBins[i] && eta_det < m_punchThroughEtaBins[i+1]) etabin = i;
  }
  if(etabin<0) {
    ATH_MSG_WARNING("There was a problem determining the eta bin to use for the punch through correction.");
    //this could probably be improved, but to avoid a seg fault...
    return 1;
  }
  double PunchThroughResponse = m_histTool_PunchThrough[etabin]->getValue(jet, jc);
  if(PunchThroughResponse>1) return 1;
  return PunchThroughResponse;
}

◆ getTile0Response()

float GSCCalibStep::getTile0Response	(	const xAOD::Jet &	jet,
		const JetHelper::JetContext &	jc,
		uint	etabin ) const

private

Definition at line 205 of file GSCCalibStep.cxx.

                                                                                                         {
  if (jc.getValue<float>("Tile0")<0) return 1; //Tile0 < 0 is unphysical, so we return 1
  if ( etabin >= m_histTool_Tile0.size() ) return 1.;
  double Tile0Response = m_histTool_Tile0[etabin]->getValue(jet, jc);
  return Tile0Response;
}

◆ getTrackWIDTHResponse()

float GSCCalibStep::getTrackWIDTHResponse	(	const xAOD::Jet &	jet,
		const JetHelper::JetContext &	jc,
		uint	etabin ) const

private

Definition at line 244 of file GSCCalibStep.cxx.

                                                                                                              {
  if (jc.getValue<float>("trackWIDTH")<=0) return 1;
  if ( etabin >= m_histTool_trackWIDTH.size() ) return 1.;
  //jets with no tracks are assigned a trackWIDTH of -1, we use the trackWIDTH=0 correction in those cases
  double trackWIDTHResponse = m_histTool_trackWIDTH[etabin]->getValue(jet, jc);
  return trackWIDTHResponse;
}

◆ initialize()

StatusCode GSCCalibStep::initialize ( void )

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 20 of file GSCCalibStep.cxx.

                                    {
  ATH_MSG_DEBUG ("Initializing " << name() );
 
  ATH_MSG_DEBUG("Reading from " << m_jetInScale << " and writing to " << m_jetOutScale);
 
  if(m_applyChargedFraction){
    ATH_CHECK( m_histTool_ChargedFraction.retrieve());
  }
  if(m_applyEM3){
    ATH_CHECK( m_histTool_EM3.retrieve());
  }
  if(m_applyTile0){
    ATH_CHECK( m_histTool_Tile0.retrieve());
  }
  if(m_applyNtrk){
     ATH_CHECK( m_histTool_nTrk.retrieve());
  }
  if(m_applyTrackWidth){
    ATH_CHECK( m_histTool_trackWIDTH.retrieve());
  }
  if(m_applyPunchThrough){
    ATH_CHECK( m_histTool_PunchThrough.retrieve());
  }
 
  ATH_CHECK(m_vertexContainer_key.initialize());
  ATH_CHECK(m_eventInfo_key.initialize());
 
  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.

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ 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 AsgHelloTool, HI::HIPileupTool, JetBottomUpSoftDrop, JetConstituentsRetriever, JetDumper, JetFinder, JetFromPseudojet, JetModifiedMassDrop, JetPileupLabelingTool, JetPruner, JetPseudojetRetriever, JetReclusterer, JetReclusteringTool, JetRecTool, JetRecursiveSoftDrop, JetSoftDrop, JetSplitter, JetSubStructureMomentToolsBase, JetToolRunner, JetTrimmer, JetTruthLabelingTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

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

◆ 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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, and AthCheckedComponent<::AthAlgTool >.

◆ 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_applyChargedFraction

Gaudi::Property<bool> GSCCalibStep::m_applyChargedFraction {this, "applyChargedFraction", true, "Boolean to turn on/off chargedFraction corretion"}

private

Booleans to apply calibration steps:

Definition at line 54 of file GSCCalibStep.h.

54{this, "applyChargedFraction", true, "Boolean to turn on/off chargedFraction corretion"};

◆ m_applyEM3

Gaudi::Property<bool> GSCCalibStep::m_applyEM3 {this, "applyEM3", true, "Boolean to turn on/off EM3 corretion"}

private

Definition at line 56 of file GSCCalibStep.h.

56{this, "applyEM3", true, "Boolean to turn on/off EM3 corretion"};

◆ m_applyNtrk

Gaudi::Property<bool> GSCCalibStep::m_applyNtrk {this, "applyNtrk", true, "Boolean to turn on/off Ntrk corretion"}

private

Definition at line 57 of file GSCCalibStep.h.

57{this, "applyNtrk", true, "Boolean to turn on/off Ntrk corretion"};

◆ m_applyPunchThrough

Gaudi::Property<bool> GSCCalibStep::m_applyPunchThrough {this, "applyPunchThrough", false, "Boolean to turn on punch-through corretion"}

private

Properties for the punch-through correction:

Definition at line 61 of file GSCCalibStep.h.

61{this, "applyPunchThrough", false, "Boolean to turn on punch-through corretion"};

◆ m_applyTile0

Gaudi::Property<bool> GSCCalibStep::m_applyTile0 {this, "applyTile0", true, "Boolean to turn on/off Tile0 corretion"}

private

Definition at line 55 of file GSCCalibStep.h.

55{this, "applyTile0", true, "Boolean to turn on/off Tile0 corretion"};

◆ m_applyTrackWidth

Gaudi::Property<bool> GSCCalibStep::m_applyTrackWidth {this, "applyTrackWidth", true, "Boolean to turn on/off trackWidth corretion"}

private

Definition at line 58 of file GSCCalibStep.h.

58{this, "applyTrackWidth", true, "Boolean to turn on/off trackWidth corretion"};

◆ 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_eventInfo_key

SG::ReadHandleKey<xAOD::EventInfo> GSCCalibStep::m_eventInfo_key {this, "EventInfoKey", "EventInfo"}

private

EventInfo to retrieve PV index for analyses choosing their own PV (e.g. H to yy).

Definition at line 77 of file GSCCalibStep.h.

77{this, "EventInfoKey", "EventInfo"};

◆ 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_histTool_ChargedFraction

ToolHandleArray<JetHelper::IVarTool> GSCCalibStep::m_histTool_ChargedFraction = {this , "histTool_CharFrac", {}, "ChargedFraction histo reader" }

private

Definition at line 47 of file GSCCalibStep.h.

47{this , "histTool_CharFrac", {}, "ChargedFraction histo reader" };

◆ m_histTool_EM3

ToolHandleArray<JetHelper::IVarTool> GSCCalibStep::m_histTool_EM3 = {this , "histTool_EM3", {}, "EM3 histo reader" }

private

Definition at line 46 of file GSCCalibStep.h.

46{this , "histTool_EM3", {}, "EM3 histo reader" };

◆ m_histTool_nTrk

ToolHandleArray<JetHelper::IVarTool> GSCCalibStep::m_histTool_nTrk = {this , "histTool_nTrk", {}, "nTrk histo reader" }

private

Definition at line 50 of file GSCCalibStep.h.

50{this , "histTool_nTrk", {}, "nTrk histo reader" };

◆ m_histTool_PunchThrough

ToolHandleArray<JetHelper::IVarTool> GSCCalibStep::m_histTool_PunchThrough = {this , "histTool_PunchThrough", {}, "PunchThrough histo reader" }

private

Definition at line 49 of file GSCCalibStep.h.

49{this , "histTool_PunchThrough", {}, "PunchThrough histo reader" };

◆ m_histTool_Tile0

ToolHandleArray<JetHelper::IVarTool> GSCCalibStep::m_histTool_Tile0 = {this , "histTool_Tile0", {}, "Tile0 histo reader" }

private

Definition at line 48 of file GSCCalibStep.h.

48{this , "histTool_Tile0", {}, "Tile0 histo reader" };

◆ m_histTool_trackWIDTH

ToolHandleArray<JetHelper::IVarTool> GSCCalibStep::m_histTool_trackWIDTH = {this , "histTool_trackWIDTH", {}, "trackWIDTH histo reader" }

private

Definition at line 51 of file GSCCalibStep.h.

51{this , "histTool_trackWIDTH", {}, "trackWIDTH histo reader" };

◆ m_jetInScale

Gaudi::Property<std::string> GSCCalibStep::m_jetInScale {this, "InScale", "JetEtaJESScaleMomentum", "Starting jet scale"}

private

Definition at line 43 of file GSCCalibStep.h.

43{this, "InScale", "JetEtaJESScaleMomentum", "Starting jet scale"};

◆ m_jetOutScale

Gaudi::Property<std::string> GSCCalibStep::m_jetOutScale {this, "OutScale", "JetGSCScaleMomentum", "Ending jet scale"}

private

Definition at line 44 of file GSCCalibStep.h.

44{this, "OutScale", "JetGSCScaleMomentum", "Ending jet scale"};

◆ m_punchThroughEtaBins

Gaudi::Property<std::vector<double> > GSCCalibStep::m_punchThroughEtaBins {this, "PunchThroughEtaBins", {}, "Eta bins for punch through correction"}

private

Definition at line 62 of file GSCCalibStep.h.

62{this, "PunchThroughEtaBins", {}, "Eta bins for punch through correction"};

◆ m_punchThroughMinPt

Gaudi::Property<float> GSCCalibStep::m_punchThroughMinPt { this, "punchThroughMinPt", 50000., "Threshold for punch-through correction"}

private

Definition at line 63 of file GSCCalibStep.h.

63{ this, "punchThroughMinPt", 50000., "Threshold for punch-through correction"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexContainer_key

SG::ReadHandleKey<xAOD::VertexContainer> GSCCalibStep::m_vertexContainer_key {this, "VertexContainer", "PrimaryVertices", "SG key for input vertex container"}

private

Definition at line 75 of file GSCCalibStep.h.

75{this, "VertexContainer", "PrimaryVertices", "SG key for input vertex container"};

◆ 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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ GSCCalibStep()

Member Function Documentation

◆ calibrate()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ findHSVertex()

◆ getChargedFractionResponse()

◆ getEM3Response()

◆ getKey()

◆ getName()

◆ getNominalResolutionData()

◆ getNominalResolutionMC()

◆ getNTrkResponse()

◆ getProperty()

◆ getPunchThroughResponse()

◆ getTile0Response()

◆ getTrackWIDTHResponse()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_applyChargedFraction

◆ m_applyEM3

◆ m_applyNtrk

◆ m_applyPunchThrough

◆ m_applyTile0

◆ m_applyTrackWidth

◆ m_detStore

◆ m_eventInfo_key

◆ m_evtStore

◆ m_histTool_ChargedFraction

◆ m_histTool_EM3

◆ m_histTool_nTrk

◆ m_histTool_PunchThrough

◆ m_histTool_Tile0

◆ m_histTool_trackWIDTH

◆ m_jetInScale

◆ m_jetOutScale

◆ m_punchThroughEtaBins

◆ m_punchThroughMinPt

◆ m_varHandleArraysDeclared

◆ m_vertexContainer_key

◆ m_vhka