LDMX Software
tracking::reco::LinearTrackFinder Class Reference

Public Member Functions

 LinearTrackFinder (const std::string &name, framework::Process &process)
 Constructor.
 
virtual ~LinearTrackFinder ()=default
 Destructor.
 
void onProcessEnd () override
 Output event statistics.
 
void configure (framework::config::Parameters &parameters) override
 Configure the processor using the given user specified parameters.
 
void produce (framework::Event &event) override
 Run the processor.
 
- Public Member Functions inherited from tracking::reco::TrackingGeometryUser
 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 process (Event &event) final
 Processing an event for a Producer is calling produce.
 
- Public Member Functions inherited from framework::EventProcessor
 DECLARE_FACTORY (EventProcessor, EventProcessor *, const std::string &, Process &)
 declare that we have a factory for this class
 
 EventProcessor (const std::string &name, Process &process)
 Class constructor.
 
virtual ~EventProcessor ()=default
 Class destructor.
 
virtual void beforeNewRun (ldmx::RunHeader &run_header)
 Callback for Producers to add parameters to the run header before conditions are initialized.
 
virtual void onNewRun (const ldmx::RunHeader &run_header)
 Callback for the EventProcessor to take any necessary action when the run being processed changes.
 
virtual void onFileOpen (EventFile &event_file)
 Callback for the EventProcessor to take any necessary action when a new event input ROOT file is opened.
 
virtual void onFileClose (EventFile &event_file)
 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.
 
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.
 

Private Member Functions

std::vector< ldmx::StraightTrack > findTracks (const std::vector< ldmx::StraightTrack > &track_seeds)
 
bool isPositionUsed (const ldmx::Measurement &measurement, const std::set< std::tuple< float, float, float > > &used_sensor_positions)
 

Private Attributes

int n_events_ {0}
 
double processing_time_ {0.}
 
std::string out_trk_collection_ {"LinearRecoilTracks"}
 
std::string seed_collection_ {"LinearRecoilSeedTracks"}
 
std::string input_pass_name_ {""}
 
int n_seeds_ {0}
 
int n_tracks_ {0}
 

Additional Inherited Members

- Protected Member Functions inherited from tracking::reco::TrackingGeometryUser
const Acts::GeometryContext & geometryContext ()
 
const Acts::MagneticFieldContext & magneticFieldContext ()
 
const Acts::CalibrationContext & calibrationContext ()
 
const geo::TrackersTrackingGeometry & geometry ()
 
void loadBField (const std::string &path, const BFieldDistortion &distortion={})
 Load the interpolated B-field map from path and cache it.
 
void loadBField (const BFieldDistortion &distortion={})
 Load B-field from the path recorded in the detector GDML.
 
std::shared_ptr< Acts::MagneticFieldProvider > bField () const
 Return the loaded B-field provider.
 
- Protected Member Functions inherited from framework::EventProcessor
void abortEvent ()
 Abort the event immediately.
 
- Static Protected Member Functions inherited from tracking::reco::TrackingGeometryUser
static BFieldDistortion bFieldDistortion (const framework::config::Parameters &parameters)
 Build a BFieldDistortion from processor configuration.
 
- Protected Attributes inherited from framework::EventProcessor
HistogramPool histograms_
 helper object for making and filling histograms
 
NtupleManager & ntuple_ {NtupleManager::getInstance()}
 Manager for any ntuples.
 
logging::logger the_log_
 The logger for this EventProcessor.
 

Detailed Description

Definition at line 19 of file LinearTrackFinder.h.

Constructor & Destructor Documentation

◆ LinearTrackFinder()

tracking::reco::LinearTrackFinder::LinearTrackFinder ( const std::string & name,
framework::Process & process )

Constructor.

Parameters
nameThe name of the instance of this object.
processThe process running this producer.

Definition at line 13 of file LinearTrackFinder.cxx.

15 : TrackingGeometryUser(name, process) {}
virtual void process(Event &event) final
Processing an event for a Producer is calling produce.

Member Function Documentation

◆ configure()

void tracking::reco::LinearTrackFinder::configure ( framework::config::Parameters & parameters)
overridevirtual

Configure the processor using the given user specified parameters.

Parameters
parametersSet of parameters used to configure this processor.

Reimplemented from framework::EventProcessor.

Definition at line 17 of file LinearTrackFinder.cxx.

17 {
18 // seeds from the event
19 seed_collection_ =
20 parameters.get<std::string>("seed_collection", "LinearRecoilSeedTracks");
21 // output track collection
22 out_trk_collection_ =
23 parameters.get<std::string>("out_trk_collection", "LinearRecoilTracks");
24
25 input_pass_name_ = parameters.get<std::string>("input_pass_name");
26
27} // configure
const T & get(const std::string &name) const
Retrieve the parameter of the given name.
Definition Parameters.h:75

References framework::config::Parameters::get().

◆ findTracks()

std::vector< ldmx::StraightTrack > tracking::reco::LinearTrackFinder::findTracks ( const std::vector< ldmx::StraightTrack > & track_seeds)
private

Definition at line 68 of file LinearTrackFinder.cxx.

69 {
70 std::vector<ldmx::StraightTrack> best_tracks;
71 std::map<std::array<double, 3>, std::vector<ldmx::StraightTrack>>
72 seeds_by_rec_hit;
73
74 // Group seeds by their EcalRecHit point
75 for (const auto& seed : track_seeds) {
76 auto rec_hit_point = seed.getFirstLayerEcalRecHit();
77 seeds_by_rec_hit[rec_hit_point].push_back(seed);
78 }
79
80 // Track used sensor positions
81 std::set<std::tuple<float, float, float>> used_sensor_positions;
82
83 // Find the best seed for each RecHit
84 // numTracks <= number of RecHits
85 for (auto& entry : seeds_by_rec_hit) {
86 const auto& rec_hit_point = entry.first;
87 auto& seeds_with_same_rec_hit = entry.second;
88
89 ldmx_log(debug) << "Processing RecHit at: (" << rec_hit_point[0] << ", "
90 << rec_hit_point[1] << ", " << rec_hit_point[2] << ")\n";
91
92 // Main function to remove seeds with overlapping sensor positions
93 seeds_with_same_rec_hit.erase(
94 std::remove_if(
95 seeds_with_same_rec_hit.begin(), seeds_with_same_rec_hit.end(),
96 [&](const ldmx::StraightTrack& seed) {
97 for (const auto& measurement : seed.getAllSensorPoints()) {
98 // Check if this sensor's position is already used
99 if (isPositionUsed(measurement, used_sensor_positions)) {
100 // Mark this seed for removal
101 return true;
102 } // ifPositionUsed
103 } // for measurement
104 // Keep the seed if no position overlap
105 return false;
106 }),
107 seeds_with_same_rec_hit.end());
108
109 // If no valid seeds remain after filtering, skip to next RecHit
110 if (seeds_with_same_rec_hit.empty()) continue;
111
112 // Find the seed with the lowest chi2 for this RecHit, this is "best" seed
113 auto best_seed_it = std::min_element(
114 seeds_with_same_rec_hit.begin(), seeds_with_same_rec_hit.end(),
115 [](const ldmx::StraightTrack& trk_a, const ldmx::StraightTrack& trk_b) {
116 return trk_a.getChi2() < trk_b.getChi2();
117 });
118
119 // Store the best seed for this RecHit
120 ldmx::StraightTrack best_seed = *best_seed_it;
121 best_tracks.push_back(best_seed);
122
123 ldmx_log(debug) << "For RecHit at: (" << rec_hit_point[0] << ", "
124 << rec_hit_point[1] << ", " << rec_hit_point[2] << ")\n";
125
126 // Add best seed's sensor position to the global used positions set
127 auto best_seed_measurement = best_seed.getAllSensorPoints();
128
129 for (auto& position_object : best_seed_measurement) {
130 used_sensor_positions.insert(
131 std::make_tuple(position_object.getGlobalPosition()[0],
132 position_object.getGlobalPosition()[1],
133 position_object.getGlobalPosition()[2]));
134 ldmx_log(debug) << "We used the following point: ("
135 << position_object.getGlobalPosition()[0] << ", "
136 << position_object.getGlobalPosition()[1] << ", "
137 << position_object.getGlobalPosition()[2] << ")\n";
138 ldmx_log(debug) << "Which gave a track a distance: "
139 << best_seed.getDistanceToRecHit()
140 << " to the closest ECalRecHit\n";
141 } // for sensor points in "best" seed
142
143 } // for entry loop, everytime we loop onto a new RecHit, we will have fewer
144 // points to check
145
146 return best_tracks;
147
148} // findTracks

◆ isPositionUsed()

bool tracking::reco::LinearTrackFinder::isPositionUsed ( const ldmx::Measurement & measurement,
const std::set< std::tuple< float, float, float > > & used_sensor_positions )
private

Definition at line 150 of file LinearTrackFinder.cxx.

152 {
153 const auto& position = std::make_tuple(measurement.getGlobalPosition()[0],
154 measurement.getGlobalPosition()[1],
155 measurement.getGlobalPosition()[2]);
156
157 return used_sensor_positions.find(position) != used_sensor_positions.end();
158
159} // isPositionUsed
std::array< float, 3 > getGlobalPosition() const
Definition Measurement.h:50

◆ onProcessEnd()

void tracking::reco::LinearTrackFinder::onProcessEnd ( )
overridevirtual

Output event statistics.

Reimplemented from framework::EventProcessor.

Definition at line 61 of file LinearTrackFinder.cxx.

61 {
62 ldmx_log(info) << "found " << n_tracks_ << " tracks / " << n_events_
63 << " events.";
64 ldmx_log(info) << "AVG Time/Event: " << std::fixed << std::setprecision(1)
65 << processing_time_ / n_events_ << " ms";
66} // onProcessEnd

◆ produce()

void tracking::reco::LinearTrackFinder::produce ( framework::Event & event)
overridevirtual

Run the processor.

Parameters
eventThe event to process.

Implements framework::Producer.

Definition at line 29 of file LinearTrackFinder.cxx.

29 {
30 std::vector<ldmx::StraightTrack> straight_tracks;
31
32 auto start = std::chrono::high_resolution_clock::now();
33
34 n_events_++;
35 if (n_events_ % 1000 == 0) ldmx_log(info) << "events processed:" << n_events_;
36
37 ldmx_log(debug) << "Retrieve the seeds::" << seed_collection_;
38
39 const auto& seed_tracks = event.getCollection<ldmx::StraightTrack>(
40 seed_collection_, input_pass_name_);
41
42 n_seeds_ = seed_tracks.size();
43 ldmx_log(debug) << "Number of seeds::" << n_seeds_;
44
45 if (n_seeds_ > 0) {
46 straight_tracks = findTracks(seed_tracks);
47 }
48
49 n_tracks_ += straight_tracks.size();
50
51 // Add the tracks to the event
52 event.add(out_trk_collection_, straight_tracks);
53
54 auto end = std::chrono::high_resolution_clock::now();
55 auto diff = end - start;
56 processing_time_ += std::chrono::duration<double, std::milli>(diff).count();
57
58 straight_tracks.clear();
59} // produce

Member Data Documentation

◆ input_pass_name_

std::string tracking::reco::LinearTrackFinder::input_pass_name_ {""}
private

Definition at line 59 of file LinearTrackFinder.h.

59{""};

◆ n_events_

int tracking::reco::LinearTrackFinder::n_events_ {0}
private

Definition at line 51 of file LinearTrackFinder.h.

51{0};

◆ n_seeds_

int tracking::reco::LinearTrackFinder::n_seeds_ {0}
private

Definition at line 61 of file LinearTrackFinder.h.

61{0};

◆ n_tracks_

int tracking::reco::LinearTrackFinder::n_tracks_ {0}
private

Definition at line 62 of file LinearTrackFinder.h.

62{0};

◆ out_trk_collection_

std::string tracking::reco::LinearTrackFinder::out_trk_collection_ {"LinearRecoilTracks"}
private

Definition at line 55 of file LinearTrackFinder.h.

55{"LinearRecoilTracks"};

◆ processing_time_

double tracking::reco::LinearTrackFinder::processing_time_ {0.}
private

Definition at line 52 of file LinearTrackFinder.h.

52{0.};

◆ seed_collection_

std::string tracking::reco::LinearTrackFinder::seed_collection_ {"LinearRecoilSeedTracks"}
private

Definition at line 58 of file LinearTrackFinder.h.

58{"LinearRecoilSeedTracks"};

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