|
ATLAS Offline Software
|
General track-vertex association tool.
More...
#include <TrackVertexAssociationTool.h>
|
| TrackVertexAssociationTool (const std::string &name) |
|
virtual StatusCode | initialize () override |
| Dummy implementation of the initialisation function. More...
|
|
virtual bool | isCompatible (const xAOD::TrackParticle &trk, const xAOD::Vertex &vx) const override |
| This function just return the decision of whether the track is matched to the Vertex Not sure whether the track is matched to best choice. More...
|
|
virtual bool | isCompatible (const xAOD::TrackParticle &trk) const override |
|
virtual xAOD::TrackVertexAssociationMap | getMatchMap (std::vector< const xAOD::TrackParticle * > &trk_list, std::vector< const xAOD::Vertex * > &vx_list) const override |
|
virtual xAOD::TrackVertexAssociationMap | getMatchMap (const xAOD::TrackParticleContainer &trkCont, const xAOD::VertexContainer &vxCont) const override |
|
virtual ElementLink< xAOD::VertexContainer > | getUniqueMatchVertexLink (const xAOD::TrackParticle &trk, const xAOD::VertexContainer &vxCont) const override |
| This functions will return the best matched vertex. More...
|
|
virtual const xAOD::Vertex * | getUniqueMatchVertex (const xAOD::TrackParticle &trk, std::vector< const xAOD::Vertex * > &vx_list) const override |
|
virtual xAOD::TrackVertexAssociationMap | getUniqueMatchMap (std::vector< const xAOD::TrackParticle * > &trk_list, std::vector< const xAOD::Vertex * > &vx_list) const override |
| This functions related to the previous functions, will return a 2D vector to store the best matched tracks for each vertex. More...
|
|
virtual xAOD::TrackVertexAssociationMap | getUniqueMatchMap (const xAOD::TrackParticleContainer &trkCont, const xAOD::VertexContainer &vxCont) const override |
|
template<typename U , typename V > |
xAOD::TrackVertexAssociationMap | getMatchMapInternal (U &trk_list, V &vx_list) 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 |
|
|
bool | isMatch (const xAOD::TrackParticle &trk, const xAOD::Vertex &vx, const xAOD::EventInfo *evtInfo=nullptr) const |
|
template<typename T , typename U > |
xAOD::TrackVertexAssociationMap | getMatchMapInternal (T &trk_list, U &vx_list) const |
|
template<typename T , typename U > |
xAOD::TrackVertexAssociationMap | getUniqueMatchMapInternal (T &trk_list, U &vx_list) const |
|
template<typename T > |
const xAOD::Vertex * | getUniqueMatchVertexInternal (const xAOD::TrackParticle &trk, T &vx_list) const |
|
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...
|
|
|
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 |
|
|
Gaudi::Property< std::string > | m_wp |
|
Gaudi::Property< float > | m_d0_cut |
|
Gaudi::Property< bool > | m_use_d0sig |
|
Gaudi::Property< float > | m_d0sig_cut |
|
Gaudi::Property< float > | m_dzSinTheta_cut |
|
Gaudi::Property< bool > | m_doUsedInFit |
| Flag to cut on d0sig instead of d0. More...
|
|
Gaudi::Property< bool > | m_doPVPriority |
|
Gaudi::Property< bool > | m_requirePriVtx |
|
Gaudi::Property< std::string > | m_hardScatterDeco {this, "HardScatterLinkDeco", "hardScatterVertexLink"} |
| The decoration name of the ElementLink to the hardscatter vertex (found on xAOD::EventInfo) More...
|
|
SG::ReadHandleKey< xAOD::TrackParticleContainer > | m_trkKey {this, "TrackContName", "InDetTrackParticles"} |
| The name of the xAOD::TrackParticleContainer to access the AMVF vertices+weights for (not actually read). More...
|
|
|
SG::ReadHandleKey< xAOD::EventInfo > | m_eventInfo {this, "EventInfo", "EventInfo", "EventInfo key"} |
| EventInfo key. More...
|
|
Gaudi::Property< std::string > | m_vtxDecoName |
| AMVF vertices decoration key. More...
|
|
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer > | m_vtxDecoKey {this, "AMVFVerticesKey", "" , "Overwritten with the <AMVFVerticesDeco> property"} |
|
std::unique_ptr< AMVFVerticesAcc > | m_vtxDecoAcc {nullptr} |
| AMVF vertices decoration accessor. More...
|
|
Gaudi::Property< std::string > | m_wgtDecoName |
| AMVF weights decoration key. More...
|
|
SG::ReadDecorHandleKey< xAOD::TrackParticleContainer > | m_wgtDecoKey {this, "MVWeightKey", "" , "Overwritten with the <AMVFWeightsDeco> property"} |
|
std::unique_ptr< AMVFWeightsAcc > | m_wgtDecoAcc {nullptr} |
| AMVF weights decoration accessor. More...
|
|
SG::ReadDecorHandleKey< xAOD::EventInfo > | m_hardScatterDecoKey |
| Hardscatter vertex link key. More...
|
|
std::unique_ptr< WorkingPoint > | m_applicator {nullptr} |
| Stored WorkingPoint class. More...
|
|
General track-vertex association tool.
Supported properties (set via setProperty):
- WorkingPoint: Working Point to operate on.
- d0_cut: Cut on d0. Not applied if set to -1.
- use_d0sig: flag to cut on d0sig instead of d0.
- d0sig_cut: Cut on d0Sig. Not applied if set to -1.
- dzSinTheta_cut: Cut on |dz*sinTheta| (in mm). Not applied if set to -1.
- doUsedInFit: Control whether to allow for a MatchStatus of UsedInFit.
- requirePriVtx: Control whether a vertex must be VxType::PriVtx in order for a track (not UsedInFit) to be uniquely matched to it.
- HardScatterLinkDeco: The decoration name of the ElementLink to the hardscatter vertex (found on xAOD::EventInfo)
To apply the recommendations, please visit https://twiki.cern.ch/twiki/bin/view/AtlasProtected/TrackingCPRecsEarly2018#Track_to_Vertex_Association_Tool
Definition at line 51 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/TrackVertexAssociationTool/TrackVertexAssociationTool.h.
◆ AMVFVerticesAcc
◆ AMVFWeightsAcc
◆ StoreGateSvc_t
◆ TrackVertexAssociationTool()
TrackVertexAssociationTool::TrackVertexAssociationTool |
( |
const std::string & |
name | ) |
|
◆ declareGaudiProperty() [1/4]
specialization for handling Gaudi::Property<SG::VarHandleKeyArray>
Definition at line 170 of file AthCommonDataStore.h.
175 hndl.documentation());
◆ declareGaudiProperty() [2/4]
specialization for handling Gaudi::Property<SG::VarHandleKey>
Definition at line 156 of file AthCommonDataStore.h.
161 hndl.documentation());
◆ declareGaudiProperty() [3/4]
specialization for handling Gaudi::Property<SG::VarHandleBase>
Definition at line 184 of file AthCommonDataStore.h.
189 hndl.documentation());
◆ declareGaudiProperty() [4/4]
◆ declareProperty() [1/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
hndl | Object holding the property value. |
doc | Documentation 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.
250 this->declare(hndl.
vhKey());
251 hndl.
vhKey().setOwner(
this);
253 return PBASE::declareProperty(
name,hndl,
doc);
◆ declareProperty() [2/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
hndl | Object holding the property value. |
doc | Documentation 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.
229 return PBASE::declareProperty(
name,hndl,
doc);
◆ declareProperty() [3/6]
◆ declareProperty() [4/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
property | Object holding the property value. |
doc | Documentation 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.
338 return PBASE::declareProperty(
name, property,
doc);
◆ declareProperty() [5/6]
Declare a new Gaudi property.
- Parameters
-
name | Name of the property. |
property | Object holding the property value. |
doc | Documentation 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.
◆ declareProperty() [6/6]
◆ detStore()
◆ evtStore() [1/2]
◆ evtStore() [2/2]
◆ extraDeps_update_handler()
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()
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.
121 #ifdef XAOD_STANDALONE
127 return (
proxy ==
nullptr ? 0 :
proxy->sgkey() );
128 #endif // XAOD_STANDALONE
◆ getMatchMap() [1/2]
◆ getMatchMap() [2/2]
◆ getMatchMapInternal() [1/2]
template<typename T , typename U >
◆ getMatchMapInternal() [2/2]
template<typename U , typename V >
◆ 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.
108 #ifdef XAOD_STANDALONE
114 static const std::string
dummy =
"";
116 #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.
◆ getUniqueMatchMap() [1/2]
◆ getUniqueMatchMap() [2/2]
◆ getUniqueMatchMapInternal()
template<typename T , typename U >
◆ getUniqueMatchVertex()
◆ getUniqueMatchVertexInternal()
◆ getUniqueMatchVertexLink()
◆ initialize()
StatusCode TrackVertexAssociationTool::initialize |
( |
| ) |
|
|
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 251 of file InnerDetector/InDetRecTools/TrackVertexAssociationTool/Root/TrackVertexAssociationTool.cxx.
253 static const std::set<std::string> run_2_wps = {
"Loose",
"Nominal",
"Tight",
"Electron",
"Muon",
"Old_Loose",
"Old_Nominal",
"Old_Tight",
"Old_Electron",
"Old_Muon"};
255 if (run_2_wps.count(
wp)) {
256 std::string
prefix =
"Old_";
258 ATH_MSG_WARNING(
"WorkingPoint '" <<
m_wp <<
"' corresponds to a Run 2 working point and is not recommended.");
261 ATH_MSG_WARNING(
"WorkingPoint '" <<
m_wp <<
"' corresponds to a Run 2 working point and is not recommended - remapping to 'Old_" <<
m_wp <<
"' (same definition, however).");
262 wp.insert(0,
"Old_");
281 else
if (
m_wp == "Custom") {
282 m_applicator = std::unique_ptr<CP::TrackVertexAssociationTool::WorkingPoint>(
286 ATH_MSG_ERROR(
"Invalid TVA working point '" <<
m_wp <<
"' - for a custom configuration, please provide 'Custom' for the 'WorkingPoint' property.");
287 return StatusCode::FAILURE;
290 if (
m_wp ==
"Custom") {
291 ATH_MSG_INFO(
"TVA working point 'Custom' provided - tool properties are initialized to default values unless explicitly set by the user.");
294 ATH_MSG_INFO(
"TVA working point '" <<
m_wp <<
"' provided - tool properties have been configured accordingly.");
322 return StatusCode::SUCCESS;
◆ inputHandles()
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.
◆ isCompatible() [1/2]
◆ isCompatible() [2/2]
◆ isMatch()
◆ msg() [1/2]
◆ msg() [2/2]
◆ 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.
◆ msgLvl()
◆ outputHandles()
Return this algorithm's output handles.
We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.
◆ print()
void asg::AsgTool::print |
( |
| ) |
const |
|
virtualinherited |
Print the state of the tool.
Implements asg::IAsgTool.
Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.
Definition at line 131 of file AsgTool.cxx.
◆ renounce()
◆ renounceArray()
◆ sysInitialize()
◆ sysStart()
Handle START transition.
We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.
◆ updateVHKA()
◆ m_applicator
std::unique_ptr<WorkingPoint> CP::TrackVertexAssociationTool::m_applicator {nullptr} |
|
private |
◆ m_d0_cut
Gaudi::Property<float> CP::TrackVertexAssociationTool::m_d0_cut |
|
private |
◆ m_d0sig_cut
Gaudi::Property<float> CP::TrackVertexAssociationTool::m_d0sig_cut |
|
private |
◆ m_detStore
◆ m_doPVPriority
Gaudi::Property<bool> CP::TrackVertexAssociationTool::m_doPVPriority |
|
private |
◆ m_doUsedInFit
Gaudi::Property<bool> CP::TrackVertexAssociationTool::m_doUsedInFit |
|
private |
◆ m_dzSinTheta_cut
Gaudi::Property<float> CP::TrackVertexAssociationTool::m_dzSinTheta_cut |
|
private |
◆ m_eventInfo
◆ m_evtStore
◆ m_hardScatterDeco
Gaudi::Property<std::string> CP::TrackVertexAssociationTool::m_hardScatterDeco {this, "HardScatterLinkDeco", "hardScatterVertexLink"} |
|
private |
◆ m_hardScatterDecoKey
◆ m_requirePriVtx
Gaudi::Property<bool> CP::TrackVertexAssociationTool::m_requirePriVtx |
|
private |
◆ m_trkKey
◆ m_use_d0sig
Gaudi::Property<bool> CP::TrackVertexAssociationTool::m_use_d0sig |
|
private |
◆ m_varHandleArraysDeclared
◆ m_vhka
◆ m_vtxDecoAcc
std::unique_ptr<AMVFVerticesAcc> CP::TrackVertexAssociationTool::m_vtxDecoAcc {nullptr} |
|
private |
◆ m_vtxDecoKey
◆ m_vtxDecoName
Gaudi::Property<std::string> CP::TrackVertexAssociationTool::m_vtxDecoName |
|
private |
◆ m_wgtDecoAcc
std::unique_ptr<AMVFWeightsAcc> CP::TrackVertexAssociationTool::m_wgtDecoAcc {nullptr} |
|
private |
◆ m_wgtDecoKey
◆ m_wgtDecoName
Gaudi::Property<std::string> CP::TrackVertexAssociationTool::m_wgtDecoName |
|
private |
◆ m_wp
Gaudi::Property<std::string> CP::TrackVertexAssociationTool::m_wp |
|
private |
The documentation for this class was generated from the following files:
bool toContainedElement(BaseConstReference data, ElementType element, IProxyDict *sg=0)
Set from element pointer and a reference to the container (storable)
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T > &t)
StoreGateSvc_t m_evtStore
Pointer to StoreGate (event store by default)
std::vector< SG::VarHandleKeyArray * > m_vhka
std::map< const xAOD::Vertex *, xAOD::TrackVertexAssociationList > TrackVertexAssociationMap
const std::string & key() const
Return the StoreGate ID for the referenced object.
VxType::VertexType vertexType() const
The type of the vertex.
@ NoVtx
Dummy vertex. TrackParticle was not used in vertex fit.
bool isValid() const
Test to see if the link can be dereferenced.
virtual void setOwner(IDataHandleHolder *o)=0
ServiceHandle< StoreGateSvc > & evtStore()
The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
Handle class for reading a decoration on an object.
const std::string & name(Level lvl)
Convenience function for translating message levels to strings.
StoreGateSvc_t m_detStore
Pointer to StoreGate (detector store by default)
StatusCode initialize(bool used=true)
If this object is used as a property, then this should be called during the initialize phase.
virtual void renounce()=0
std::conditional< std::is_base_of< SG::VarHandleKeyArray, T >::value, VarHandleKeyArrayType, type2 >::type type
ElementLink implementation for ROOT usage.
std::vector< const xAOD::TrackParticle * > TrackVertexAssociationList
Class describing the basic event information.
Class describing a Vertex.
#define ATH_MSG_WARNING(x)
SG::VarHandleKey & vhKey()
Return a non-const reference to the HandleKey.
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>