ATLAS Offline Software
Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
top::SoftMuonObjectCollectionMaker Class Referencefinal

#include <SoftMuonObjectCollectionMaker.h>

Inheritance diagram for top::SoftMuonObjectCollectionMaker:
Collaboration diagram for top::SoftMuonObjectCollectionMaker:

Public Member Functions

 SoftMuonObjectCollectionMaker (const std::string &name)
 
virtual ~SoftMuonObjectCollectionMaker ()
 
 SoftMuonObjectCollectionMaker (const SoftMuonObjectCollectionMaker &rhs)=delete
 
 SoftMuonObjectCollectionMaker (SoftMuonObjectCollectionMaker &&rhs)=delete
 
SoftMuonObjectCollectionMakeroperator= (const SoftMuonObjectCollectionMaker &rhs)=delete
 
StatusCode initialize ()
 Dummy implementation of the initialisation function. More...
 
StatusCode execute (bool)
 
StatusCode printout ()
 
virtual const std::list< CP::SystematicSet > & specifiedSystematics () const
 
const std::list< CP::SystematicSet > & recommendedSystematics () const
 
virtual void print () const
 Print the state of the tool. More...
 
ServiceHandle< StoreGateSvc > & evtStore ()
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
 
const ServiceHandle< StoreGateSvc > & evtStore () const
 The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
 
const ServiceHandle< StoreGateSvc > & detStore () const
 The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
 
virtual StatusCode sysInitialize () override
 Perform system initialization for an algorithm. More...
 
virtual StatusCode sysStart () override
 Handle START transition. More...
 
virtual std::vector< Gaudi::DataHandle * > inputHandles () const override
 Return this algorithm's input handles. More...
 
virtual std::vector< Gaudi::DataHandle * > outputHandles () const override
 Return this algorithm's output handles. More...
 
Gaudi::Details::PropertyBase & declareProperty (Gaudi::Property< T > &t)
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
 Declare a new Gaudi property. More...
 
Gaudi::Details::PropertyBase * declareProperty (const std::string &name, T &property, const std::string &doc="none")
 Declare a new Gaudi property. More...
 
void updateVHKA (Gaudi::Details::PropertyBase &)
 
MsgStream & msg () const
 
MsgStream & msg (const MSG::Level lvl) const
 
bool msgLvl (const MSG::Level lvl) const
 

Protected Member Functions

virtual void specifiedSystematics (const std::set< std::string > &specifiedSystematics)
 
void renounceArray (SG::VarHandleKeyArray &handlesArray)
 remove all handles from I/O resolution More...
 
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. More...
 

Private Types

typedef ServiceHandle< StoreGateSvcStoreGateSvc_t
 

Private Member Functions

Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
 specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
 specialization for handling Gaudi::Property<SG::VarHandleBase> More...
 
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
 specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...
 

Private Attributes

std::shared_ptr< top::TopConfigm_config
 
std::list< CP::SystematicSetm_specifiedSystematics
 
std::list< CP::SystematicSetm_recommendedSystematics
 
ToolHandle< CP::IMuonCalibrationAndSmearingToolm_calibrationTool
 
ToolHandle< CP::IMuonSelectionToolm_muonSelectionToolVeryLooseVeto
 
ToolHandle< CP::IMuonSelectionToolm_softmuonSelectionTool
 
StoreGateSvc_t m_evtStore
 Pointer to StoreGate (event store by default) More...
 
StoreGateSvc_t m_detStore
 Pointer to StoreGate (detector store by default) More...
 
std::vector< SG::VarHandleKeyArray * > m_vhka
 
bool m_varHandleArraysDeclared
 

Detailed Description

Definition at line 40 of file SoftMuonObjectCollectionMaker.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

◆ SoftMuonObjectCollectionMaker() [1/3]

top::SoftMuonObjectCollectionMaker::SoftMuonObjectCollectionMaker ( const std::string &  name)
explicit

Definition at line 20 of file SoftMuonObjectCollectionMaker.cxx.

20  :
22  m_config(nullptr),
23 
26 
27  m_calibrationTool("MuonMomentumCalibrationTool"),
28  m_muonSelectionToolVeryLooseVeto("MuonSelectionToolVeryLooseVeto"),
29  m_softmuonSelectionTool("SoftMuonSelectionTool"){
30  declareProperty("config", m_config);
31 
32  declareProperty("MuonMomentumCalibrationTool", m_calibrationTool);
33  declareProperty("MuonSelectionToolVeryLooseVeto", m_muonSelectionToolVeryLooseVeto);
34  declareProperty("SoftMuonSelectionTool", m_softmuonSelectionTool);
35  }

◆ ~SoftMuonObjectCollectionMaker()

virtual top::SoftMuonObjectCollectionMaker::~SoftMuonObjectCollectionMaker ( )
inlinevirtual

Definition at line 43 of file SoftMuonObjectCollectionMaker.h.

43 {}

◆ SoftMuonObjectCollectionMaker() [2/3]

top::SoftMuonObjectCollectionMaker::SoftMuonObjectCollectionMaker ( const SoftMuonObjectCollectionMaker rhs)
delete

◆ SoftMuonObjectCollectionMaker() [3/3]

top::SoftMuonObjectCollectionMaker::SoftMuonObjectCollectionMaker ( SoftMuonObjectCollectionMaker &&  rhs)
delete

Member Function Documentation

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyArrayType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

172  {
173  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
174  hndl.value(),
175  hndl.documentation());
176 
177  }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleKeyType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

158  {
159  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
160  hndl.value(),
161  hndl.documentation());
162 
163  }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl,
const SG::VarHandleType  
)
inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

186  {
187  return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
188  hndl.value(),
189  hndl.documentation());
190  }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T > &  t,
const SG::NotHandleType  
)
inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

200  {
201  return PBASE::declareProperty(t);
202  }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleBase hndl,
const std::string &  doc,
const SG::VarHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

249  {
250  this->declare(hndl.vhKey());
251  hndl.vhKey().setOwner(this);
252 
253  return PBASE::declareProperty(name,hndl,doc);
254  }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleKey hndl,
const std::string &  doc,
const SG::VarHandleKeyType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
hndlObject holding the property value.
docDocumentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

225  {
226  this->declare(hndl);
227  hndl.setOwner(this);
228 
229  return PBASE::declareProperty(name,hndl,doc);
230  }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
SG::VarHandleKeyArray hndArr,
const std::string &  doc,
const SG::VarHandleKeyArrayType  
)
inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

263  {
264 
265  // std::ostringstream ost;
266  // ost << Algorithm::name() << " VHKA declareProp: " << name
267  // << " size: " << hndArr.keys().size()
268  // << " mode: " << hndArr.mode()
269  // << " vhka size: " << m_vhka.size()
270  // << "\n";
271  // debug() << ost.str() << endmsg;
272 
273  hndArr.setOwner(this);
274  m_vhka.push_back(&hndArr);
275 
276  Gaudi::Details::PropertyBase* p = PBASE::declareProperty(name, hndArr, doc);
277  if (p != 0) {
278  p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
279  } else {
280  ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray "
281  << name);
282  }
283 
284  return p;
285 
286  }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc,
const SG::NotHandleType  
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

337  {
338  return PBASE::declareProperty(name, property, doc);
339  }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( const std::string &  name,
T &  property,
const std::string &  doc = "none" 
)
inlineinherited

Declare a new Gaudi property.

Parameters
nameName of the property.
propertyObject holding the property value.
docDocumentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

355  {
356  typedef typename SG::HandleClassifier<T>::type htype;
357  return declareProperty (name, property, doc, htype());
358  }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > &  t)
inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

145  {
146  typedef typename SG::HandleClassifier<T>::type htype;
148  }

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

◆ evtStore() [1/2]

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

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const
inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode top::SoftMuonObjectCollectionMaker::execute ( bool  executeNominal)

– Get base muons and tracks from xAOD –///

– Loop over all systematics –///

– if executeNominal, skip other systematics (and vice-versa) –///

– Tell tool which systematic to use –///

– Shallow copy of the xAOD –///

– Loop over the xAOD Container and apply corrections–///

– Apply momentum correction –///

– set links to original objects ///

– Save corrected xAOD Container to StoreGate / TStore –///

Definition at line 72 of file SoftMuonObjectCollectionMaker.cxx.

72  {
73  const xAOD::EventInfo* eventInfo(nullptr);
74 
75  top::check(evtStore()->retrieve(eventInfo, m_config->sgKeyEventInfo()), "Failed to retrieve EventInfo");
76  const float beam_pos_sigma_x = eventInfo->beamPosSigmaX();
77  const float beam_pos_sigma_y = eventInfo->beamPosSigmaY();
78  const float beam_pos_sigma_xy = eventInfo->beamPosSigmaXY();
79 
81  const xAOD::MuonContainer* xaod(nullptr);
82 
83  top::check(evtStore()->retrieve(xaod, m_config->sgKeyMuons()), "Failed to retrieve Soft Muons"); //we use sgKeyMuons and not sgKeySoftMuons on purpose to use the same collection for muons and soft muons
84 
86  for (auto systematic : m_specifiedSystematics) {
88  if (executeNominal && !m_config->isSystNominal(m_config->systematicName(systematic.hash()))) continue;
89  if (!executeNominal && m_config->isSystNominal(m_config->systematicName(systematic.hash()))) continue;
90 
92  top::check(m_calibrationTool->applySystematicVariation(systematic), "Failed to applySystematicVariation");
93 
95  std::pair< xAOD::MuonContainer*,
96  xAOD::ShallowAuxContainer* > shallow_xaod_copy = xAOD::shallowCopyContainer(*xaod);
97 
99  for (xAOD::Muon* muon : *(shallow_xaod_copy.first)) {
100 
102  if (muon->primaryTrackParticle()) {
103  top::check(m_calibrationTool->applyCorrection(*muon), "Failed to applyCorrection");
104 
105  // don't do the decorations unless the muons are at least Loose
106  // this is because it may fail if the muons are at just VeryLoose
107  if (m_muonSelectionToolVeryLooseVeto->accept(*muon)||(m_config->softmuonUseLowPt() && m_softmuonSelectionTool->accept(*muon))) {
108  double d0sig = xAOD::TrackingHelpers::d0significance(muon->primaryTrackParticle(),
109  beam_pos_sigma_x,
110  beam_pos_sigma_y,
111  beam_pos_sigma_xy);
112  muon->auxdecor<float>("d0sig") = d0sig;
113 
114  if (eventInfo->isAvailable<float>("AnalysisTop_PRIVTX_z_position")) {
115  float vtx_z = eventInfo->auxdata<float>("AnalysisTop_PRIVTX_z_position");
116  float delta_z0 = muon->primaryTrackParticle()->z0() + muon->primaryTrackParticle()->vz() - vtx_z;
117  muon->auxdecor<float>("delta_z0") = delta_z0;
118  muon->auxdecor<float>("delta_z0_sintheta") = delta_z0 * std::sin(muon->primaryTrackParticle()->theta());
119  }
120  }
121  }//end of if (muon->primaryTrackParticle())
122 
123  }//end of loop on muons
124 
126  bool setLinks = xAOD::setOriginalObjectLink(*xaod, *shallow_xaod_copy.first);
127  if (!setLinks) {
128  ATH_MSG_ERROR(" Cannot set original object links for soft muons");
129  return StatusCode::FAILURE;
130  }
131 
133  std::string outputSGKey = m_config->sgKeySoftMuons(systematic.hash());
134  std::string outputSGKeyAux = outputSGKey + "Aux.";
135 
136  StatusCode save = evtStore()->tds()->record(shallow_xaod_copy.first, outputSGKey);
137  StatusCode saveAux = evtStore()->tds()->record(shallow_xaod_copy.second, outputSGKeyAux);
138  if (!save || !saveAux) {
139  return StatusCode::FAILURE;
140  }
141  } // Loop over all systematics
142 
143  return StatusCode::SUCCESS;
144  }

◆ 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
ptrThe 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.

119  {
120 
121 #ifdef XAOD_STANDALONE
122  // In case we use @c xAOD::TEvent, we have a direct function call
123  // for this.
124  return evtStore()->event()->getKey( ptr );
125 #else
126  const SG::DataProxy* proxy = evtStore()->proxy( ptr );
127  return ( proxy == nullptr ? 0 : proxy->sgkey() );
128 #endif // XAOD_STANDALONE
129  }

◆ 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
ptrThe 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.

106  {
107 
108 #ifdef XAOD_STANDALONE
109  // In case we use @c xAOD::TEvent, we have a direct function call
110  // for this.
111  return evtStore()->event()->getName( ptr );
112 #else
113  const SG::DataProxy* proxy = evtStore()->proxy( ptr );
114  static const std::string dummy = "";
115  return ( proxy == nullptr ? dummy : proxy->name() );
116 #endif // XAOD_STANDALONE
117  }

◆ getProperty()

template<class T >
const T* asg::AsgTool::getProperty ( const std::string &  name) const
inherited

Get one of the tool's properties.

◆ initialize()

StatusCode top::SoftMuonObjectCollectionMaker::initialize ( )
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...

– Set Systematics Information –///

Reimplemented from asg::AsgTool.

Definition at line 37 of file SoftMuonObjectCollectionMaker.cxx.

37  {
38  ATH_MSG_INFO(" top::SoftMuonObjectCollectionMaker initialize");
39 
40  top::check(m_calibrationTool.retrieve(), "Failed to retrieve muon calibration tool");
41  top::check(m_muonSelectionToolVeryLooseVeto.retrieve(), "Failed to retrieve Selection Tool");
42  top::check(m_softmuonSelectionTool.retrieve(),"Failed to retrieve Selection Tool");
43 
45  const std:: string& syststr = m_config->systematics();
46  std::set<std::string> syst;
47 
48  if (!m_config->isSystNominal(syststr) && !m_config->isSystAll(syststr)) {
49  bool ok = m_config->getSystematicsList(syststr, syst);
50  if (!ok) {
51  ATH_MSG_ERROR(" top::SoftMuonObjectCollectionMaker could not determine systematic list");
52  return StatusCode::FAILURE;
53  }
54  //here the idea is that if the user specifies AllXXX, we leave syst as an empty string, so that all recommended CP
55  // systematics are then used
56  if (m_config->contains(syst, "AllMuons")) {
57  syst.clear();
58  }
59  if (m_config->contains(syst, "AllSoftMuons")) {
60  syst.clear();
61  }
62  }
63 
65 
66  m_config->systematicsSoftMuons(specifiedSystematics());
67 
68  ATH_MSG_INFO(" top::SoftMuonObjectCollectionMaker completed initialize");
69  return StatusCode::SUCCESS;
70  }

◆ 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() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

24  {
25  return this->msgStream();
26  }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level  lvl) const
inlineinherited

Definition at line 27 of file AthCommonMsg.h.

27  {
28  return this->msgStream(lvl);
29  }

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

101  {
102 
103  return MSG::name( msg().level() );
104  }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level  lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30  {
31  return this->msgLevel(lvl);
32  }

◆ operator=()

SoftMuonObjectCollectionMaker& top::SoftMuonObjectCollectionMaker::operator= ( const SoftMuonObjectCollectionMaker rhs)
delete

◆ 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

◆ printout()

StatusCode top::SoftMuonObjectCollectionMaker::printout ( )

– Loop over all systematics –///

Definition at line 146 of file SoftMuonObjectCollectionMaker.cxx.

146  {
148  for (auto systematic : m_specifiedSystematics) {
149  const xAOD::MuonContainer* xaod(nullptr);
150  top::check(evtStore()->retrieve(xaod, m_config->sgKeySoftMuons(
151  systematic.hash())), "Failed to retrieve Soft Muons");
152 
153  ATH_MSG_INFO(" Soft Muons with sgKey = " << m_config->sgKeySoftMuons(systematic.hash()));
154  for (auto muon : *xaod) {
155  ATH_MSG_INFO(" SOFT MU pT , eta = " << muon->pt() << " , " << muon->eta());
156  }
157  }
158 
159  return StatusCode::SUCCESS;
160  }

◆ recommendedSystematics()

const std::list<CP::SystematicSet>& top::SoftMuonObjectCollectionMaker::recommendedSystematics ( ) const
inline

Definition at line 59 of file SoftMuonObjectCollectionMaker.h.

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

381  {
382  h.renounce();
383  PBASE::renounce (h);
384  }

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

364  {
365  handlesArray.renounce();
366  }

◆ specifiedSystematics() [1/2]

virtual const std::list<CP::SystematicSet>& top::SoftMuonObjectCollectionMaker::specifiedSystematics ( ) const
inlinevirtual

Definition at line 56 of file SoftMuonObjectCollectionMaker.h.

56 {return m_specifiedSystematics;}

◆ specifiedSystematics() [2/2]

void top::SoftMuonObjectCollectionMaker::specifiedSystematics ( const std::set< std::string > &  specifiedSystematics)
protectedvirtual

– Get the recommended systematics from the tool, in std::vector format –///

MC only –///

– Are we only doing Nominal? Did the user specify specific systematics to use? –///

Definition at line 162 of file SoftMuonObjectCollectionMaker.cxx.

162  {
164  const std::vector<CP::SystematicSet> systList = CP::make_systematics_vector(
165  m_calibrationTool->recommendedSystematics());
166 
167  for (const CP::SystematicSet& s : systList) {
168 
169  if(!m_config->getTreeFilter()->filterTree(s.name())) continue; // Applying tree filter
170  m_recommendedSystematics.push_back(s);
171  if (s.name() == "") {
172  m_specifiedSystematics.push_back(s);
173  }
174 
176  if (m_config->isMC()) {
178  if (!m_config->isSystNominal(m_config->systematics())) {
179  if (specifiedSystematics.size() == 0) {
180  m_specifiedSystematics.push_back(s);
181  }
182  if (specifiedSystematics.size() > 0) {
183  for (auto i : specifiedSystematics) {
184  TreeFilter filter(i);
185  if (!filter.filterTree(s.name())) {
186  m_specifiedSystematics.push_back(s);
187  }
188  }
189  }
190  }
191  }
192  }
194  m_recommendedSystematics.unique();
195  m_specifiedSystematics.sort();
196  m_specifiedSystematics.unique();
197  }

◆ 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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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

308  {
309  // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310  // << " size: " << m_vhka.size() << endmsg;
311  for (auto &a : m_vhka) {
312  std::vector<SG::VarHandleKey*> keys = a->keys();
313  for (auto k : keys) {
314  k->setOwner(this);
315  }
316  }
317  }

Member Data Documentation

◆ m_calibrationTool

ToolHandle<CP::IMuonCalibrationAndSmearingTool> top::SoftMuonObjectCollectionMaker::m_calibrationTool
private

Definition at line 69 of file SoftMuonObjectCollectionMaker.h.

◆ m_config

std::shared_ptr<top::TopConfig> top::SoftMuonObjectCollectionMaker::m_config
private

Definition at line 65 of file SoftMuonObjectCollectionMaker.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_muonSelectionToolVeryLooseVeto

ToolHandle<CP::IMuonSelectionTool> top::SoftMuonObjectCollectionMaker::m_muonSelectionToolVeryLooseVeto
private

Definition at line 73 of file SoftMuonObjectCollectionMaker.h.

◆ m_recommendedSystematics

std::list<CP::SystematicSet> top::SoftMuonObjectCollectionMaker::m_recommendedSystematics
private

Definition at line 67 of file SoftMuonObjectCollectionMaker.h.

◆ m_softmuonSelectionTool

ToolHandle<CP::IMuonSelectionTool> top::SoftMuonObjectCollectionMaker::m_softmuonSelectionTool
private

Definition at line 73 of file SoftMuonObjectCollectionMaker.h.

◆ m_specifiedSystematics

std::list<CP::SystematicSet> top::SoftMuonObjectCollectionMaker::m_specifiedSystematics
private

Definition at line 66 of file SoftMuonObjectCollectionMaker.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:
python.PyKernel.retrieve
def retrieve(aClass, aKey=None)
Definition: PyKernel.py:110
xAOD::muon
@ muon
Definition: TrackingPrimitives.h:195
asg::AsgTool
Base class for the dual-use tool implementation classes.
Definition: AsgTool.h:47
python.SystemOfUnits.s
int s
Definition: SystemOfUnits.py:131
StateLessPT_NewConfig.proxy
proxy
Definition: StateLessPT_NewConfig.py:392
python.PerfMonSerializer.p
def p
Definition: PerfMonSerializer.py:743
ATH_MSG_INFO
#define ATH_MSG_INFO(x)
Definition: AthMsgStreamMacros.h:31
CP::make_systematics_vector
std::vector< CP::SystematicSet > make_systematics_vector(const SystematicSet &systematics)
utility functions for working with systematics
Definition: SystematicsUtil.cxx:25
AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
Definition: AthCommonDataStore.h:145
xAOD::TrackingHelpers::d0significance
double d0significance(const xAOD::TrackParticle *tp, double d0_uncert_beam_spot_2)
Definition: TrackParticlexAODHelpers.cxx:42
top::SoftMuonObjectCollectionMaker::m_recommendedSystematics
std::list< CP::SystematicSet > m_recommendedSystematics
Definition: SoftMuonObjectCollectionMaker.h:67
xAOD::ShallowAuxContainer
Class creating a shallow copy of an existing auxiliary container.
Definition: ShallowAuxContainer.h:54
CP::SystematicSet
Class to wrap a set of SystematicVariations.
Definition: SystematicSet.h:31
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
Definition: AthCommonDataStore.h:390
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
std::vector< SG::VarHandleKeyArray * > m_vhka
Definition: AthCommonDataStore.h:398
top::SoftMuonObjectCollectionMaker::specifiedSystematics
virtual const std::list< CP::SystematicSet > & specifiedSystematics() const
Definition: SoftMuonObjectCollectionMaker.h:56
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
top::SoftMuonObjectCollectionMaker::m_config
std::shared_ptr< top::TopConfig > m_config
Definition: SoftMuonObjectCollectionMaker.h:65
xAOD::Muon_v1
Class describing a Muon.
Definition: Muon_v1.h:38
python.iconfTool.models.loaders.level
level
Definition: loaders.py:20
SG::VarHandleKeyArray::setOwner
virtual void setOwner(IDataHandleHolder *o)=0
covarianceTool.filter
filter
Definition: covarianceTool.py:514
AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Definition: AthCommonDataStore.h:85
checkTP.save
def save(self, fileName="./columbo.out")
Definition: checkTP.py:178
AthCommonDataStore
Definition: AthCommonDataStore.h:52
ATH_MSG_ERROR
#define ATH_MSG_ERROR(x)
Definition: AthMsgStreamMacros.h:33
lumiFormat.i
int i
Definition: lumiFormat.py:92
EL::StatusCode
::StatusCode StatusCode
StatusCode definition for legacy code.
Definition: PhysicsAnalysis/D3PDTools/EventLoop/EventLoop/StatusCode.h:22
top::check
void check(bool thingToCheck, const std::string &usefulFailureMessage)
Print an error message and terminate if thingToCheck is false.
Definition: EventTools.cxx:15
python.xAODType.dummy
dummy
Definition: xAODType.py:4
MSG::name
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
Definition: MsgLevel.cxx:19
AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
Definition: AthCommonDataStore.h:393
DataVector
Derived DataVector<T>.
Definition: DataVector.h:581
top::SoftMuonObjectCollectionMaker::m_calibrationTool
ToolHandle< CP::IMuonCalibrationAndSmearingTool > m_calibrationTool
Definition: SoftMuonObjectCollectionMaker.h:69
SG::VarHandleKeyArray::renounce
virtual void renounce()=0
SG::HandleClassifier::type
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
Definition: HandleClassifier.h:54
merge_scale_histograms.doc
string doc
Definition: merge_scale_histograms.py:9
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:192
xAOD::shallowCopyContainer
std::pair< std::unique_ptr< T >, std::unique_ptr< ShallowAuxContainer > > shallowCopyContainer(const T &cont, [[maybe_unused]] const EventContext &ctx)
Function making a shallow copy of a constant container.
Definition: ShallowCopy.h:110
xAOD::EventInfo_v1
Class describing the basic event information.
Definition: EventInfo_v1.h:43
a
TList * a
Definition: liststreamerinfos.cxx:10
h
xAOD::setOriginalObjectLink
bool setOriginalObjectLink(const IParticle &original, IParticle &copy)
This function should be used by CP tools when they make a deep copy of an object in their correctedCo...
Definition: IParticleHelpers.cxx:30
AthCommonMsg< AlgTool >::msg
MsgStream & msg() const
Definition: AthCommonMsg.h:24
top::SoftMuonObjectCollectionMaker::m_muonSelectionToolVeryLooseVeto
ToolHandle< CP::IMuonSelectionTool > m_muonSelectionToolVeryLooseVeto
Definition: SoftMuonObjectCollectionMaker.h:73
SG::VarHandleBase::vhKey
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Definition: StoreGate/src/VarHandleBase.cxx:616
declareProperty
#define declareProperty(n, p, h)
Definition: BaseFakeBkgTool.cxx:15
python.Bindings.keys
keys
Definition: Control/AthenaPython/python/Bindings.py:790
drawFromPickle.sin
sin
Definition: drawFromPickle.py:36
SG::DataProxy
Definition: DataProxy.h:44
AthCommonDataStore::declareGaudiProperty
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition: AthCommonDataStore.h:156
top::SoftMuonObjectCollectionMaker::m_specifiedSystematics
std::list< CP::SystematicSet > m_specifiedSystematics
Definition: SoftMuonObjectCollectionMaker.h:66
fitman.k
k
Definition: fitman.py:528
top::SoftMuonObjectCollectionMaker::m_softmuonSelectionTool
ToolHandle< CP::IMuonSelectionTool > m_softmuonSelectionTool
Definition: SoftMuonObjectCollectionMaker.h:73