LDMX Software
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
tracking::reco::TrackingGeometryUser Class Reference

a helper base class providing some methods to shorten access to common conditions used within the tracking reconstruction More...

#include <TrackingGeometryUser.h>

Public Member Functions

 TrackingGeometryUser (const std::string &name, framework::Process &p)
 
- Public Member Functions inherited from framework::Producer
 Producer (const std::string &name, Process &process)
 Class constructor.
 
virtual void produce (Event &event)=0
 Process the event and put new data products into it.
 
virtual void beforeNewRun (ldmx::RunHeader &header)
 Handle allowing producers to modify run headers before the run begins.
 
- Public Member Functions inherited from framework::EventProcessor
 EventProcessor (const std::string &name, Process &process)
 Class constructor.
 
virtual ~EventProcessor ()
 Class destructor.
 
virtual void configure (framework::config::Parameters &parameters)
 Callback for the EventProcessor to configure itself from the given set of parameters.
 
virtual void onNewRun (const ldmx::RunHeader &runHeader)
 Callback for the EventProcessor to take any necessary action when the run being processed changes.
 
virtual void onFileOpen (EventFile &eventFile)
 Callback for the EventProcessor to take any necessary action when a new event input ROOT file is opened.
 
virtual void onFileClose (EventFile &eventFile)
 Callback for the EventProcessor to take any necessary action when a event input ROOT file is closed.
 
virtual void onProcessStart ()
 Callback for the EventProcessor to take any necessary action when the processing of events starts, such as creating histograms.
 
virtual void onProcessEnd ()
 Callback for the EventProcessor to take any necessary action when the processing of events finishes, such as calculating job-summary quantities.
 
template<class T >
const T & getCondition (const std::string &condition_name)
 Access a conditions object for the current event.
 
TDirectory * getHistoDirectory ()
 Access/create a directory in the histogram file for this event processor to create histograms and analysis tuples.
 
void setStorageHint (framework::StorageControl::Hint hint)
 Mark the current event as having the given storage control hint from this module.
 
void setStorageHint (framework::StorageControl::Hint hint, const std::string &purposeString)
 Mark the current event as having the given storage control hint from this module and the given purpose string.
 
int getLogFrequency () const
 Get the current logging frequency from the process.
 
int getRunNumber () const
 Get the run number from the process.
 
std::string getName () const
 Get the processor name.
 
void createHistograms (const std::vector< framework::config::Parameters > &histos)
 Internal function which is used to create histograms passed from the python configuration @parma histos vector of Parameters that configure histograms to create.
 

Protected Member Functions

const Acts::GeometryContext & geometry_context ()
 
const Acts::MagneticFieldContext & magnetic_field_context ()
 
const Acts::CalibrationContext & calibration_context ()
 
const geo::TrackersTrackingGeometrygeometry ()
 
- Protected Member Functions inherited from framework::EventProcessor
void abortEvent ()
 Abort the event immediately.
 

Private Member Functions

template<typename ConditionType >
const ConditionType & getNamedCondition ()
 Templated condition access code for our conditions with static names.
 

Additional Inherited Members

- Static Public Member Functions inherited from framework::EventProcessor
static void declare (const std::string &classname, int classtype, EventProcessorMaker *)
 Internal function which is part of the PluginFactory machinery.
 
- Static Public Attributes inherited from framework::Producer
static const int CLASSTYPE {1}
 Constant used to track EventProcessor types by the PluginFactory.
 
- Protected Attributes inherited from framework::EventProcessor
HistogramHelper histograms_
 Interface class for making and filling histograms.
 
NtupleManagerntuple_ {NtupleManager::getInstance()}
 Manager for any ntuples.
 
logging::logger theLog_
 The logger for this EventProcessor.
 

Detailed Description

a helper base class providing some methods to shorten access to common conditions used within the tracking reconstruction

Definition at line 16 of file TrackingGeometryUser.h.

Constructor & Destructor Documentation

◆ TrackingGeometryUser()

tracking::reco::TrackingGeometryUser::TrackingGeometryUser ( const std::string &  name,
framework::Process p 
)

Definition at line 5 of file TrackingGeometryUser.cxx.

7 : framework::Producer(name, p) {}
Base class for a module which produces a data product.

Member Function Documentation

◆ calibration_context()

const Acts::CalibrationContext & tracking::reco::TrackingGeometryUser::calibration_context ( )
protected

Definition at line 16 of file TrackingGeometryUser.cxx.

16 {
17 return getNamedCondition<geo::CalibrationContext>().get();
18}

◆ geometry()

const geo::TrackersTrackingGeometry & tracking::reco::TrackingGeometryUser::geometry ( )
protected

Definition at line 19 of file TrackingGeometryUser.cxx.

19 {
20 return getNamedCondition<geo::TrackersTrackingGeometry>();
21}

◆ geometry_context()

const Acts::GeometryContext & tracking::reco::TrackingGeometryUser::geometry_context ( )
protected

Definition at line 9 of file TrackingGeometryUser.cxx.

9 {
10 return getNamedCondition<geo::GeometryContext>().get();
11}

◆ getNamedCondition()

template<typename ConditionType >
const ConditionType & tracking::reco::TrackingGeometryUser::getNamedCondition ( )
inlineprivate

Templated condition access code for our conditions with static names.

We assume that the condition has a constant name stored in ConditionType::NAME

Template Parameters
ConditionTypetype of condition we are retrieving
Returns
condition object

Definition at line 37 of file TrackingGeometryUser.h.

37 {
38 return getCondition<ConditionType>(ConditionType::NAME);
39 }

◆ magnetic_field_context()

const Acts::MagneticFieldContext & tracking::reco::TrackingGeometryUser::magnetic_field_context ( )
protected

Definition at line 13 of file TrackingGeometryUser.cxx.

13 {
14 return getNamedCondition<geo::MagneticFieldContext>().get();
15}

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