JetFromPseudojet Class Reference

#include <JetFromPseudojet.h>

Inheritance diagram for JetFromPseudojet:

Collaboration diagram for JetFromPseudojet:

Public Member Functions
	JetFromPseudojet (const std::string &name)
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual xAOD::Jet *	add (const fastjet::PseudoJet &, const PseudoJetContainer &, xAOD::JetContainer &, xAOD::JetInput::Type inputtype) const override
	Method to construct an ATLAS jet from a pseudojet, input type and vector of ghost labels.
virtual xAOD::Jet *	add (const fastjet::PseudoJet &pj, const PseudoJetContainer &, xAOD::JetContainer &jets, const xAOD::Jet *pparent) const override
	Method to construct an ATLAS jet from a pseudojet and parent jet.
virtual void	print () const override
	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
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
xAOD::Jet *	addjet (const fastjet::PseudoJet &pj, const PseudoJetContainer &, xAOD::JetContainer &jets, const xAOD::Jet *pparent) const
void	buildAndSetEMScaleMom (xAOD::Jet *jet, xAOD::JetInput::Type inputtype) const
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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::vector< std::string >	m_atts
bool	m_doArea
bool	m_doFourVecArea
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 20 of file JetFromPseudojet.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

JetFromPseudojet()

JetFromPseudojet::JetFromPseudojet

(

const std::string &

name

)

Definition at line 31 of file JetFromPseudojet.cxx.

  :   AsgTool(name), m_doArea(false), m_doFourVecArea(false) {
  declareProperty("Attributes", m_atts);
 
}

Member Function Documentation

add() [1/2]

virtual xAOD::Jet * JetFromPseudojet::add ( const fastjet::PseudoJet & pj, const PseudoJetContainer & , xAOD::JetContainer & jets, xAOD::JetInput::Type inputtype ) const

overridevirtual

Method to construct an ATLAS jet from a pseudojet, input type and vector of ghost labels.

The new jet is put in the supplied container and is returned. Returns null for failure.

Implements IJetFromPseudojet.

add() [2/2]

virtual xAOD::Jet * JetFromPseudojet::add ( const fastjet::PseudoJet & pj, const PseudoJetContainer & , xAOD::JetContainer & jets, const xAOD::Jet * pparent ) const

overridevirtual

Method to construct an ATLAS jet from a pseudojet and parent jet.

The new jet is put in the supplied container and is returned. Returns null for failure.

Implements IJetFromPseudojet.

addjet()

xAOD::Jet * JetFromPseudojet::addjet ( const fastjet::PseudoJet & pj, const PseudoJetContainer & , xAOD::JetContainer & jets, const xAOD::Jet * pparent ) const

protected

Definition at line 140 of file JetFromPseudojet.cxx.

                                                         {
  ATH_MSG_VERBOSE("Creating jet from PseudoJet @ " << &pj);
  double  px = pj.px();
  double  py = pj.py();
  double  pz = pj.pz();
  double   e = pj.e();
  double   m = pj.m();
  double  pt = pj.pt();
  double eta = pj.eta();
  double phi = pj.phi_std();
  double p2 = px*px + py*py + pz*pz;
  double p = sqrt(p2);
  double dpovere = p/e - 1.0;
  if ( m < 0.0 ) {
    if ( dpovere > 1.e-6 ) {  // Worse than float rounding error
      ATH_MSG_WARNING("...........................");
      ATH_MSG_WARNING("Found jet with negative mass: E, p, m, p/E-1 = "
                   << e << ", " << p << ", " << m << ", " << p/e-1.0);
      ATH_MSG_WARNING(setw(12) << "px" << setw(12) << "py" << setw(12) << "pz"
                   << setw(12) << "E" << setw(12) << "p");
      ATH_MSG_WARNING(setw(12) << "---" << setw(12) << "---" << setw(12) << "---"
                   << setw(12) << "---" << setw(12) << "---");
      const PseudoJetVector cons = pj.constituents();
      for ( PseudoJetVector::const_iterator icon=cons.begin(); icon!=cons.end(); ++icon ) {
        double cpx = icon->px();
        double cpy = icon->py();
        double cpz = icon->pz();
        double  ce = icon->e();
        double cp2 = cpx*cpx + cpy*cpy + cpz*cpz;
        double cp = sqrt(cp2);
        ATH_MSG_WARNING(setw(12) << int(cpx) << setw(12) << int(cpy) << setw(12) << int(cpz)
                     << setw(12) << int(ce) << setw(12) << int(cp));
      }
      ATH_MSG_WARNING("...........................");
    } else {  // Rounding error
      m = 0.0;
    }
  }
  ATH_MSG_VERBOSE("  Jet has pT = " << pt << " MeV, m = " << m << " MeV, eta = " << eta );
                  //<< ", area = " << area << ", FV area pT = " << fvarea.Pt() << " MeV");
  xAOD::Jet* pjet = new xAOD::Jet();
  jets.push_back(pjet);
  pjet->setJetP4( xAOD::JetFourMom_t(pt,eta,phi,m) );
 
  if ( pj.associated_cluster_sequence() == nullptr ) {
    ATH_MSG_VERBOSE("Pseudojet does not have a cluster sequence and so cannot be copied to Jet.");
  }
  pjet->setPseudoJet(&pj);
 
  // Record the jet-finding momentum, i.e. the one used to find/groom the jet.
  pjet->setJetP4(xAOD::JetConstitScaleMomentum, pjet->jetP4());
 
  if ( m_doArea || m_doFourVecArea ) {
    if ( pj.has_area() ) {
      if ( m_doArea ) {
        pjet->setAttribute("ActiveArea", pj.area());
        ATH_MSG_VERBOSE("Recording jet area: " << pj.has_area());
      }
      if ( m_doFourVecArea ) {
        fastjet::PseudoJet pja = pj.area_4vector();
        xAOD::JetFourMom_t fvarea(pja.pt(), pja.eta(), pja.phi(), pja.m());
        pjet->setAttribute("ActiveArea4vec", fvarea);
        ATH_MSG_VERBOSE("Recording jet four-vector area.");
      }
    } else {
      ATH_MSG_WARNING("Save of active area attribute requested for jet without area.");
    }
  } else {
    if ( pj.has_area() ) {
      ATH_MSG_VERBOSE("No area recorded for jet with area.");
    }
  }
 
  const PseudoJetVector pjcons = pj.constituents();
  ATH_MSG_VERBOSE("  Adding constituents: multiplicity is " << pjcons.size());
  if ( pparent != nullptr ) {
    ATH_MSG_VERBOSE("  Adding parent jet properties");
    const JetContainer* pcon = dynamic_cast<const JetContainer*>(pparent->container());
    if ( pcon == nullptr ) {
      ATH_MSG_WARNING("Unable to find parent jet container.");
    } else {
      ATH_MSG_VERBOSE("  Creating parent link.");
      ElementLink<JetContainer> el(*pcon, pparent->index());
      ATH_MSG_VERBOSE("  Setting parent.");
      pjet->setAttribute("Parent", el);
      //pjet->setAssociatedObject("Parent", pparent);
    }
    ATH_MSG_VERBOSE("  Setting input type from parent.");
    xAOD::JetInput::Type inputtype = pparent->getInputType();
    pjet->setInputType(inputtype);
    ATH_MSG_VERBOSE("  Setting algorithm type from parent.");
    pjet->setAlgorithmType(pparent->getAlgorithmType());
    ATH_MSG_VERBOSE("  Setting size parameter from parent.");
    pjet->setSizeParameter(pparent->getSizeParameter());
    ATH_MSG_VERBOSE("  Setting signal state from parent.");
    pjet->setConstituentsSignalState(pparent->getConstituentsSignalState());
    ATH_MSG_VERBOSE("  Setting ghost area from parent.");
    pjet->setAttribute("JetGhostArea", pparent->getAttribute<float>("JetGhostArea"));
 
    ATH_MSG_VERBOSE("  Setting EM scale momentum.");
    buildAndSetEMScaleMom(pjet, inputtype );
  }
  ATH_MSG_VERBOSE("Done add with parent");
  pjContainer.extractConstituents(*pjet, pj);
  return pjet;
}

buildAndSetEMScaleMom()

void JetFromPseudojet::buildAndSetEMScaleMom ( xAOD::Jet * jet, xAOD::JetInput::Type inputtype ) const

protected

Definition at line 55 of file JetFromPseudojet.cxx.

                                                        {
 
  if ( jet->getConstituentsSignalState() == xAOD::UncalibratedJetConstituent ) {
    // If constituents are already uncalibrated, the momentum is the same.
    jet->setJetP4(xAOD::JetEMScaleMomentum, jet->jetP4());
    ATH_MSG_DEBUG("  EM scale momentum set to jet scale");
  } else if (isValidConstitType(inputtype) || (inputtype == xAOD::JetInput::LCPFlow) || (inputtype == xAOD::JetInput::EMCPFlow)) {
    // fetch and sum the uncalibrated constituent momenta
    xAOD::JetConstituentVector vec = jet->getConstituents();
    if(! vec.isValid() ) {
      ATH_MSG_ERROR("Jet constituent vector is invalid. Can't set EM scale momentum");
      return;
    }
 
    xAOD::JetFourMom_t emscaleSum;
    xAOD::JetConstitScale uncal = xAOD::UncalibratedJetConstituent;
    // just sum 4-vectors:
    ATH_MSG_VERBOSE("  Summing four vectors.");
    for (auto it=vec.begin(uncal); it != vec.end(uncal); ++it) {
      emscaleSum +=**it;
    }
 
    ATH_MSG_VERBOSE("  Setting EM scale momentum");
    jet->setJetP4(xAOD::JetEMScaleMomentum, emscaleSum);
    ATH_MSG_DEBUG("  EM scale momentum set with uncalibrated constituents.");
 
  } else {
    ATH_MSG_DEBUG("  EM scale momentum not set.");
  }
 
}

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.

{ return m_detStore; }

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.

{ 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

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
   }

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 JetFromPseudojet::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 39 of file JetFromPseudojet.cxx.

                                        {
 
  for (const std::string & att : m_atts) {
    if      ( att == "ActiveArea" )     m_doArea = true;
    else if ( att == "ActiveArea4vec" ) m_doFourVecArea = true;
    else if ( att == "ActiveAreaFourVector" ) m_doFourVecArea = true;
    else ATH_MSG_WARNING("Unrecognized attribute name ignored: " << att);
  }
  ATH_MSG_INFO("  Record area: " << m_doArea);
  ATH_MSG_INFO("  Record four-vector area: " << m_doFourVecArea);
  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 JetFromPseudojet::print ( ) const

overridevirtual

Print the state of the tool.

Reimplemented from asg::AsgTool.

Definition at line 252 of file JetFromPseudojet.cxx.

                                   {
  ATH_MSG_INFO(" Attribute count: " << m_atts.size());
  for ( std::vector<std::string>::const_iterator inam=m_atts.begin();
        inam!=m_atts.end(); ++inam ) {
    const std::string& name = *inam;
    ATH_MSG_INFO("  " << name);
  }
}

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 >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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_atts

std::vector<std::string> JetFromPseudojet::m_atts

private

Definition at line 71 of file JetFromPseudojet.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_doArea

bool JetFromPseudojet::m_doArea

private

Definition at line 73 of file JetFromPseudojet.h.

m_doFourVecArea

bool JetFromPseudojet::m_doFourVecArea

private

Definition at line 74 of file JetFromPseudojet.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_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:

• JetFromPseudojet.h
• JetFromPseudojet.cxx