JetRecTool Class Reference

#include <JetRecTool.h>

Inheritance diagram for JetRecTool:

Public Member Functions
	JetRecTool (const std::string &myname)
StatusCode	initialize () override
	Initialization. Check all tools here.
virtual const xAOD::JetContainer *	build () const override
	Retrieve inputs with tools and construct new jet collection.
int	execute () const override
	Call build and put jets in event store.
void	print () const override
	Display the configuration.
int	inputContainerNames (std::vector< std::string > &connames) override
	Method to return the list of input containers.
int	outputContainerNames (std::vector< std::string > &connames) override
	Method to return the list of output containers.
void	setInputJetContainer (const xAOD::JetContainer *cont)
	For trigger usage in grooming mode only : give the input ungroomed jet container.
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
std::unique_ptr< xAOD::JetContainer >	fillOutputContainer () const
std::unique_ptr< PseudoJetContainer >	collectPseudoJets () const
const xAOD::JetContainer *	getOldJets () const
std::unique_ptr< xAOD::JetContainer >	makeOutputContainer () const
std::unique_ptr< xAOD::JetContainer >	findJets () const
std::unique_ptr< xAOD::JetContainer >	groomJets () const
std::unique_ptr< xAOD::JetContainer >	copyJets () const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
SG::WriteHandleKey< xAOD::JetContainer >	m_outcoll {this, "OutputContainer", ""}
SG::ReadHandleKey< xAOD::JetContainer >	m_incoll {this, "InputContainer", ""}
SG::ReadHandleKeyArray< PseudoJetContainer >	m_psjsin {this, "InputPseudoJets", {}}
ToolHandle< IJetExecuteTool >	m_intool
ToolHandle< IJetPseudojetRetriever >	m_hpjr
ToolHandle< IJetFinder >	m_finder
ToolHandle< IJetGroomer >	m_groomer
ToolHandleArray< IJetModifier >	m_modifiers {this, "JetModifiers", {}}
ToolHandleArray< IJetConsumer >	m_consumers {this, "JetConsumers", {}}
bool	m_trigger {}
int	m_initCount {}
bool	m_find {}
bool	m_groom {}
bool	m_copy {}
xAOD::JetInput::Type	m_inputtype
IJetFinder::NameList	m_ghostlabs
std::vector< std::string >	m_incolls
std::vector< std::string >	m_outcolls
const IJetPseudojetRetriever *	m_ppjr {}
const xAOD::JetContainer *	m_trigInputJetsForGrooming {}
ToolHandle< GenericMonitoringTool >	m_monTool {this,"MonTool","","Monitoring tool"}
const double	m_mevtogev = 0.001
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

David Adams.

Date

January 2014

This is the top-level tool for jet reconstruction. It creates a new jet collection from finding, grooming or copy. There is a one-to-one correpondence between jet collections and JetRecTool instances.

Properties are as follows: OutputContainer: Name of the output jet collection InputCollection: Name of the input jet collection. Required for grooming or copy. If InputTool is defined, the collection name is taked from the output collection name of that tool. The configured value of this property should be identical to that or blank. InputPseudoJets: Array of ReadHandleKeys for the pseudojet collections to be retrieved and passed to JetFinder. These collections are merged and used as input for jet finding. InputTool: Handle for the JetRecTool called to create the input collection if it is not already found in the event store. JetPseudojetRetriever: Tool used to retrieve the pseudojet cluster sequence associated with a jet. If undefined, one is created. JetFinder: Handle for the tool used to find jets. JetGroomer: Handle for the tool used to groom jets. JetModifiers: Array of handles of tools used to modify the jet collection, e.g. to add moments sort or filter. JetConsumers: Tools consuming jets to run after building jets

This tool may be used to build jets in any one of three ways:

1. To find jets, the JetFinder and PseudoJetGetters must be defined. InputCollection, InputTool and JetGroomer should not be defined.
2. To groom jets, the JetGroomer and InputCollection or InputTool must be defined. The JetFinder should not be defined.
3. To copy jets, the InputCollection or InputTool must be defined. The tool may also be used to call a sequence of pseudojet builders without building any jets. In this case, none of OutputCollection, InputCollection, InputTool, JetFinder or jetGroomer should be defined and the array of jet modifiers should be empty.

Definition at line 68 of file JetRecTool.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

JetRecTool()

JetRecTool::JetRecTool

(

const std::string &

myname

)

Definition at line 42 of file JetRecTool.cxx.

: AsgTool(myname),
  m_intool("",this),
#ifdef XAOD_ANALYSIS
  m_hpjr("",this),
#else
  m_hpjr("JetPseudojetRetriever/jpjr",this),
#endif
  m_finder("",this),
  m_groomer("",this),
  m_trigger(false),
  m_initCount(0),
  m_find(false), m_groom(false), m_copy(false),
  m_inputtype(xAOD::JetInput::Uncategorized),
  m_ppjr(nullptr) {
  declareProperty("InputTool", m_intool);
  declareProperty("JetPseudojetRetriever", m_hpjr);
  declareProperty("JetFinder", m_finder);
  declareProperty("JetGroomer", m_groomer);
  declareProperty("Trigger", m_trigger);
}

Member Function Documentation

build()

const JetContainer * JetRecTool::build ( ) const

overridevirtual

Retrieve inputs with tools and construct new jet collection.

Implements IJetBuildTool.

Definition at line 217 of file JetRecTool.cxx.

                                            {
  if ( m_initCount == 0 ) {
    ATH_MSG_WARNING("Build requested before initialization.");
    return nullptr;
  }
  ATH_MSG_DEBUG("Building jets with " << name() << ".");
 
  std::unique_ptr<xAOD::JetContainer> pjets = fillOutputContainer();
 
  SG::WriteHandle<xAOD::JetContainer> jetsHandle(m_outcoll);
 
  // Record the jet collection.
  if(m_trigger){
    #ifndef GENERATIONBASE
    std::unique_ptr<xAOD::JetTrigAuxContainer> pjetsaux(dynamic_cast<xAOD::JetTrigAuxContainer*>( pjets->getStore() ));
    ATH_MSG_DEBUG("Check Aux store: " << pjets.get() << " ... " << &pjets->auxbase() << " ... " << pjetsaux.get() );
    if ( pjetsaux.get() == nullptr ) {
      ATH_MSG_ERROR("Unable to retrieve Aux container");
      return nullptr;
    }
    ATH_MSG_VERBOSE("Recording new Jet and Aux container.");
    if(jetsHandle.record(std::move(pjets), std::move(pjetsaux)).isFailure()){
      // TODO - put this back how it was
      ATH_MSG_ERROR("Unable to write new Jet collection and aux store to event store: " << m_outcoll.key());
      return nullptr;
    }
    #endif
  }
  else{
    std::unique_ptr<xAOD::JetAuxContainer> pjetsaux(dynamic_cast<xAOD::JetAuxContainer*>( pjets->getStore() ));
    ATH_MSG_DEBUG("Check Aux store: " << pjets.get() << " ... " << &pjets->auxbase() << " ... " << pjetsaux.get() );
    if ( pjetsaux.get() == nullptr ) {
      ATH_MSG_ERROR("Unable to retrieve Aux container");
      return nullptr;
    }
    ATH_MSG_VERBOSE("Recording new Jet and Aux container.");
    if(jetsHandle.record(std::move(pjets), std::move(pjetsaux)).isFailure()){
      ATH_MSG_ERROR("Unable to write new Jet collection and aux store to event store: " << m_outcoll.key());
      return nullptr;
    }
  }
  ATH_MSG_DEBUG("Created new Jet collection in event store: " << m_outcoll.key());
 
  // Modify jets.
  unsigned int nmod = m_modifiers.size();
  if ( nmod ) {
    if ( !jetsHandle.isValid() ) {
      ATH_MSG_WARNING("There is no jet collection to modify.");
    } else {
      ATH_MSG_DEBUG("Executing " << nmod << " jet modifiers.");
      for ( ModifierArray::const_iterator imod=m_modifiers.begin();
           imod!=m_modifiers.end(); ++imod ) {
        ATH_MSG_DEBUG("  Executing modifier " << imod->name());
        ATH_MSG_VERBOSE("    @ " << *imod);
        if((*imod)->modify(*jetsHandle).isFailure())
          ATH_MSG_DEBUG("    Modifier returned FAILURE!");
      }
    }
  }
 
  // Consume jets.
  unsigned int ncon = m_consumers.size();
  if ( ncon ) {
    if ( !jetsHandle.isValid() ) {
      ATH_MSG_WARNING("There is no jet collection to consume");
    } else {
      ATH_MSG_DEBUG("Executing " << ncon << " jet consumers.");
      for ( ConsumerArray::const_iterator icon=m_consumers.begin();
           icon!=m_consumers.end(); ++icon ) {
        ATH_MSG_DEBUG("  Executing consumer " << icon->name());
        ATH_MSG_VERBOSE("    @ " << *icon);
        (*icon)->process(*jetsHandle) ;
      }
    }
  }
 
 
#if !defined (GENERATIONBASE) && !defined (XAOD_ANALYSIS)
  // monitor jet multiplicity and basic jet kinematics
  auto njets = Monitored::Scalar<int>("JET_n");
  auto pt    = Monitored::Collection("JET_pt",  *jetsHandle, [c=m_mevtogev]( const xAOD::Jet* jet ) { return jet->pt()*c; });
  auto et    = Monitored::Collection("JET_et",  *jetsHandle, [c=m_mevtogev]( const xAOD::Jet* jet ) { return jet->p4().Et()*c; });
  auto mass  = Monitored::Collection("JET_m",   *jetsHandle, [c=m_mevtogev]( const xAOD::Jet* jet ) { return jet->m()*c; });
  auto eta   = Monitored::Collection("JET_eta", *jetsHandle, []( const xAOD::Jet* jet ) { return jet->eta(); });
  auto phi   = Monitored::Collection("JET_phi", *jetsHandle, []( const xAOD::Jet* jet ) { return jet->phi(); });
  auto mon   = Monitored::Group(m_monTool,njets,pt,et,mass,eta,phi);
  njets      = jetsHandle->size();
#endif
 
  return jetsHandle.isValid() ? &(*jetsHandle) : nullptr;
}

collectPseudoJets()

std::unique_ptr< PseudoJetContainer > JetRecTool::collectPseudoJets ( ) const

private

Definition at line 401 of file JetRecTool.cxx.

                                                                     {
  // PseudoJetContainer used for jet finding
 
  auto allPseudoJets = std::make_unique<PseudoJetContainer>();
 
  ATH_MSG_DEBUG("Fetching pseudojet inputs.");
 
  for (const auto& pjcontkey : m_psjsin) {
    SG::ReadHandle<PseudoJetContainer> h_newpsjs( pjcontkey );
    ATH_MSG_DEBUG("Adding PseudoJetContainers for: " << h_newpsjs.key());
    if(! h_newpsjs.isValid()) {
      ATH_MSG_ERROR("Retrieval of PseudoJetContainer "
                    << h_newpsjs.key() << " failed");
      return nullptr;
    }
    allPseudoJets->append(h_newpsjs.get());
  }
 
  return allPseudoJets;
}

copyJets()

std::unique_ptr< xAOD::JetContainer > JetRecTool::copyJets ( ) const

private

Definition at line 523 of file JetRecTool.cxx.

                                                          {
 
  // The new jet collection.
  auto jets = makeOutputContainer();
 
  // Retrieve the old jet collection.
  const auto *jetsIn = getOldJets();
 
  if(jetsIn == nullptr){
    ATH_MSG_WARNING("Copying: but input jets not found ");
    return jets;
  }
 
 
  ATH_MSG_DEBUG("Copying " << jetsIn->size() << " jets.");
 
  for (const Jet* poldjet : *jetsIn) {
    Jet* pnewjet = new Jet;
    jets->push_back(pnewjet);
    *pnewjet = *poldjet;
  }
 
  return jets;
}

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

execute()

int JetRecTool::execute ( ) const

overridevirtual

Call build and put jets in event store.

Implements IJetExecuteTool.

Definition at line 311 of file JetRecTool.cxx.

                              {
  if ( m_initCount == 0 ) {
    ATH_MSG_WARNING("Execute requested before initialization.");
    return 1;
  }
 
  if ( build() == nullptr ) {
    ATH_MSG_ERROR("Unable to retrieve container");
    return 1;
  }
  return 0;
}

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

fillOutputContainer()

std::unique_ptr< xAOD::JetContainer > JetRecTool::fillOutputContainer ( ) const

private

Definition at line 424 of file JetRecTool.cxx.

                                                                     {
 
  if (!m_finder.empty()) {return findJets();}
  if (!m_groomer.empty()) {return groomJets();}
  return copyJets();
}

findJets()

std::unique_ptr< xAOD::JetContainer > JetRecTool::findJets ( ) const

private

Definition at line 479 of file JetRecTool.cxx.

                                                           {
 
  ATH_MSG_DEBUG("Finding jets.");
 
  // The new jet collection.
  auto jets = makeOutputContainer();
 
  // PseudoJetContainer used for jet finding
  auto pseudoJets = collectPseudoJets();
 
  m_finder->find(*pseudoJets, *jets, m_inputtype);
 
  return jets;
}

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
   }

getOldJets()

const xAOD::JetContainer * JetRecTool::getOldJets ( ) const

private

Definition at line 433 of file JetRecTool.cxx.

                                                    {
 
  const xAOD::JetContainer* pjetsin{nullptr};
  auto handle_in = SG::makeHandle (m_incoll);
  if ( !m_incoll.key().empty() && handle_in.isValid()) {
    pjetsin = handle_in.cptr();
  }
  if ( pjetsin == nullptr && !m_intool.empty() ) {
    ATH_MSG_DEBUG("Executing input tool.");
    if ( m_intool->execute() ) {
      ATH_MSG_WARNING("Input tool execution failed.");
    }
  }
 
  if ( pjetsin == nullptr ) {
    ATH_MSG_ERROR("Unable to retrieve input jet container: " << m_incoll.key());
  } else {
    ATH_MSG_DEBUG("Input collection " << m_incoll.key()
                  << " jet multiplicity is "<< pjetsin->size());
  }
    return pjetsin;
}

getProperty()

template<class T>

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

inherited

Get one of the tool's properties.

groomJets()

std::unique_ptr< xAOD::JetContainer > JetRecTool::groomJets ( ) const

private

Definition at line 496 of file JetRecTool.cxx.

                                                           {
 
  // The new jet collection.
  auto jets = makeOutputContainer();
 
  // Retrieve the old jet collection.
  const auto *jetsIn = getOldJets();
 
  if(jetsIn == nullptr){
    ATH_MSG_WARNING("Grooming: but input jets not found ");
    return jets;
  }
 
  ATH_MSG_DEBUG("Grooming " << jetsIn->size() << " jets.");
 
  // PseudoJetContainer used for jet finding
  auto pseudoJets = collectPseudoJets();
 
  for (const auto *const ijet : *jetsIn){ m_groomer->groom(*ijet,
                                                    *pseudoJets,
                                                    *jets);}
 
  return jets;
}

initialize()

StatusCode JetRecTool::initialize ( void )

overridevirtual

Initialization. Check all tools here.

Reimplemented from asg::AsgTool.

Definition at line 66 of file JetRecTool.cxx.

                                  {
  ATH_MSG_INFO("Initializing JetRecTool " << name() << ".");
  ++m_initCount;
  // Fetch the reconstruction mode.
  bool needinp = false;
  bool needout = false;
  string mode = "pseudojets";
  if ( !m_outcoll.key().empty() ) {
    m_outcolls.push_back(m_outcoll.key());
    if ( ! m_finder.empty() ) {
      mode = "find";
      m_find = true;
      needout = true;
      if ( m_psjsin.empty() ) {
        ATH_MSG_ERROR("Jet finding requested with no inputs.");
        return StatusCode::FAILURE;
      } else {
    ATH_CHECK( m_psjsin.initialize() );
      }
    } else if ( ! m_groomer.empty() ) {
      mode = "groom";
      m_groom = true;
      needinp = true;
      needout = true;
      ATH_CHECK(m_groomer.retrieve());
    } else {
      mode = "copy";
      m_copy = true;
      needinp = true;
      needout = true;
    }
  }
  else {
    m_finder.disable();
    m_groomer.disable();
  }
 
  ATH_CHECK( m_psjsin.initialize() );
  // Retrieve or create pseudojet retrieval tool.
  if ( !m_hpjr.empty() ) {
    if ( m_hpjr.retrieve().isSuccess() ) {
      m_ppjr = &*m_hpjr;
    } else {
      ATH_MSG_ERROR("Unable to retrieve requested pseudojet retriever: " << m_hpjr.name());
    }
  } else {
#ifdef XAOD_STANDALONE
      m_ppjr = new JetPseudojetRetriever(name()+"_retriever");
#else
      m_ppjr = nullptr;
#endif
  }
  ATH_MSG_INFO("Jet reconstruction mode: " << mode);
  // Check/set the input jet collection name.
  if ( needinp ) {
    if ( m_incoll.key().empty() ) {
      if ( ! m_intool.retrieve() ) {
        ATH_MSG_ERROR("Input collection must be specified.");
        return StatusCode::FAILURE;
      } else {
        const AsgTool* pasgtool = dynamic_cast<const asg::AsgTool*>(&*m_intool);
        if ( pasgtool != nullptr ) {
          const string* pval = pasgtool->getProperty<std::string>("OutputContainer");
          if ( pval != nullptr ) {
            m_incoll = *pval;
          }
        }
        if ( m_incoll.key().empty() ) {
          ATH_MSG_ERROR("Input tool does not have output collection name.");
          return StatusCode::FAILURE;
        }
      }
    } else {
      // Input DataHandles
      ATH_CHECK( m_incoll.initialize() );
    }
    m_incolls.push_back(m_incoll.key());
  }
  // Check/set the output jet collection name.
  if ( needout ) {
    if ( m_outcoll.key().empty() ) {
      ATH_MSG_ERROR("Output collection must be specified.");
      return StatusCode::FAILURE;
    } else {
      // Output DataHandle
      ATH_CHECK( m_outcoll.initialize() );
    }
  }
  // Other checks.
  if ( m_find ) {
    if ( m_psjsin.empty() ) {
      ATH_MSG_ERROR("Jet finding requested with no inputs.");
      return StatusCode::FAILURE;
    }
  } else if ( m_groom ) {
    m_groomer->setPseudojetRetriever(m_ppjr);
  } else if ( m_copy ) {
  } else {
    if ( m_psjsin.empty() ) {
      ATH_MSG_ERROR("No action requested.");
      return StatusCode::FAILURE;
    }
  }
  // Parse the pseudojet inputs
  StatusCode rstat = StatusCode::SUCCESS;
  string prefix = "--- ";
  ATH_MSG_INFO(prefix << "JetRecTool " << name() << " has " << m_psjsin.size()
               << " pseudojet inputs.");
  for ( size_t ilab(0); ilab<m_psjsin.size(); ++ilab ) {
    const std::string& pjcontname = m_psjsin[ilab].key();
    if(pjcontname.size()<9) {
      ATH_MSG_ERROR("Invalid pseudojet container name " << pjcontname);
      ATH_MSG_ERROR("This must be of the form \"PseudoJet\"+label");
      return StatusCode::FAILURE;
    }
    std::string label = pjcontname.substr(9);
    ATH_MSG_INFO(prefix << " " << label << " --> " << pjcontname);
    // Extract the input type from the first getter.
    if ( ilab == 0 ) {
      ATH_MSG_INFO(prefix << "Extracting input type from primary label.");
      ATH_MSG_INFO(prefix << "Input label: " << label);
      m_inputtype = xAOD::JetInput::inputType(label);
    } else {
      m_ghostlabs.push_back(label);
    }
  }
  ATH_MSG_INFO(prefix << "Input type: " << m_inputtype);
  // Fetch the jet modifiers.
  ATH_MSG_INFO(prefix << "JetRecTool " << name() << " has " << m_modifiers.size()
               << " jet modifiers.");
  ATH_CHECK(m_modifiers.retrieve());
 
  // Fetch the jet consumers.
  ATH_MSG_INFO(prefix << "JetRecTool " << name() << " has " << m_consumers.size()
               << " jet consumers.");
  ATH_CHECK(m_consumers.retrieve());
 
  ATH_MSG_INFO(prefix << "Input collection names:");
  for (const auto& name : m_incolls) ATH_MSG_INFO(prefix << "  " << name);
  ATH_MSG_INFO(prefix << "Output collection names:");
  for (const auto& name : m_outcolls) ATH_MSG_INFO(prefix << "  " << name);
 
#if !defined (GENERATIONBASE) && !defined (XAOD_ANALYSIS)
  if (!m_monTool.empty()) ATH_CHECK(m_monTool.retrieve());
#endif
 
  return rstat;
}

inputContainerNames()

int JetRecTool::inputContainerNames ( std::vector< std::string > & connames )

overridevirtual

Method to return the list of input containers.

The names of required input containers are appended to connames. Returns nonzero for error. Default returns 0 and adds no names.

Reimplemented from IJetExecuteTool.

Definition at line 373 of file JetRecTool.cxx.

                                                                  {
  if ( m_initCount == 0 ) {
    ATH_MSG_WARNING("Input container list requested before initialization.");
    return 1;
  }
  connames.insert(connames.end(), m_incolls.begin(), m_incolls.end());
  return 0;
}

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.

makeOutputContainer()

std::unique_ptr< xAOD::JetContainer > JetRecTool::makeOutputContainer ( ) const

private

Definition at line 458 of file JetRecTool.cxx.

                                                                     {
  ATH_MSG_DEBUG("Creating output container.");
 
  auto pjets = std::make_unique<xAOD::JetContainer>();
 
  if ( !m_outcoll.key().empty() ) {
    if(m_trigger) {
      ATH_MSG_DEBUG("Attaching online Aux container.");
#ifndef GENERATIONBASE
      pjets->setStore(new xAOD::JetTrigAuxContainer);
#endif
    } else {
      ATH_MSG_DEBUG("Attaching offline Aux container.");
      pjets->setStore(new xAOD::JetAuxContainer);
    }
  }
  return pjets;
}

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

outputContainerNames()

int JetRecTool::outputContainerNames ( std::vector< std::string > & connames )

overridevirtual

Method to return the list of output containers.

The names of produced output containers are appended to connames. Returns nonzero for error. Default returns 0 and adds no names.

Reimplemented from IJetExecuteTool.

Definition at line 384 of file JetRecTool.cxx.

                                                                   {
  if ( m_initCount == 0 ) {
    ATH_MSG_WARNING("Output container list requested before initialization.");
    return 1;
  }
  connames.insert(connames.end(), m_outcolls.begin(), m_outcolls.end());
  return 0;
}

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 JetRecTool::print ( ) const

overridevirtual

Display the configuration.

Reimplemented from asg::AsgTool.

Definition at line 326 of file JetRecTool.cxx.

                             {
  ATH_MSG_INFO("Properties for JetRecTool " << name());
 
  ATH_MSG_INFO("  OutputContainer: " << m_outcoll.key());
  if ( m_incoll.key().empty() ) ATH_MSG_INFO("  InputContainer is not defined");
  else ATH_MSG_INFO("  InputContainer: " << m_incoll.key());
  if ( m_intool.empty() ) {
    ATH_MSG_INFO("  InputTool is not defined");
  } else {
    ATH_MSG_INFO("  InputTool: " << m_intool->name());
  }
  if ( !m_psjsin.empty() ) {
    ATH_MSG_INFO("  InputPseudoJet container count is " << m_psjsin.size());
    for ( const auto& pjcontkey : m_psjsin ) {
      ATH_MSG_INFO("    " << pjcontkey.key());
    }
  }
  if ( m_finder.empty() ) {
    ATH_MSG_INFO("  Jet finder is not defined");
  } else {
    ATH_MSG_INFO("  Jet finder: " << m_finder->name());
    m_finder->print();
    ATH_MSG_INFO("    Input type: " << m_inputtype);
    ATH_MSG_INFO("    There are " << m_ghostlabs.size() << " ghost labels:");
    for ( const string& lab : m_ghostlabs ) ATH_MSG_INFO("      " << lab);
  }
  if ( m_groomer.empty() ) {
    ATH_MSG_INFO("  Jet groomer is not defined");
  } else {
    ATH_MSG_INFO("  Jet groomer: " << m_groomer->name());
    m_groomer->print();
  }
  if ( !m_modifiers.empty() ) {
    ATH_MSG_INFO("  Modifier count is " << m_modifiers.size());
    for ( ModifierArray::const_iterator imod=m_modifiers.begin();
           imod!=m_modifiers.end(); ++imod ) {
      ATH_MSG_INFO("    Modifier " << imod->name());
      if ( msgLvl(MSG::DEBUG) ) {
        ToolHandle<IJetModifier> hmod = *imod;
        hmod->print();
      }
    }
  }
}

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

setInputJetContainer()

void JetRecTool::setInputJetContainer

(

const xAOD::JetContainer *

cont

)

For trigger usage in grooming mode only : give the input ungroomed jet container.

Definition at line 395 of file JetRecTool.cxx.

                                                                   {
   m_trigInputJetsForGrooming = cont;
 }

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_consumers

ToolHandleArray<IJetConsumer> JetRecTool::m_consumers {this, "JetConsumers", {}}

private

Definition at line 131 of file JetRecTool.h.

{this, "JetConsumers", {}};

m_copy

bool JetRecTool::m_copy {}

private

Definition at line 138 of file JetRecTool.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_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_find

bool JetRecTool::m_find {}

private

Definition at line 136 of file JetRecTool.h.

{};

m_finder

ToolHandle<IJetFinder> JetRecTool::m_finder

private

Definition at line 128 of file JetRecTool.h.

m_ghostlabs

IJetFinder::NameList JetRecTool::m_ghostlabs

private

Definition at line 140 of file JetRecTool.h.

m_groom

bool JetRecTool::m_groom {}

private

Definition at line 137 of file JetRecTool.h.

{};

m_groomer

ToolHandle<IJetGroomer> JetRecTool::m_groomer

private

Definition at line 129 of file JetRecTool.h.

m_hpjr

ToolHandle<IJetPseudojetRetriever> JetRecTool::m_hpjr

private

Definition at line 127 of file JetRecTool.h.

m_incoll

SG::ReadHandleKey<xAOD::JetContainer> JetRecTool::m_incoll {this, "InputContainer", ""}

private

Definition at line 122 of file JetRecTool.h.

{this, "InputContainer", ""};

m_incolls

std::vector<std::string> JetRecTool::m_incolls

private

Definition at line 141 of file JetRecTool.h.

m_initCount

int JetRecTool::m_initCount {}

private

Definition at line 135 of file JetRecTool.h.

{};

m_inputtype

xAOD::JetInput::Type JetRecTool::m_inputtype

private

Definition at line 139 of file JetRecTool.h.

m_intool

ToolHandle<IJetExecuteTool> JetRecTool::m_intool

private

Definition at line 126 of file JetRecTool.h.

m_mevtogev

const double JetRecTool::m_mevtogev = 0.001

private

Definition at line 156 of file JetRecTool.h.

m_modifiers

ToolHandleArray<IJetModifier> JetRecTool::m_modifiers {this, "JetModifiers", {}}

private

Definition at line 130 of file JetRecTool.h.

{this, "JetModifiers", {}};

m_monTool

ToolHandle<GenericMonitoringTool> JetRecTool::m_monTool {this,"MonTool","","Monitoring tool"}

private

Definition at line 149 of file JetRecTool.h.

{this,"MonTool","","Monitoring tool"};

m_outcoll

SG::WriteHandleKey<xAOD::JetContainer> JetRecTool::m_outcoll {this, "OutputContainer", ""}

private

Definition at line 121 of file JetRecTool.h.

{this, "OutputContainer", ""};

m_outcolls

std::vector<std::string> JetRecTool::m_outcolls

private

Definition at line 142 of file JetRecTool.h.

m_ppjr

const IJetPseudojetRetriever* JetRecTool::m_ppjr {}

private

Definition at line 143 of file JetRecTool.h.

{};

m_psjsin

SG::ReadHandleKeyArray<PseudoJetContainer> JetRecTool::m_psjsin {this, "InputPseudoJets", {}}

private

Definition at line 124 of file JetRecTool.h.

{this, "InputPseudoJets", {}};

m_trigger

bool JetRecTool::m_trigger {}

private

Definition at line 132 of file JetRecTool.h.

{};

m_trigInputJetsForGrooming

const xAOD::JetContainer* JetRecTool::m_trigInputJetsForGrooming {}

private

Definition at line 146 of file JetRecTool.h.

{}; // used in trigger context only

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:

• JetRecTool.h
• JetRecTool.cxx