JiveXML::xAODJetRetriever Class Reference

Retrieves all Jet objects (JetAODCollection etc.) More...

#include <xAODJetRetriever.h>

Inheritance diagram for JiveXML::xAODJetRetriever:

Collaboration diagram for JiveXML::xAODJetRetriever:

Public Member Functions
	xAODJetRetriever (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor. More...
virtual StatusCode	retrieve (ToolHandle< IFormatTool > &FormatTool)
	For each jet collections retrieve basic parameters. More...
const DataMap	getData (const xAOD::JetContainer *, const std::string &jetkey)
	Puts the variables into a DataMap. More...
const std::vector< std::string >	getKeys ()
	Gets the StoreGate keys for the desired containers. More...
virtual std::string	dataTypeName () const
	Return the name of the data type that is generated by this retriever. More...
virtual StatusCode	initialize ()
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Return the interface identifier. 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
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
const std::string	m_typeName = "Jet"
	The data type that is generated by this retriever. More...
Gaudi::Property< bool >	m_doWriteHLT {this, "DoWriteHLT", false, "Write out other collections that have HLT in the name"}
Gaudi::Property< bool >	m_doWriteAllCollections {this, "DoWriteAllCollections", false, "Write out all Jet collections"}
Gaudi::Property< std::vector< std::string > >	m_otherKeys {this, "OtherJetCollections", {"AntiKt4EMTopoJets", "AntiKt4LCTopoJets", "AntiKt10LCTopoJets", "AntiKt10UFOCSSKJets"}, "Other collections to be retrieved. If DoWriteAllCollections is set to true all available Jet collections will be retrieved"}
Gaudi::Property< std::string >	m_priorityKey {this,"PriorityJetCollection","AntiKt4TopoEMJets", "Name of the priority Jet container that will be written out first"}
Gaudi::Property< bool >	m_writeJetQuality
Gaudi::Property< std::string >	m_tracksName
Gaudi::Property< std::vector< std::string > >	m_bTaggerNames
Gaudi::Property< std::vector< std::string > >	m_CDIPaths
std::unordered_map< std::string, asg::AnaToolHandle< IBTaggingSelectionTool > >	m_btagSelTools
unsigned int	m_nTaggers =0
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

Detailed Description

Retrieves all Jet objects (JetAODCollection etc.)

• Properties
  • PriorityJetCollection: First collection to be retrieved, displayed in Atlantis without switching. All other collections are also retrieved.
  • OtherJetCollections
  • DoWriteHLT
  • DoWriteAllCollections
  • WriteJetQuality
  • TracksName
  • CDIPaths
• Retrieved Data
  • Usual four-vectors: phi, eta, et etc.
  • Associations for clusters and tracks via ElementLink: key/index scheme

Definition at line 40 of file xAODJetRetriever.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

xAODJetRetriever()

JiveXML::xAODJetRetriever::xAODJetRetriever	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Standard Constructor.

This is the standard AthAlgTool constructor.

Parameters

type	AlgTool type name
name	AlgTool instance name
parent	AlgTools parent owning this tool

Definition at line 25 of file xAODJetRetriever.cxx.

                                                                                                        :
    AthAlgTool(type,name,parent){}

Member Function Documentation

dataTypeName()

virtual std::string JiveXML::xAODJetRetriever::dataTypeName ( ) const

inlinevirtual

Return the name of the data type that is generated by this retriever.

Implements JiveXML::IDataRetriever.

Definition at line 54 of file xAODJetRetriever.h.

{ return m_typeName; };

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

getData()

const DataMap JiveXML::xAODJetRetriever::getData	(	const xAOD::JetContainer *	jetCont,
		const std::string &	jetkey
	)

Puts the variables into a DataMap.

Retrieve basic parameters, mainly four-vectors, for each collection.

Also association with clusters and tracks (ElementLink).

Definition at line 89 of file xAODJetRetriever.cxx.

                                                                                                  {
 
    ATH_MSG_DEBUG( "in getData()" );
 
    DataMap DataMap;
 
    DataVect et; et.reserve(jetCont->size());
    DataVect phi; phi.reserve(jetCont->size());
    DataVect eta; eta.reserve(jetCont->size());
    DataVect mass; mass.reserve(jetCont->size());
    DataVect energy; energy.reserve(jetCont->size());
    DataVect bTagName; bTagName.reserve(jetCont->size());
    DataVect bTagValue; bTagValue.reserve(jetCont->size());
    DataVect charge; energy.reserve(jetCont->size());
    DataVect idVec; idVec.reserve(jetCont->size());
    DataVect px; px.reserve(jetCont->size());
    DataVect py; py.reserve(jetCont->size());
    DataVect pz; pz.reserve(jetCont->size());
    DataVect jvf; jvf.reserve(jetCont->size());
    DataVect jvt; jvt.reserve(jetCont->size());
    DataVect emfrac; emfrac.reserve(jetCont->size());
 
    DataVect trackKey; trackKey.reserve(jetCont->size());
    DataVect trackContKey; trackContKey.reserve(jetCont->size());
    DataVect trackLinkCount; trackLinkCount.reserve(jetCont->size());
    DataVect clusterID; clusterID.reserve(jetCont->size());
 
    DataVect cellID; cellID.reserve(jetCont->size());
    DataVect numCells; numCells.reserve(jetCont->size());
 
    int id = 0;
 
    int counter = 0;
    for (const auto jet : *jetCont) {
      if(!jet)continue;
      ATH_MSG_DEBUG( "  Jet #" << counter++ << " : eta = "  << jet->eta() << ", phi = " << jet->phi() << ", pt = " << jet->pt() );
 
      /* retrieve associated tracks and calo clusters */
      size_t numConstit = jet->numConstituents();
      std::vector<std::string> tempCellID;
      size_t trackcounter = 0;
      //TODO FIXME jet->rawConstituent(0) fails for some keys, including (but not exclusively) HLT_AntiKt10EMPFlowCSSKJets_nojcalib_ftf, HLT_AntiKt10EMPFlowCSSKSoftDropBeta100Zcut10Jets_jes_ftf, HLT_AntiKt4EMPFlowJets_nojcalib_ftf, HLT_AntiKt4EMPFlowJets_subjesgscIS_ftf, HLT_AntiKt4EMPFlowJets_subresjesgscIS_ftf
      if (numConstit > 0){
    const xAOD::IParticle* constituent = jet->rawConstituent(0);
    if (constituent){
      xAOD::Type::ObjectType ctype=jet->rawConstituent(0)->type();
      // PFlow and Flow jets from athena/Reconstruction/Jet/JetMomentTools/Root/JetTrackMomentsTool.cxx
      if (ctype == xAOD::Type::ParticleFlow) {
        // This jet is either a PFlow jet (constituent type: xAOD::FlowElement::PFlow) or UFO jets
        for (size_t i = 0; i < numConstit; i++) {
          const xAOD::PFO *constit =
        dynamic_cast<const xAOD::PFO *>(jet->rawConstituent(i));
          if (constit->isCharged()) {
        const xAOD::TrackParticle *thisTrack = constit->track(0); // by construction xAOD::PFO can only have one track, in eflowRec usage
        trackKey.emplace_back(DataType(thisTrack->index()));
        trackContKey.emplace_back(m_tracksName.value());
        trackcounter++;
          } // We have a charged PFO
        } // Loop on jet constituents
      } else if (ctype == xAOD::Type::FlowElement) {
        // This jet is made from xAOD::FlowElement, so we calculate the pflow moments if they're PFOs
        size_t numConstit = jet->numConstituents();
        for (size_t i = 0; i < numConstit; i++) {
          const xAOD::FlowElement *constit = dynamic_cast<const xAOD::FlowElement *>(jet->rawConstituent(i));
          // UFO jet constituents have signalType xAOD::FlowElement::Charged or xAOD::FlowElement::Neutral
          // PFlow jet constituents have signalType xAOD::FlowElement::ChargedPFlow or xAOD::FlowElement::NeutralPFlow
          if (constit != nullptr && ((constit->signalType() & xAOD::FlowElement::PFlow) || constit->signalType() == xAOD::FlowElement::Charged)) {
        if (constit->isCharged()) {
          const xAOD::TrackParticle *thisTrack = dynamic_cast<const xAOD::TrackParticle *>( constit->chargedObject( 0)); // PFO should have only 1 track
          if (thisTrack != nullptr) {
            trackKey.emplace_back(DataType(thisTrack->index()));
            trackContKey.emplace_back(m_tracksName.value());
            trackcounter++;
          }
          else
            ATH_MSG_WARNING( "Charged PFO had no associated TrackParticle");
        } // We have a charged PFO
          }   // The FlowElement is a PFO
        }     // Loop on jet constituents
      } else if (ctype == xAOD::Type::CaloCluster) {
        // get associated cluster
        for (size_t j = 0; j < numConstit; ++j) {
          const xAOD::CaloCluster *cluster = dynamic_cast<const xAOD::CaloCluster *>(jet->rawConstituent(j));
          clusterID.emplace_back(DataType(cluster->index()));
          if(!cluster->getCellLinks())continue;
          for (const auto cc : *(cluster->getCellLinks())) {
        if (std::find(tempCellID.begin(), tempCellID.end(), std::to_string( cc->caloDDE()->identify().get_compact())) != tempCellID.end()) {
          continue;
        } else {
          cellID.emplace_back( DataType(cc->caloDDE()->identify().get_compact()));
          tempCellID.emplace_back( std::to_string(cc->caloDDE()->identify().get_compact()));
        }
          }
          ATH_MSG_VERBOSE("  Associated cluster: eta = " << cluster->eta() << ", phi = " << cluster->phi());
        }
        // get ghost associated tracks
        std::vector<const xAOD::TrackParticle*> ghosttracks;
        jet->getAssociatedObjects<xAOD::TrackParticle>(xAOD::JetAttribute::GhostTrack, ghosttracks);
        if (ghosttracks.empty()) {
          ATH_MSG_VERBOSE("  Associated track: ERROR");
        } else {
          for (size_t i = 0; i < ghosttracks.size(); i++) {
 
        // can access the base track class, should be able to get tracker hits ?
        // const Trk::Track* baseTrack = dynamic_cast< const Trk::Track* >( ghosttracks[i]->track());
 
        trackKey.emplace_back(DataType(ghosttracks[i]->index()));
        trackContKey.emplace_back(m_tracksName.value());
 
        ATH_MSG_VERBOSE("  Associated track: d0 = " << ghosttracks[i]->d0() << ", pt = " << ghosttracks[i]->pt());
          }
          trackcounter = ghosttracks.size();
        }
      } else if (ctype == xAOD::Type::TrackParticle) {
        for (size_t j = 0; j < numConstit; ++j) {
          const xAOD::TrackParticle *track =
        dynamic_cast<const xAOD::TrackParticle *>(jet->rawConstituent(j));
          if (!track) {
        ATH_MSG_VERBOSE("  Associated track: ERROR");
          } else {
        trackKey.emplace_back(DataType(track->index()));
        trackContKey.emplace_back(m_tracksName.value());
        trackcounter++;
        ATH_MSG_VERBOSE("  Associated track: d0 = " << track->d0() << ", pt = " << track->pt());
          }
        }
      }
    }
      }
      trackLinkCount.emplace_back(DataType(trackcounter));
      numCells.emplace_back(DataType(tempCellID.size()));
 
 
      phi.emplace_back(DataType(jet->phi()));
      eta.emplace_back(DataType(jet->eta()));
      et.emplace_back(DataType(jet->pt()/GeV)); // hack ! no et in xAOD_Jet_v1 currently
      idVec.emplace_back( DataType( ++id ));
 
      mass.emplace_back(DataType(jet->m()/GeV));
      energy.emplace_back( DataType(jet->e()/GeV ) );
 
      px.emplace_back(DataType(jet->px()/GeV));
      py.emplace_back(DataType(jet->py()/GeV));
      pz.emplace_back(DataType(jet->pz()/GeV));
 
      // bjet tagger values
      if (jetkey!="AntiKt4EMPFlowJets" || (m_nTaggers==0)){
    bTagName.emplace_back(DataType("None"));
    bTagValue.emplace_back(DataType(0.));
      }else{
    double btagValue;
    for (auto taggerName : m_bTaggerNames) {
      CP::CorrectionCode code = m_btagSelTools[taggerName]->getTaggerWeight(*jet, btagValue);
      if (code != CP::CorrectionCode::Ok) {
        ATH_MSG_DEBUG("Failed to get btagging weight for tagger " << taggerName);
        btagValue = 0;
      }
      bTagName.emplace_back(DataType(taggerName));
      bTagValue.emplace_back(DataType(btagValue));
    }
      }
 
      float chargeread;
      if (!jet->getAttribute<float>(xAOD::JetAttribute::Charge, chargeread)) {
    ATH_MSG_DEBUG("Jet charge unavailable!");
    charge.emplace_back( DataType( 0. ));
      }else{
    charge.emplace_back( DataType( chargeread ));
      }
 
      // updated for data15
      // from: Reconstruction/MET/METReconstruction/Root/METJetFilterTool.cxx
      std::vector<float> jvfread;
      if(!jet->getAttribute<std::vector<float> >(xAOD::JetAttribute::JVF,jvfread)) {
    ATH_MSG_DEBUG("Jet JVF unavailable!");
    jvf.emplace_back( DataType( 1. ));
      }else{
    jvf.emplace_back( DataType(  jvfread[0] ));
      }
 
      float jvtread;
      if(!jet->getAttribute<float>(xAOD::JetAttribute::Jvt,jvtread)) {
    ATH_MSG_DEBUG("Jet JVT unavailable!");
    jvt.emplace_back(DataType(0.));
      } else {
    jvt.emplace_back(DataType(jvtread));
      }
 
      float emfracread = 0;
      if(!jet->getAttribute(xAOD::JetAttribute::EMFrac,emfracread)) {
    ATH_MSG_DEBUG("Jet EMFrac unavailable!");
    emfrac.emplace_back( DataType( 0. ));
      }else{
    emfrac.emplace_back( DataType( emfracread ));
      }
 
    } // end loop
 
    // four-vectors
    DataMap["phi"] = phi;
    DataMap["eta"] = eta;
    DataMap["et"] = et;
    DataMap["energy"] = energy;
    DataMap["mass"] = mass;
    std::string str_nTaggers = m_nTaggers>0 ? std::to_string(m_nTaggers) : "1"; // default to 1 if no btaggers so that atlantis can process the jets properly
    DataMap["bTagName multiple=\""+str_nTaggers+"\""] = bTagName; // assigned by hand !
    DataMap["bTagValue multiple=\""+str_nTaggers+"\""] = bTagValue;
    DataMap["charge"] = charge;
    DataMap["id"] = idVec;
    DataMap["px"] = px;
    DataMap["py"] = py;
    DataMap["pz"] = pz;
    DataMap["jvf"] = jvf;
    DataMap["jvt"] = jvt;
    DataMap["emfrac"] = emfrac;
 
    if ((trackKey.size()) != 0){
      double NTracksPerVertex = trackKey.size()*1./jetCont->size();
      std::string tag = "trackIndex multiple=\"" +DataType(NTracksPerVertex).toString()+"\"";
      DataMap[tag] = trackKey;
      tag = "trackKey multiple=\"" +DataType(NTracksPerVertex).toString()+"\"";
      DataMap[tag] = trackContKey;
    }
 
    if ((clusterID.size())!=0){
      std::string tag = "clusterIndex multiple=\"" + DataType(clusterID.size()).toString()+"\"";
      double NCellsPerJet = cellID.size()*1./jetCont->size();
      tag = "cells multiple=\"" +DataType(NCellsPerJet).toString()+"\"";
      DataMap[tag]=cellID;
    }
 
    DataMap["trackLinkCount"] = trackLinkCount;
    DataMap["numCells"] = numCells;
 
    ATH_MSG_DEBUG( dataTypeName() << " retrieved with " << phi.size() << " entries" );
 
    return DataMap;
  }

getKeys()

const std::vector< std::string > JiveXML::xAODJetRetriever::getKeys

(

)

Gets the StoreGate keys for the desired containers.

Definition at line 329 of file xAODJetRetriever.cxx.

                                                       {
 
    ATH_MSG_DEBUG("in getKeys()");
 
    std::vector<std::string> keys = {};
 
    // Remove m_priorityKey from m_otherKeys if it exists, we don't want to write it twice
    auto it = std::find(m_otherKeys.begin(), m_otherKeys.end(), m_priorityKey);
    if(it != m_otherKeys.end()){
      m_otherKeys.erase(it);
    }
 
    // Add m_priorityKey as the first element if it is not ""
    if(m_priorityKey!=""){
      keys.push_back(m_priorityKey);
    }
 
    if(!m_otherKeys.empty()){
      keys.insert(keys.end(), m_otherKeys.begin(), m_otherKeys.end());
    }
 
    // If all collections are requested, obtain all available keys from StoreGate
    std::vector<std::string> allKeys;
    if(m_doWriteAllCollections){
      evtStore()->keys<xAOD::JetContainer>(allKeys);
 
      // Add keys that are not the priority key and do not add containers with "HLT" in their name if requested
      for(const std::string& key : allKeys){
    // Don't include key if it's already in keys
    auto it2 = std::find(keys.begin(), keys.end(), key);
    if(it2 != keys.end())continue;
    if(key.find("HLT") == std::string::npos || m_doWriteHLT){
      keys.emplace_back(key);
    }
      }
    }
    return keys;
  }

initialize()

StatusCode JiveXML::xAODJetRetriever::initialize ( )

virtual

Definition at line 28 of file xAODJetRetriever.cxx.

                                          {
    if (m_bTaggerNames.size()!=m_CDIPaths.size()){
      ATH_MSG_WARNING("Number of btaggers and CDI files do not match. Will not retrieve b-tagging information.");
      return StatusCode::SUCCESS;
    } else {
      m_nTaggers = m_bTaggerNames.size();
    }
    for (unsigned int i=0; i<m_nTaggers; i++){
      std::string taggerName = m_bTaggerNames[i];
      asg::AnaToolHandle<IBTaggingSelectionTool> btagSelTool;
      btagSelTool.setTypeAndName("BTaggingSelectionTool/btagSelTool_"+taggerName);
      ATH_CHECK(btagSelTool.setProperty("TaggerName", taggerName));
      ATH_CHECK(btagSelTool.setProperty("JetAuthor", "AntiKt4EMPFlowJets")); // only AntiKt4EMPFlowJets is supported
      ATH_CHECK(btagSelTool.setProperty("OperatingPoint", "FixedCutBEff_70")); // the working point doesn't matter because we don't cut on the tagger discriminant, but it must exist in CDI.
      ATH_CHECK(btagSelTool.setProperty("FlvTagCutDefinitionsFileName", m_CDIPaths[i]));
      ATH_CHECK(btagSelTool.setProperty( "MinPt", 0.0));
      ATH_CHECK(btagSelTool.initialize());
      m_btagSelTools.emplace(taggerName, btagSelTool);
    }
 
    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.

interfaceID()

const InterfaceID & JiveXML::IDataRetriever::interfaceID ( )

inlinestaticinherited

Return the interface identifier.

Definition at line 40 of file IDataRetriever.h.

{ return IID_IDataRetriever; }

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);
  }

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.

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();
  }

retrieve()

StatusCode JiveXML::xAODJetRetriever::retrieve ( ToolHandle< IFormatTool > &  FormatTool )

virtual

For each jet collections retrieve basic parameters.

Parameters

FormatTool

the tool that will create formated output from the DataMap

Implements JiveXML::IDataRetriever.

Definition at line 55 of file xAODJetRetriever.cxx.

                                                                           {
 
    ATH_MSG_DEBUG( "in retrieve()" );
 
    std::vector<std::string> keys = getKeys();
 
    if(keys.empty()){
      ATH_MSG_WARNING("No StoreGate keys found");
      return StatusCode::SUCCESS;
    }
 
    // Loop through the keys and retrieve the corresponding data
    for (const std::string& key : keys) {
      SG::ReadHandle<xAOD::JetContainer> cont(key);
      if(cont.isValid()){
    DataMap data = getData(&(*cont), key);
    if (FormatTool->AddToEvent(dataTypeName(), key + "_xAOD", &data).isFailure()) {
      ATH_MSG_WARNING("Failed to retrieve Collection " << key);
    } else {
      ATH_MSG_DEBUG(" (" << key << ") retrieved");
    }
      }
      else {
    ATH_MSG_WARNING("Collection " << key << " not found in SG");
      }
    }
    return StatusCode::SUCCESS;
  }

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_bTaggerNames

Gaudi::Property<std::vector<std::string> > JiveXML::xAODJetRetriever::m_bTaggerNames

private

Initial value:

{
      this, "BTaggerNames", {"DL1dv01", "GN2v01"}, "Names of the b-taggers to be retrieved"}

Definition at line 73 of file xAODJetRetriever.h.

m_btagSelTools

std::unordered_map<std::string, asg::AnaToolHandle<IBTaggingSelectionTool> > JiveXML::xAODJetRetriever::m_btagSelTools

private

Definition at line 78 of file xAODJetRetriever.h.

m_CDIPaths

Gaudi::Property<std::vector<std::string> > JiveXML::xAODJetRetriever::m_CDIPaths

private

Initial value:

{
      this, "CDIPaths", {"xAODBTaggingEfficiency/13p6TeV/2023-22-13p6TeV-MC21-CDI_Test_2023-08-1_v1.root", "xAODBTaggingEfficiency/13p6TeV/2023-02_MC23_CDI_GN2v01-noSF.root"}, "Paths to the CDI files storing the b-tagger properties"}

Definition at line 75 of file xAODJetRetriever.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_doWriteAllCollections

Gaudi::Property<bool> JiveXML::xAODJetRetriever::m_doWriteAllCollections {this, "DoWriteAllCollections", false, "Write out all Jet collections"}

private

Definition at line 64 of file xAODJetRetriever.h.

m_doWriteHLT

Gaudi::Property<bool> JiveXML::xAODJetRetriever::m_doWriteHLT {this, "DoWriteHLT", false, "Write out other collections that have HLT in the name"}

private

Definition at line 63 of file xAODJetRetriever.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_nTaggers

unsigned int JiveXML::xAODJetRetriever::m_nTaggers =0

private

Definition at line 79 of file xAODJetRetriever.h.

m_otherKeys

Gaudi::Property<std::vector<std::string> > JiveXML::xAODJetRetriever::m_otherKeys {this, "OtherJetCollections", {"AntiKt4EMTopoJets", "AntiKt4LCTopoJets", "AntiKt10LCTopoJets", "AntiKt10UFOCSSKJets"}, "Other collections to be retrieved. If DoWriteAllCollections is set to true all available Jet collections will be retrieved"}

private

Definition at line 67 of file xAODJetRetriever.h.

m_priorityKey

Gaudi::Property<std::string> JiveXML::xAODJetRetriever::m_priorityKey {this,"PriorityJetCollection","AntiKt4TopoEMJets", "Name of the priority Jet container that will be written out first"}

private

Definition at line 68 of file xAODJetRetriever.h.

m_tracksName

Gaudi::Property<std::string> JiveXML::xAODJetRetriever::m_tracksName

private

Initial value:

{
      this, "TracksName", "InDetTrackParticles_xAOD", "Name of the track container to be retrieved"}

Definition at line 71 of file xAODJetRetriever.h.

m_typeName

const std::string JiveXML::xAODJetRetriever::m_typeName = "Jet"

private

The data type that is generated by this retriever.

Definition at line 61 of file xAODJetRetriever.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.

m_writeJetQuality

Gaudi::Property<bool> JiveXML::xAODJetRetriever::m_writeJetQuality

private

Initial value:

{
      this, "WriteJetQuality", false, "Write out extended jet quality information. False by default."}

Definition at line 69 of file xAODJetRetriever.h.

---

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

• xAODJetRetriever.h
• xAODJetRetriever.cxx