JetSplitter Class Reference

#include <JetSplitter.h>

Inheritance diagram for JetSplitter:

Collaboration diagram for JetSplitter:

Public Member Functions
	JetSplitter (const std::string &name)
	~JetSplitter ()
StatusCode	initialize ()
	Dummy implementation of the initialisation function.
int	groom (const xAOD::Jet &jin, const PseudoJetContainer &, xAOD::JetContainer &jout) const
	Transform jet.
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
virtual const IJetPseudojetRetriever *	pseudojetRetriever () const
	Return the pseudojet retriever associated with this tool.
virtual void	setPseudojetRetriever (const IJetPseudojetRetriever *ppjr)
	Set the pseudojet retriever associated with this tool.
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
float	m_mumax
float	m_ymin
ToolHandle< IJetFromPseudojet >	m_bld
float	m_rclus
bool	m_bdrs
int	m_nsubjetmax
JetDumper *	m_pdmp
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
const IJetPseudojetRetriever *	m_ppjr
	Pseudojet retriever.

Detailed Description

Definition at line 22 of file JetSplitter.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

JetSplitter()

JetSplitter::JetSplitter

(

const std::string &

name

)

Definition at line 30 of file JetSplitter.cxx.

  : AsgTool(name), m_bld("",this),
  m_pdmp(new JetDumper(name+"Dumper")) {
  declareProperty("MuMax", m_mumax =1.0);
  declareProperty("YMin", m_ymin =0.0);
  declareProperty("RClus", m_rclus =0.3);
  declareProperty("BDRS", m_bdrs =false);
  declareProperty("NSubjetMax", m_nsubjetmax =3);
  declareProperty("JetBuilder", m_bld);
}

~JetSplitter()

JetSplitter::~JetSplitter

(

)

Definition at line 43 of file JetSplitter.cxx.

                          {
  delete m_pdmp;
}

Member Function Documentation

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.

groom()

int JetSplitter::groom ( const xAOD::Jet & jin, const PseudoJetContainer & , xAOD::JetContainer & jout ) const

virtual

Transform jet.

If accepted, the new jet is added to the container. Return codes:

• 0 for success.
• >0 if jet is rejected
• <0 for error

Implements IJetGroomer.

Definition at line 67 of file JetSplitter.cxx.

                                                     {
  MassDropTagger mdtagger(m_mumax, m_ymin);
  if ( pseudojetRetriever() == nullptr ) {
    ATH_MSG_WARNING("Pseudojet retriever is null.");
    return 1;
  }
  const PseudoJet* ppjin = pseudojetRetriever()->pseudojet(jin);
  if ( ppjin == nullptr ) {
    ATH_MSG_WARNING("Jet does not have a pseudojet.");
    return 1;
  }
  ATH_MSG_VERBOSE("Input pseudojet pT: " << ppjin->pt());
  ATH_MSG_VERBOSE("Input pseudojet has area: " << ppjin->has_area());
  int nconin = ppjin->constituents().size();
  PseudoJet pjfilt = mdtagger(*ppjin);
  if ( pjfilt == 0 ) {
    ATH_MSG_DEBUG("Jet rejected by splitter.");
    return 1;
  }
  ATH_MSG_DEBUG("Jet accepted by splitter.");
  PseudoJet parent1 = pjfilt.pieces()[0];
  PseudoJet parent2 = pjfilt.pieces()[1];
  int npfilt = pjfilt.pieces().size();
  double drfilt = parent1.delta_R(parent2);
  double mufilt = pjfilt.structure_of<MassDropTagger>().mu();
  double yfilt = pjfilt.structure_of<MassDropTagger>().y();
  ATH_MSG_DEBUG("Properties after filtering:");
  ATH_MSG_DEBUG("     pT: " << pjfilt.pt());
  ATH_MSG_DEBUG("  has A: " << pjfilt.has_area());
  ATH_MSG_DEBUG("   ncon: " << pjfilt.constituents().size() << "/" << nconin);
  ATH_MSG_DEBUG("   nsub: " << npfilt);
  ATH_MSG_DEBUG("   DR12: " << drfilt);
  ATH_MSG_DEBUG("     mu: " << mufilt);
  ATH_MSG_DEBUG("      y: " << yfilt);
  if ( msgLvl(MSG::VERBOSE) ) {
    std::vector<PseudoJet> cons = pjfilt.constituents();
    m_pdmp->dump_collection(&cons, "Jet");
  }
 
  // Recluster.
  double rclus = m_rclus;
  if ( m_bdrs ) {
    double rbdrs = 0.5*drfilt;
    if ( rbdrs < rclus ) rclus = rbdrs;
  }
  Filter filter(JetDefinition(cambridge_algorithm, rclus),
                SelectorNHardest(m_nsubjetmax));
  PseudoJet pjclus = filter(pjfilt);
  ATH_MSG_DEBUG("Properties after reclustering:");
  ATH_MSG_DEBUG("     pT: " << pjclus.pt());
  ATH_MSG_DEBUG("  has A: " << pjclus.has_area());
  ATH_MSG_VERBOSE("       Input cluster sequence: " << ppjin->associated_cluster_sequence());
  ATH_MSG_VERBOSE("    Filtered cluster sequence: " << pjfilt.associated_cluster_sequence());
  ATH_MSG_VERBOSE(" Reclustered cluster sequence: " << pjclus.associated_cluster_sequence());
  int npclus = pjclus.pieces().size();
  double drclus =  0.0;
  double muclus = 0.0;
  double yclus = 0.0;
  if ( npclus > 1 ) {
    PseudoJet parent1 = pjclus.pieces()[0];
    PseudoJet parent2 = pjclus.pieces()[1];
    drclus= parent1.delta_R(parent2);
  }
  ATH_MSG_DEBUG("Properties after reclustering:");
  ATH_MSG_DEBUG("   ncon: " << pjclus.constituents().size() << "/"
                            << pjfilt.constituents().size() << "/" << nconin);
  ATH_MSG_DEBUG("   nsub: " << npclus);
  ATH_MSG_DEBUG("   DR12: " << drclus);
  ATH_MSG_DEBUG("     mu: " << muclus);
  ATH_MSG_DEBUG("      y: " << yclus);
 
  // Add jet to collection.
  xAOD::Jet* pjet = m_bld->add(pjclus, pjContainer, jets, &jin);
  if ( pjet == nullptr ) {
    ATH_MSG_ERROR("Unable to add jet to container");
  } else {
    ATH_MSG_DEBUG("Added jet to container.");
    pjet->setAttribute<int>("TransformType", xAOD::JetTransform::MassDrop);
    pjet->setAttribute<float>("MuMax", m_mumax);
    pjet->setAttribute<float>("YMin", m_ymin);
    pjet->setAttribute<float>("RClus", m_rclus);
    //this has to be a char, because by default bools are converted to chars in perstification. Thus if we run this tool on an exiting collection in a POOL file the type is char.                                                                                               
    pjet->setAttribute<char>("BDRS", m_bdrs);
    pjet->setAttribute<int>("NSubjetMax", m_nsubjetmax); 
    pjet->setAttribute<float>("DRFilt", drfilt);
    pjet->setAttribute<float>("MuFilt", mufilt);
    pjet->setAttribute<float>("YFilt",  yfilt);
    pjet->setAttribute<int>("NSubjet", npclus);
  }
  return 0;
}

initialize()

StatusCode JetSplitter::initialize ( void )

virtual

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 49 of file JetSplitter.cxx.

                                   {
  if ( m_mumax < 0.0 || m_mumax > 1.0 ) {
    ATH_MSG_ERROR("Invalid value for MuMax: " << m_mumax);
    return StatusCode::FAILURE;
  }
  if ( m_mumax < 0.0 || m_mumax > 1.0 ) {
    ATH_MSG_ERROR("Invalid value for YMin: " << m_ymin);
    return StatusCode::FAILURE;
  }
  if ( m_bld.empty() ) {
    ATH_MSG_ERROR("Unable to retrieve jet builder.");
    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 JetSplitter::print ( ) const

virtual

Print the state of the tool.

Reimplemented from asg::AsgTool.

Definition at line 163 of file JetSplitter.cxx.

                              {
  ATH_MSG_INFO("       mu max: " << m_mumax);
  ATH_MSG_INFO("        y min: " << m_ymin);
  ATH_MSG_INFO("  Recluster R: " << m_rclus);
  ATH_MSG_INFO("     Use BDRS: " << m_bdrs);
  ATH_MSG_INFO("    # subjets: " << m_nsubjetmax);
  ATH_MSG_INFO("  Jet builder: " << m_bld.name());
}

pseudojetRetriever()

const IJetPseudojetRetriever * IJetGroomer::pseudojetRetriever ( ) const

virtualinherited

Return the pseudojet retriever associated with this tool.

Definition at line 21 of file IJetGroomer.cxx.

                                                                    {
  return m_ppjr;
}

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

setPseudojetRetriever()

void IJetGroomer::setPseudojetRetriever ( const IJetPseudojetRetriever * ppjr )

virtualinherited

Set the pseudojet retriever associated with this tool.

Definition at line 27 of file IJetGroomer.cxx.

                                                                          {
  m_ppjr = ppjr;
}

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_bdrs

bool JetSplitter::m_bdrs

private

Definition at line 53 of file JetSplitter.h.

m_bld

ToolHandle<IJetFromPseudojet> JetSplitter::m_bld

private

Definition at line 51 of file JetSplitter.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_mumax

float JetSplitter::m_mumax

private

Definition at line 49 of file JetSplitter.h.

m_nsubjetmax

int JetSplitter::m_nsubjetmax

private

Definition at line 54 of file JetSplitter.h.

m_pdmp

JetDumper* JetSplitter::m_pdmp

private

Definition at line 57 of file JetSplitter.h.

m_ppjr

const IJetPseudojetRetriever* IJetGroomer::m_ppjr

privateinherited

Pseudojet retriever.

Definition at line 52 of file IJetGroomer.h.

m_rclus

float JetSplitter::m_rclus

private

Definition at line 52 of file JetSplitter.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_ymin

float JetSplitter::m_ymin

private

Definition at line 50 of file JetSplitter.h.

---

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

• JetSplitter.h
• JetSplitter.cxx