JetModifiedMassDrop Class Reference

#include <JetModifiedMassDrop.h>

Inheritance diagram for JetModifiedMassDrop:

Collaboration diagram for JetModifiedMassDrop:

Public Types
enum	SymmetryMeasure { scalar_z , vector_z , y }
	an enum of the different (a)symmetry measures that can be used More...
enum	RecursionChoice { larger_pt , larger_mt , larger_m }
	an enum for the options of how to choose which of two subjets to recurse into More...

Public Member Functions
	JetModifiedMassDrop (const std::string &name)
	~JetModifiedMassDrop ()
virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function.
virtual int	groom (const xAOD::Jet &jin, const PseudoJetContainer &, xAOD::JetContainer &jout) const override
	Transform jet.
virtual void	print () const override
	Print the state of the tool.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
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_zcut
float	m_mu
bool	m_doFilt
double	m_filtR
int	m_filtNSub
int	m_sym
int	m_recursion
ToolHandle< IJetFromPseudojet >	m_bld
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 28 of file JetModifiedMassDrop.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

RecursionChoice

enum JetModifiedMassDrop::RecursionChoice

an enum for the options of how to choose which of two subjets to recurse into

Enumerator
larger_pt	choose the subjet with larger \( p_t \)
larger_mt	choose the subjet with larger \( m_t \equiv (m^2+p_t^2)^{\frac12}] \)
larger_m	choose the subjet with larger mass (deprecated)

Definition at line 47 of file JetModifiedMassDrop.h.

                      {larger_pt, 
                              larger_mt, 
                              larger_m   
  };

SymmetryMeasure

enum JetModifiedMassDrop::SymmetryMeasure

an enum of the different (a)symmetry measures that can be used

Enumerator
scalar_z	\( \min(p_{ti}, p_{tj})/(p_{ti} + p_{tj}) \)
vector_z	\( \min(p_{ti}, p_{tj})/p_{t(i+j)} \)
y	\( \min(p_{ti}^2,p_{tj}^2) \Delta R_{ij}^2 / m_{ij}^2 \)

Definition at line 40 of file JetModifiedMassDrop.h.

                      {scalar_z, 
                              vector_z, 
                              y         
                       
  };

Constructor & Destructor Documentation

JetModifiedMassDrop()

JetModifiedMassDrop::JetModifiedMassDrop

(

const std::string &

name

)

Definition at line 27 of file JetModifiedMassDrop.cxx.

  : AsgTool(name), m_bld("",this) {
  declareProperty("ZCut",            m_zcut = 0.1);
  declareProperty("SymmetryMeasure", m_sym = scalar_z);
  declareProperty("MassDrop",        m_mu = std::numeric_limits<double>::infinity() );
  declareProperty("RecursionChoice", m_recursion = larger_pt);
  declareProperty("doFilter",        m_doFilt = true);
  declareProperty("FilterNsubjets",  m_filtNSub = 3);
  declareProperty("FilterR",         m_filtR = 0.3);
  declareProperty("JetBuilder",      m_bld);
}

~JetModifiedMassDrop()

JetModifiedMassDrop::~JetModifiedMassDrop ( )

default

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 JetModifiedMassDrop::groom ( const xAOD::Jet & jin, const PseudoJetContainer & , xAOD::JetContainer & jout ) const

overridevirtual

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 71 of file JetModifiedMassDrop.cxx.

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

  //configure modified mass drop tagger tool
  //http://fastjet.hepforge.org/svn/contrib/contribs/RecursiveTools/tags/1.0.0/ModifiedMassDropTagger.hh
 
  // Could do this casting in the call to the ModifiedMassDropTagger constructor, doing it here for readability
  RecursiveSymmetryCutBase::SymmetryMeasure sym       = static_cast<RecursiveSymmetryCutBase::SymmetryMeasure>(m_sym);
  RecursiveSymmetryCutBase::RecursionChoice recursion = static_cast<RecursiveSymmetryCutBase::RecursionChoice>(m_recursion);
 
  //create the modified mass drop tagger, apply it to the input pseudojet
  fastjet::contrib::ModifiedMassDropTagger MMDT(m_zcut,sym,m_mu,recursion);
  // Use grooming mode to avoid getting empty pseudojets
  MMDT.set_grooming_mode();
  PseudoJet pjMMDT = MMDT(*ppjin);
  
  bool didMMDT = pjMMDT.has_structure_of<fastjet::contrib::ModifiedMassDropTagger>();
 
  // then filter the jet (useful for studies at moderate pt) if requested and if grooming succeeded
  // with a dynamic Rfilt choice (as in arXiv:0802.2470)
  PseudoJet filtpjMMDT = pjMMDT;
  double Rfilt = m_filtR;
  if ( m_doFilt && didMMDT ) {
    Rfilt = std::min(m_filtR, pjMMDT.structure_of<fastjet::contrib::ModifiedMassDropTagger>().delta_R()*0.5);
    fastjet::Filter filter(Rfilt, fastjet::SelectorNHardest(m_filtNSub));
    filtpjMMDT = filter(pjMMDT);
  }
 
  int npMMDT = filtpjMMDT.pieces().size();
  xAOD::Jet* pjet = m_bld->add(filtpjMMDT, pjContainer, jets, &jin);
  if ( pjet == nullptr ) {
    ATH_MSG_ERROR("Unable to add jet to container");
    return 1;
  }
  //pjet->SetAttribute<int>("TransformType", xAOD::JetTransform::MMDT); // Possibly not needed
  pjet->setAttribute("didMMDT", didMMDT);
  pjet->setAttribute("ZCut", m_zcut);
  pjet->setAttribute("mMDTSymmetryMeasure", m_sym);
  pjet->setAttribute("mMDTRecursionChoice", m_recursion);
  pjet->setAttribute("mMDTMu", m_mu);
  pjet->setAttribute("FilterNSubjects", m_filtNSub);
  pjet->setAttribute("FilterR", Rfilt);
  pjet->setAttribute<int>("NmMDTSubjets", npMMDT);
 
  ATH_MSG_DEBUG("Properties after softdrop:");
  ATH_MSG_DEBUG("   ncon: " << pjMMDT.constituents().size() << "/"
                            << ppjin->constituents().size());
  ATH_MSG_DEBUG("   nsub: " << npMMDT);
  
  ATH_MSG_DEBUG("Added jet to container.");
  
  return 0;
}

initialize()

StatusCode JetModifiedMassDrop::initialize ( void )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 45 of file JetModifiedMassDrop.cxx.

                                           {
  if ( m_zcut < 0.0 || m_zcut > 10.0 ) {
    ATH_MSG_ERROR("Invalid value for ZCut " << m_zcut);
    return StatusCode::FAILURE;
  }
  if ( m_mu < 0.0 ) {
    ATH_MSG_ERROR("Invalid value for MassDrop " << m_mu);
  }
  if ( m_sym != y && m_sym != scalar_z && m_sym != vector_z ) {
    ATH_MSG_ERROR("Invalid value for SymmetryMeasure " << m_sym);
    return StatusCode::FAILURE;
  }
  if ( m_recursion != larger_pt && m_recursion != larger_mt && m_recursion != larger_m ) {
    ATH_MSG_ERROR("Invalid value for RecursionChoice " << m_recursion);
    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 JetModifiedMassDrop::print ( ) const

overridevirtual

Print the state of the tool.

Reimplemented from asg::AsgTool.

Definition at line 139 of file JetModifiedMassDrop.cxx.

                                      {
  //ATH_MSG_INFO("  Angular fraction min: " << m_zcut);
  //ATH_MSG_INFO("  Angular exponent: " << m_beta);
  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_bld

ToolHandle<IJetFromPseudojet> JetModifiedMassDrop::m_bld

private

Definition at line 83 of file JetModifiedMassDrop.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_doFilt

bool JetModifiedMassDrop::m_doFilt

private

Definition at line 74 of file JetModifiedMassDrop.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_filtNSub

int JetModifiedMassDrop::m_filtNSub

private

Definition at line 76 of file JetModifiedMassDrop.h.

m_filtR

double JetModifiedMassDrop::m_filtR

private

Definition at line 75 of file JetModifiedMassDrop.h.

m_mu

float JetModifiedMassDrop::m_mu

private

Definition at line 73 of file JetModifiedMassDrop.h.

m_ppjr

const IJetPseudojetRetriever* IJetGroomer::m_ppjr

privateinherited

Pseudojet retriever.

Definition at line 52 of file IJetGroomer.h.

m_recursion

int JetModifiedMassDrop::m_recursion

private

Definition at line 81 of file JetModifiedMassDrop.h.

m_sym

int JetModifiedMassDrop::m_sym

private

Definition at line 79 of file JetModifiedMassDrop.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_zcut

float JetModifiedMassDrop::m_zcut

private

Definition at line 72 of file JetModifiedMassDrop.h.

---

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

• JetModifiedMassDrop.h
• JetModifiedMassDrop.cxx