JetGrooming::RecSoftDrop Class Reference

A specialized SoftDrop tool wrapping fastjet::contrib::RecursiveSoftDrop. More...

#include <JetSoftDropTools.h>

Inheritance diagram for JetGrooming::RecSoftDrop:

Collaboration diagram for JetGrooming::RecSoftDrop:

Public Member Functions
StatusCode	initialize () override final
	Dummy implementation of the initialisation function.
virtual void	insertGroomedJet (const xAOD::Jet &, const PseudoJetContainer &, xAOD::JetContainer &, PseudoJetVector &) const override final
virtual std::pair< std::unique_ptr< xAOD::JetContainer >, std::unique_ptr< SG::IAuxStore > >	getJets () const override final
	Method to build the collection and return it to the caller.
	AsgTool (const std::string &name)
	Constructor specifying the tool instance's name.
	AsgTool (const AsgTool &)=delete
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
StatusCode	getAndRecordJets (SG::WriteHandle< xAOD::JetContainer > &jetHandle) const
	Method to allow the client to pass in a WriteHandle for the container and aux container to be recorded, while the client remains free to modify the output but does not need to know the type of the aux container.
virtual StatusCode	initWithOutput (const SG::WriteHandleKey< xAOD::JetContainer > &)
	Method to allow the client to pass in a WriteHandle during initialisation, in case this is needed for anything...
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	setSoftDropAttributes (xAOD::Jet &groomedjet, int nsdsubjets) 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.

Protected Attributes
Gaudi::Property< float >	m_zcut {this, "ZCut", 0.1 , "pT fraction for retaining subjets"}
Gaudi::Property< float >	m_beta {this, "Beta", 0.0, "How much to consider angular dependence"}
Gaudi::Property< float >	m_R0 {this, "R0", 1.0, "Normalization of angular distance, usually the characteristic jet radius (default R0 = 1)"}
Gaudi::Property< bool >	m_saveSDatt {this, "SaveSoftDropAttributes",false, ""}
SG::ReadHandleKey< xAOD::JetContainer >	m_inputJetContainer {this, "UngroomedJets", "ungroomedinput", "Input ungroomed jet container"}
	Handle Input JetContainer (this contains the parent ungroomed jets to be trimmed)
SG::ReadHandleKey< PseudoJetContainer >	m_inputPseudoJets {this, "ParentPseudoJets", "inputpseudojet", "input constituents of parent JetContainer"}
	This is the input to the parent JetContainer. It is needed in order to re-assign the ghost constituents from the final groomed PJ to the xAOD::Jet.
SG::WriteHandleKey< PseudoJetVector >	m_finalPseudoJets {this, "FinalPseudoJets_DONOTSET", "", "output pseudojets -- autoconfigured name"}

Private Attributes
Gaudi::Property< int >	m_N {this, "N", 1 , "Number of layers (-1 <> infinite)"}

Detailed Description

A specialized SoftDrop tool wrapping fastjet::contrib::RecursiveSoftDrop.

Definition at line 64 of file JetSoftDropTools.h.

Member Function Documentation

AsgTool() [1/2]

asg::AsgTool::AsgTool ( const AsgTool & )

deleteinherited

AsgTool() [2/2]

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

inherited

Constructor specifying the tool instance's name.

Definition at line 51 of file AsgTool.cxx.

      : AsgToolBase(
#ifndef XAOD_STANDALONE
                    ::getType(name), ::getName(name), ::getParent(name)
#else // not XAOD_STANDALONE
                    name
#endif // not XAOD_STANDALONE
                    )
#ifdef XAOD_STANDALONE
      , m_event()
#endif // XAOD_STANDALONE
   {
      ToolStore::put( this ).ignore(); // Register the tool in the ToolStore
   }

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

getAndRecordJets()

StatusCode JetProvider< xAOD::JetAuxContainer >::getAndRecordJets ( SG::WriteHandle< xAOD::JetContainer > & jetHandle ) const

inlinevirtualinherited

Method to allow the client to pass in a WriteHandle for the container and aux container to be recorded, while the client remains free to modify the output but does not need to know the type of the aux container.

Every class derived from IJetProvider needs to implement the record, providing the explicit type – we should give StoreGate maximal information rather than recording AuxContainerBase

The recommended solution is for the concrete tool to inherit from the templated JetProvider class provided below.

Implements IJetProvider.

Definition at line 81 of file IJetProvider.h.

                                                                                {
    std::unique_ptr<xAOD::JetContainer> jets(nullptr);
    std::unique_ptr<SG::IAuxStore> auxCont(nullptr);
    std::tie(jets, auxCont) = getJets();
    if(jets.get()==nullptr || auxCont.get()==nullptr) {return StatusCode::FAILURE;}
 
    // Convert the aux container pointer to the known base class
    std::unique_ptr<CONCRETEAUX> auxCont_derived(static_cast<CONCRETEAUX*>(auxCont.release()));
 
    // Write out JetContainer and JetAuxContainer
    return jetHandle.record(std::move(jets), std::move(auxCont_derived));
  }

getJets()

std::pair< std::unique_ptr< xAOD::JetContainer >, std::unique_ptr< SG::IAuxStore > > JetGroomer::getJets ( ) const

finaloverridevirtualinherited

Method to build the collection and return it to the caller.

Unique_ptrs are used to avoid potential memory leaks. The aux container is returned as an IAuxStore pointer to support operations such as shallow copy.

Implements IJetProvider.

Definition at line 43 of file JetGroomer.cxx.

                                                                                               {
  // Return this in case of any problems
  auto nullreturn = std::make_pair(std::unique_ptr<xAOD::JetContainer>(nullptr), std::unique_ptr<SG::IAuxStore>(nullptr));
 
  // -----------------------
  // retrieve input
  SG::ReadHandle<xAOD::JetContainer> jetContHandle(m_inputJetContainer);
  if(!jetContHandle.isValid()) {
    ATH_MSG_ERROR("No valid JetContainer with key "<< m_inputJetContainer.key());
    return nullreturn;
  }
 
  SG::ReadHandle<PseudoJetContainer> pjContHandle(m_inputPseudoJets);
  if(!pjContHandle.isValid()) {
    ATH_MSG_ERROR("No valid PseudoJetContainer with key "<< m_inputPseudoJets.key());
    return nullreturn;
  }
 
  // Build the container to be returned
  // Avoid memory leaks with unique_ptr
  auto groomedJets = std::make_unique<xAOD::JetContainer>();
  auto auxCont = std::make_unique<xAOD::JetAuxContainer>();
  groomedJets->setStore(auxCont.get());
 
  // -----------------------
  // Build a new pointer to a PseudoJetVector containing the final groomed PseudoJets
  // This allows us to own the vector of PseudoJet which we will put in the evt store.
  // Thus the contained PseudoJet will be kept frozen there and we can safely use pointer to them from the xAOD::Jet objects
  auto groomPJVector = std::make_unique<PseudoJetVector>( );
  groomPJVector->resize( jetContHandle->size() );
 
  // loop over input jets
  for (const xAOD::Jet* parentJet: *jetContHandle){
    // Child will create a groomed jet and insert it into the output container
    this->insertGroomedJet(*parentJet, *pjContHandle, *groomedJets, *groomPJVector);
  }
 
  // -------------------------------------
  // record final PseudoJetVector
  SG::WriteHandle<PseudoJetVector> pjVectorHandle(m_finalPseudoJets);
  if(!pjVectorHandle.record(std::move(groomPJVector))){
    ATH_MSG_ERROR("Can't record PseudoJetVector under key "<< m_finalPseudoJets);
    return nullreturn;
  }
 
  return std::make_pair(std::move(groomedJets),std::move(auxCont));
}

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 RecSoftDrop::initialize ( void )

finaloverridevirtual

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 JetGrooming::JetGroomer.

Definition at line 76 of file JetSoftDropTools.cxx.

                                   {
  ATH_CHECK( SoftDrop::initialize() );  
  CHECK_VAR_RANGE("N", m_N, (m_zcut>-1) );
  return StatusCode::SUCCESS;
}

initWithOutput()

virtual StatusCode IJetProvider::initWithOutput ( const SG::WriteHandleKey< xAOD::JetContainer > & )

inlinevirtualinherited

Method to allow the client to pass in a WriteHandle during initialisation, in case this is needed for anything...

The main (only?) use case is for copying jets, and propagating any decorations already on the original to the copy in StoreGate

Quietly return success in the general case – the JetRecAlg will always call this, so as to remain agnostic as to the concrete type.

Reimplemented in JetCopier.

Definition at line 65 of file IJetProvider.h.

{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.

insertGroomedJet()

void RecSoftDrop::insertGroomedJet ( const xAOD::Jet & parentjet, const PseudoJetContainer & inpjcont, xAOD::JetContainer & outcont, PseudoJetVector & groomedpjvec ) const

finaloverridevirtual

Reimplemented from JetGrooming::SoftDrop.

Definition at line 109 of file JetSoftDropTools.cxx.

                                                                                                                                                               {
 
  //configure recursive soft drop tool
  //https://fastjet.hepforge.org/trac/browser/contrib/contribs/RecursiveTools/tags/2.0.0-beta1
  fastjet::contrib::RecursiveSoftDrop softdropper(m_beta, m_zcut, m_N, m_R0);
 
  xAOD::Jet & jet = buildAndInsertSDJet(softdropper,
                    parentjet, inpjcont, outcont, groomedpjvec);
  
  if(m_saveSDatt) {
    setSoftDropAttributes(jet, groomedpjvec[jet.index()].pieces().size() );
    jet.setAttribute<int>("RSoftDropN", m_N);
  }
}

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, KtDeltaRTool, and LundVariablesTool.

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

setSoftDropAttributes()

void SoftDrop::setSoftDropAttributes ( xAOD::Jet & groomedjet, int nsdsubjets ) const

protectedinherited

Definition at line 97 of file JetSoftDropTools.cxx.

                                                                              {
  groomedjet.setAttribute<float>("ZCut", m_zcut);
  groomedjet.setAttribute<float>("SoftDropBeta", m_beta);
  groomedjet.setAttribute<float>("SoftDropR0", m_R0);
  groomedjet.setAttribute<int>("NSoftDropSubjets", nsdsubjets);
}

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_beta

Gaudi::Property<float> JetGrooming::SoftDrop::m_beta {this, "Beta", 0.0, "How much to consider angular dependence"}

protectedinherited

Definition at line 52 of file JetSoftDropTools.h.

{this, "Beta", 0.0, "How much to consider angular dependence"};

m_finalPseudoJets

SG::WriteHandleKey<PseudoJetVector> JetGrooming::JetGroomer::m_finalPseudoJets {this, "FinalPseudoJets_DONOTSET", "", "output pseudojets -- autoconfigured name"}

protectedinherited

Definition at line 60 of file JetGroomer.h.

{this, "FinalPseudoJets_DONOTSET", "", "output pseudojets -- autoconfigured name"};

m_inputJetContainer

SG::ReadHandleKey<xAOD::JetContainer> JetGrooming::JetGroomer::m_inputJetContainer {this, "UngroomedJets", "ungroomedinput", "Input ungroomed jet container"}

protectedinherited

Handle Input JetContainer (this contains the parent ungroomed jets to be trimmed)

Definition at line 55 of file JetGroomer.h.

{this, "UngroomedJets", "ungroomedinput", "Input ungroomed jet container"};

m_inputPseudoJets

SG::ReadHandleKey<PseudoJetContainer> JetGrooming::JetGroomer::m_inputPseudoJets {this, "ParentPseudoJets", "inputpseudojet", "input constituents of parent JetContainer"}

protectedinherited

This is the input to the parent JetContainer. It is needed in order to re-assign the ghost constituents from the final groomed PJ to the xAOD::Jet.

Definition at line 58 of file JetGroomer.h.

{this, "ParentPseudoJets", "inputpseudojet", "input constituents of parent JetContainer"};

m_N

Gaudi::Property<int> JetGrooming::RecSoftDrop::m_N {this, "N", 1 , "Number of layers (-1 <> infinite)"}

private

Definition at line 74 of file JetSoftDropTools.h.

{this, "N", 1 , "Number of layers (-1 <> infinite)"};     

m_R0

Gaudi::Property<float> JetGrooming::SoftDrop::m_R0 {this, "R0", 1.0, "Normalization of angular distance, usually the characteristic jet radius (default R0 = 1)"}

protectedinherited

Definition at line 53 of file JetSoftDropTools.h.

{this, "R0", 1.0, "Normalization of angular distance, usually the characteristic jet radius (default R0 = 1)"};

m_saveSDatt

Gaudi::Property<bool> JetGrooming::SoftDrop::m_saveSDatt {this, "SaveSoftDropAttributes",false, ""}

protectedinherited

Definition at line 55 of file JetSoftDropTools.h.

{this, "SaveSoftDropAttributes",false, ""};

m_zcut

Gaudi::Property<float> JetGrooming::SoftDrop::m_zcut {this, "ZCut", 0.1 , "pT fraction for retaining subjets"}

protectedinherited

Definition at line 51 of file JetSoftDropTools.h.

{this, "ZCut", 0.1 , "pT fraction for retaining subjets"}; 

---

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

• JetSoftDropTools.h
• JetSoftDropTools.cxx