#include <JetPseudojetCopier.h>

Inheritance diagram for JetPseudojetCopier:

Collaboration diagram for JetPseudojetCopier:

Public Member Functions
	JetPseudojetCopier (const std::string &myname)
	Ctor from tool name.
StatusCode	initialize ()
	Intialization.
int	copy (const xAOD::JetContainer &srcjets, const xAOD::JetContainer &dstjets, const std::string &label="PseudojetMap") const
	Copy pseudojets from srcjets to dstjets.
int	copy (const xAOD::JetContainer &srcjets, const std::string &dstname, const std::string &label="PseudojetMap") const
	Copy the pseudojets from srcjets to container with name dstname.
int	process (const xAOD::JetContainer &srcjets) const
	Copy the pseudojets from srcjets to dstjets.
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
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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::string	m_dstname
	Properties.
std::string	m_label
ToolHandle< IJetPseudojetRetriever >	m_hpjr
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

Author: Pierre-Antoine Delsart and David Adams

Date: November 2014

Copy the pseudojets from one jet container to another. This enables the rebuilding of a container read from file so it can be used as input to grooming or other tools that mase use of the fastjet cluster sequence.

Properties: DestinationContainer: Name of the jet container to which the current pseudojets are associated. Label: Label for this pseudojet mapping (SG name for the map).

Definition at line 32 of file JetPseudojetCopier.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

◆ JetPseudojetCopier()

JetPseudojetCopier::JetPseudojetCopier ( const std::string & myname )

Ctor from tool name.

Definition at line 57 of file JetPseudojetCopier.cxx.

  : asg::AsgTool(name), m_hpjr("",this)  {
  declareProperty("DestinationContainer", m_dstname);
  declareProperty("Label", m_label ="JetPseudojetMap");
  declareProperty("JetPseudojetRetriever", m_hpjr);
}

Member Function Documentation

◆ copy() [1/2]

int JetPseudojetCopier::copy	(	const xAOD::JetContainer &	srcjets,
		const std::string &	dstname,
		const std::string &	label = "PseudojetMap" ) const

Copy the pseudojets from srcjets to container with name dstname.

Definition at line 151 of file JetPseudojetCopier.cxx.

                                                                                              {
  const xAOD::JetContainer* pdstjets;
  if ( ! evtStore()->retrieve(pdstjets, dstname).isSuccess() ) {
    ATH_MSG_WARNING("Unable to retrieve destination jet container.");
    return 1;
  }
  return copy(srcjets, *pdstjets, pjmapname);
}

◆ copy() [2/2]

int JetPseudojetCopier::copy	(	const xAOD::JetContainer &	srcjets,
		const xAOD::JetContainer &	dstjets,
		const std::string &	label = "PseudojetMap" ) const

Copy pseudojets from srcjets to dstjets.

Definition at line 76 of file JetPseudojetCopier.cxx.

                                                                                              {
 
  if ( ! m_hpjr.retrieve().isSuccess() ) {
    ATH_MSG_WARNING("Unable to retrieve jet pseudojet retriever.");
    return 1;
  }
 
  // Check map used to store pseudojets.
  PseudoJetMap* ppjmap;
  if ( ! evtStore()->contains<PseudoJetMap>(pjmapname) ) {
    if ( ! evtStore()->record(new PseudoJetMap, pjmapname).isSuccess() ) {
      ATH_MSG_ERROR("Unable to create pseudojet map.");
    }
  }
  if ( ! evtStore()->retrieve(ppjmap, pjmapname).isSuccess() ) {
    ATH_MSG_WARNING("Unable to retrieve pseudojet map.");
    return 1;
  }
  PseudoJetMap& pjmap = *ppjmap;
  
  ATH_MSG_DEBUG("Copying...     source size=" << srcjets.size());
  ATH_MSG_DEBUG("          destination size=" << dstjets.size());
 
  // build sorted list
  // (sorting by constit scale pt -> almost 1-to-1 matching
  // between source and target containers. This renders the matching loops
  // below faster).
  std::list<const Jet*> sortedTarget(dstjets.begin(), dstjets.end());
  sortedTarget.sort(ConstitPtComp());
  std::list<const Jet*> sortedSource(srcjets.begin(), srcjets.end());
  sortedSource.sort(ConstitPtComp());
 
  size_t sourceIndex=0;
  // Loop over source jets 
  for ( auto sourceIt = sortedSource.begin(); sourceIt!=sortedSource.end(); ++sourceIt ) {
    const Jet* pjetin = *sourceIt;
    if ( pjetin == nullptr ) {
      ATH_MSG_WARNING("Skipping missing input jet.");
      continue;
    }
    ATH_MSG_DEBUG("   Checking jet " << sourceIndex << "   pt=" << ptAcc(*pjetin) );
    // find a matching jet in the target container
    //first remove null pointers
    sortedTarget.remove_if([](const Jet * pJetOut){return pJetOut == nullptr;});
    //
    for ( auto targetIt=sortedTarget.begin(); targetIt!=sortedTarget.end(); ++targetIt ) {
      const Jet* pjetout = *targetIt;
      int jetdiff = differentJets(pjetin, pjetout);
      bool isSame = jetdiff == 0;
      ATH_MSG_DEBUG("            vs     pt="<<ptAcc(*pjetout) << " jetdiff= " << jetdiff );    
      if ( isSame ){ // found a jet 
        ATH_MSG_DEBUG(" -------> identical to pt="<< ptAcc(*pjetout));
        const PseudoJet* ppj = m_hpjr->pseudojet(*pjetin);
        ATH_MSG_VERBOSE("Recording pseudojet " << long(ppj) << " for jet " << long(pjetout)
                        << " in map " << pjmapname);
        pjmap[pjetout] = ppj;
        // remove target from list to reduce next search length.
        sortedTarget.erase(targetIt); //the returned iterator is unused, as the loop is terminated
        break;
      }
      ATH_MSG_VERBOSE("No match found for destination jet " << long(pjetout));
    } // end target loop
 
    auto targetIt = sortedTarget.begin(); // re-start from start
    ATH_MSG_DEBUG("   Checking jet " << sourceIndex << "   done" );
    if ( targetIt == sortedTarget.end() ) break; // no more target left.   
    ++sourceIndex;
  }
 
  return 0;
}

◆ 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

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

virtual

Intialization.

Reimplemented from asg::AsgTool.

Definition at line 66 of file JetPseudojetCopier.cxx.

                                          {
  if ( ! m_hpjr.retrieve().isSuccess() ) {
    ATH_MSG_ERROR("Unable to retrieve jet pseudojet retriever.");
    return StatusCode::FAILURE;
  }
  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, KtDeltaRTool, and LundVariablesTool.

Definition at line 131 of file AsgTool.cxx.

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

◆ process()

int JetPseudojetCopier::process ( const xAOD::JetContainer & srcjets ) const

virtual

Copy the pseudojets from srcjets to dstjets.

Return 0 for success.

Implements IJetConsumer.

Definition at line 163 of file JetPseudojetCopier.cxx.

                                                                 {
  return copy(srcjets, m_dstname, m_label);
}

◆ 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_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_dstname

std::string JetPseudojetCopier::m_dstname

private

Properties.

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

ToolHandle<IJetPseudojetRetriever> JetPseudojetCopier::m_hpjr

private

Definition at line 63 of file JetPseudojetCopier.h.

◆ m_label

std::string JetPseudojetCopier::m_label

private

Definition at line 62 of file JetPseudojetCopier.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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ JetPseudojetCopier()

Member Function Documentation

◆ copy() [1/2]

◆ copy() [2/2]

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ process()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_dstname

◆ m_evtStore

◆ m_hpjr

◆ m_label

◆ m_varHandleArraysDeclared

◆ m_vhka