ATLAS Offline Software
Public Member Functions | List of all members
Trk::IDetailedTrackTruthBuilder Class Referenceabstract

Provides interface for tool to return a "detailed" track truth map. More...

#include <IDetailedTrackTruthBuilder.h>

Inheritance diagram for Trk::IDetailedTrackTruthBuilder:
Collaboration diagram for Trk::IDetailedTrackTruthBuilder:

Public Member Functions

virtual void buildDetailedTrackTruth (DetailedTrackTruthCollection *output, const TrackCollection &tracks, const std::vector< const PRD_MultiTruthCollection * > &prdTruth, const EventContext &ctx) const =0
 The main tool method. More...
 
 DeclareInterfaceID (Trk::IDetailedTrackTruthBuilder, 1, 0)
 

Detailed Description

Provides interface for tool to return a "detailed" track truth map.

Author
Andrei Gaponenko agapo.nosp@m.nenk.nosp@m.o@lbl.nosp@m..gov

Definition at line 22 of file IDetailedTrackTruthBuilder.h.

Member Function Documentation

◆ buildDetailedTrackTruth()

virtual void Trk::IDetailedTrackTruthBuilder::buildDetailedTrackTruth ( DetailedTrackTruthCollection output,
const TrackCollection tracks,
const std::vector< const PRD_MultiTruthCollection * > &  prdTruth,
const EventContext &  ctx 
) const
pure virtual

The main tool method.

Fills a pre-existing DetailedTrackTruthCollection pointed to by output with data for the tracks, using the prdTruth collections. pdrTruth is allowed to contain null pointers. Each non-null pointer must correspond to collection for a single subdetector.

This method does not impose a memory management model on the caller. (As e.g. returning an object on the heap would do.) The caller can use it to work with stack or heap objects. Call with output==0 is a no-op. (But output should not be garbage, it must be initialized.)

Adding an int to tell it to only calculate the detailed track truth for certain tracks: used only by track overlay

◆ DeclareInterfaceID()

Trk::IDetailedTrackTruthBuilder::DeclareInterfaceID ( Trk::IDetailedTrackTruthBuilder  ,
,
 
)

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