Skip to content

Commit

Permalink
fix: convert to algorithms logger, no m_log in each algorithm class (#…
Browse files Browse the repository at this point in the history 
…1483)

### Briefly, what does this PR introduce?
This PR moves a lot of algorithms and factories over to using the
internal logger functionality that comes with the algorithms interface.
It means that individual algorithms don't need to initialize their own
`m_log`. It also means that these algorithms are now properly conformant
to the algorithms interface, i.e. `init()` and `process(input, output)
const`.

### What kind of change does this PR introduce?
- [x] Bug fix (issue #__)
- [ ] New feature (issue #__)
- [ ] Documentation update
- [ ] Other: __

### Please check if this PR fulfills the following:
- [ ] Tests for the changes have been added
- [ ] Documentation has been added / updated
- [ ] Changes have been communicated to collaborators

### Does this PR introduce breaking changes? What changes might users
need to make to their code?
No.

### Does this PR change default behavior?
No.
  • Loading branch information
@wdconinc
wdconinc authored Jun 3, 2024
1 parent 204bfc0 commit 2e074ae
Show file tree
Hide file tree
Showing 44 changed files with 882 additions and 1,103 deletions.
29 changes: 13 additions & 16 deletions src/algorithms/digi/SiliconTrackerDigi.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,7 @@

namespace eicrecon {

void SiliconTrackerDigi::init(std::shared_ptr<spdlog::logger>& logger) {
// set logger
m_log = logger;

void SiliconTrackerDigi::init() {
// Create random gauss function
m_gauss = [&](){
return m_random.Gaus(0, m_cfg.timeResolution);
Expand All @@ -50,20 +47,20 @@ void SiliconTrackerDigi::process(
double result_time = sim_hit.getTime() + time_smearing;
auto hit_time_stamp = (std::int32_t) (result_time * 1e3);

m_log->debug("--------------------");
m_log->debug("Hit cellID = {}", sim_hit.getCellID());
m_log->debug(" position = ({:.2f}, {:.2f}, {:.2f})", sim_hit.getPosition().x, sim_hit.getPosition().y, sim_hit.getPosition().z);
m_log->debug(" xy_radius = {:.2f}", std::hypot(sim_hit.getPosition().x, sim_hit.getPosition().y));
m_log->debug(" momentum = ({:.2f}, {:.2f}, {:.2f})", sim_hit.getMomentum().x, sim_hit.getMomentum().y, sim_hit.getMomentum().z);
m_log->debug(" edep = {:.2f}", sim_hit.getEDep());
m_log->debug(" time = {:.4f}[ns]", sim_hit.getTime());
m_log->debug(" particle time = {}[ns]", sim_hit.getMCParticle().getTime());
m_log->debug(" time smearing: {:.4f}, resulting time = {:.4f} [ns]", time_smearing, result_time);
m_log->debug(" hit_time_stamp: {} [~ps]", hit_time_stamp);
debug("--------------------");
debug("Hit cellID = {}", sim_hit.getCellID());
debug(" position = ({:.2f}, {:.2f}, {:.2f})", sim_hit.getPosition().x, sim_hit.getPosition().y, sim_hit.getPosition().z);
debug(" xy_radius = {:.2f}", std::hypot(sim_hit.getPosition().x, sim_hit.getPosition().y));
debug(" momentum = ({:.2f}, {:.2f}, {:.2f})", sim_hit.getMomentum().x, sim_hit.getMomentum().y, sim_hit.getMomentum().z);
debug(" edep = {:.2f}", sim_hit.getEDep());
debug(" time = {:.4f}[ns]", sim_hit.getTime());
debug(" particle time = {}[ns]", sim_hit.getMCParticle().getTime());
debug(" time smearing: {:.4f}, resulting time = {:.4f} [ns]", time_smearing, result_time);
debug(" hit_time_stamp: {} [~ps]", hit_time_stamp);


if (sim_hit.getEDep() < m_cfg.threshold) {
m_log->debug(" edep is below threshold of {:.2f} [keV]", m_cfg.threshold / dd4hep::keV);
debug(" edep is below threshold of {:.2f} [keV]", m_cfg.threshold / dd4hep::keV);
continue;
}

Expand All @@ -77,7 +74,7 @@ void SiliconTrackerDigi::process(
} else {
// There is previous values in the cell
auto& hit = cell_hit_map[sim_hit.getCellID()];
m_log->debug(" Hit already exists in cell ID={}, prev. hit time: {}", sim_hit.getCellID(), hit.getTimeStamp());
debug(" Hit already exists in cell ID={}, prev. hit time: {}", sim_hit.getCellID(), hit.getTimeStamp());

// keep earliest time for hit
auto time_stamp = hit.getTimeStamp();
Expand Down
64 changes: 26 additions & 38 deletions src/algorithms/digi/SiliconTrackerDigi.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@

#include <TRandomGen.h>
#include <algorithms/algorithm.h>
#include <edm4eic/RawTrackerHitCollection.h>
#include <edm4eic/MCRecoTrackerHitAssociationCollection.h>
#include <edm4eic/RawTrackerHitCollection.h>
#include <edm4hep/SimTrackerHitCollection.h>
#include <spdlog/logger.h>
#include <functional>
#include <memory>
#include <string>
#include <string_view>

Expand All @@ -19,45 +17,35 @@

namespace eicrecon {

using SiliconTrackerDigiAlgorithm = algorithms::Algorithm<
algorithms::Input<
edm4hep::SimTrackerHitCollection
>,
algorithms::Output<
edm4eic::RawTrackerHitCollection,
edm4eic::MCRecoTrackerHitAssociationCollection
>
>;

class SiliconTrackerDigi
: public SiliconTrackerDigiAlgorithm,
public WithPodConfig<SiliconTrackerDigiConfig> {

public:
SiliconTrackerDigi(std::string_view name)
: SiliconTrackerDigiAlgorithm{name,
{"inputHitCollection"},
{"outputRawHitCollection","outputHitAssociations"},
"Apply threshold, digitize within ADC range, "
"convert time with smearing resolution."} {}
using SiliconTrackerDigiAlgorithm =
algorithms::Algorithm<algorithms::Input<edm4hep::SimTrackerHitCollection>,
algorithms::Output<edm4eic::RawTrackerHitCollection,
edm4eic::MCRecoTrackerHitAssociationCollection>>;

void init(std::shared_ptr<spdlog::logger>& logger);
void process(const Input&, const Output&) const final;
class SiliconTrackerDigi : public SiliconTrackerDigiAlgorithm,
public WithPodConfig<SiliconTrackerDigiConfig> {

private:
/** algorithm logger */
std::shared_ptr<spdlog::logger> m_log;
public:
SiliconTrackerDigi(std::string_view name)
: SiliconTrackerDigiAlgorithm{name,
{"inputHitCollection"},
{"outputRawHitCollection", "outputHitAssociations"},
"Apply threshold, digitize within ADC range, "
"convert time with smearing resolution."} {}

/** Random number generation*/
TRandomMixMax m_random;
std::function<double()> m_gauss;
void init() final;
void process(const Input&, const Output&) const final;

// FIXME replace with standard random engine
//std::default_random_engine generator; // TODO: need something more appropriate here
//std::normal_distribution<double> m_normDist; // defaults to mean=0, sigma=1
private:
/** Random number generation*/
TRandomMixMax m_random;
std::function<double()> m_gauss;

//algorithms::Generator m_rng = algorithms::RandomSvc::instance().generator();
// FIXME replace with standard random engine
// std::default_random_engine generator; // TODO: need something more appropriate here
// std::normal_distribution<double> m_normDist; // defaults to mean=0, sigma=1

};
// algorithms::Generator m_rng = algorithms::RandomSvc::instance().generator();
};

} // eicrecon
} // namespace eicrecon
14 changes: 6 additions & 8 deletions src/algorithms/fardetectors/FarDetectorLinearTracking.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,7 @@

namespace eicrecon {

void FarDetectorLinearTracking::init(std::shared_ptr<spdlog::logger>& logger) {

m_log = logger;
void FarDetectorLinearTracking::init() {

// For changing how strongly each layer hit is in contributing to the fit
m_layerWeights = Eigen::VectorXd::Constant(m_cfg.n_layer,1);
Expand All @@ -49,7 +47,7 @@ namespace eicrecon {
// Check the number of input collections is correct
int nCollections = inputhits.size();
if(nCollections!=m_cfg.n_layer){
m_log->error("Wrong number of input collections passed to algorithm");
error("Wrong number of input collections passed to algorithm");
return;
}

Expand All @@ -58,7 +56,7 @@ namespace eicrecon {
// TODO - Implement more sensible solution
for(const auto& layerHits: inputhits){
if((*layerHits).size()>m_cfg.layer_hits_max){
m_log->info("Too many hits in layer");
info("Too many hits in layer");
return;
}
}
Expand Down Expand Up @@ -160,9 +158,9 @@ namespace eicrecon {

double angle = std::acos(hitDiff.dot(m_optimumDirection));

m_log->debug("Vector: x={}, y={}, z={}",hitDiff.x(),hitDiff.y(),hitDiff.z());
m_log->debug("Optimum: x={}, y={}, z={}",m_optimumDirection.x(),m_optimumDirection.y(),m_optimumDirection.z());
m_log->debug("Angle: {}, Tolerance {}",angle,m_cfg.step_angle_tolerance);
debug("Vector: x={}, y={}, z={}",hitDiff.x(),hitDiff.y(),hitDiff.z());
debug("Optimum: x={}, y={}, z={}",m_optimumDirection.x(),m_optimumDirection.y(),m_optimumDirection.z());
debug("Angle: {}, Tolerance {}",angle,m_cfg.step_angle_tolerance);

if(angle>m_cfg.step_angle_tolerance) return false;

Expand Down
69 changes: 29 additions & 40 deletions src/algorithms/fardetectors/FarDetectorLinearTracking.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,65 +3,54 @@

#pragma once

#include <Eigen/Core>
#include <algorithms/algorithm.h>
#include <algorithms/interfaces/WithPodConfig.h>
#include <edm4eic/TrackSegmentCollection.h>
#include <edm4hep/TrackerHitCollection.h>
#include <gsl/pointers>
#include <memory>
#include <string>
#include <string_view>
#include <vector>
#include <Eigen/Core>
#include <spdlog/logger.h>

#include "FarDetectorLinearTrackingConfig.h"

namespace eicrecon {

using FarDetectorLinearTrackingAlgorithm = algorithms::Algorithm<
algorithms::Input<
std::vector<edm4hep::TrackerHitCollection>
>,
algorithms::Output<
edm4eic::TrackSegmentCollection
>
>;

class FarDetectorLinearTracking
: public FarDetectorLinearTrackingAlgorithm,
public WithPodConfig<FarDetectorLinearTrackingConfig> {

public:
FarDetectorLinearTracking(std::string_view name)
: FarDetectorLinearTrackingAlgorithm{name,
{"inputHitCollections"},
{"outputTrackSegments"},
"Fit track segments from hits in the tracker layers"} {}
using FarDetectorLinearTrackingAlgorithm =
algorithms::Algorithm<algorithms::Input<std::vector<edm4hep::TrackerHitCollection>>,
algorithms::Output<edm4eic::TrackSegmentCollection>>;

/** One time initialization **/
void init(std::shared_ptr<spdlog::logger>& logger);
class FarDetectorLinearTracking : public FarDetectorLinearTrackingAlgorithm,
public WithPodConfig<FarDetectorLinearTrackingConfig> {

/** Event by event processing **/
void process(const Input&, const Output&) const final;
public:
FarDetectorLinearTracking(std::string_view name)
: FarDetectorLinearTrackingAlgorithm{name,
{"inputHitCollections"},
{"outputTrackSegments"},
"Fit track segments from hits in the tracker layers"} {}

private:
std::shared_ptr<spdlog::logger> m_log;
/** One time initialization **/
void init() final;

Eigen::VectorXd m_layerWeights;
/** Event by event processing **/
void process(const Input&, const Output&) const final;

Eigen::Vector3d m_optimumDirection;
private:
Eigen::VectorXd m_layerWeights;

void buildMatrixRecursive(int level,
Eigen::MatrixXd* hitMatrix,
const std::vector<gsl::not_null<const edm4hep::TrackerHitCollection*>>& hits,
gsl::not_null<edm4eic::TrackSegmentCollection*> outputTracks) const;
Eigen::Vector3d m_optimumDirection;

void checkHitCombination(Eigen::MatrixXd* hitMatrix,
gsl::not_null<edm4eic::TrackSegmentCollection*> outputTracks) const;
void
buildMatrixRecursive(int level, Eigen::MatrixXd* hitMatrix,
const std::vector<gsl::not_null<const edm4hep::TrackerHitCollection*>>& hits,
gsl::not_null<edm4eic::TrackSegmentCollection*> outputTracks) const;

bool checkHitPair(const Eigen::Vector3d& hit1,
const Eigen::Vector3d& hit2) const;
void checkHitCombination(Eigen::MatrixXd* hitMatrix,
gsl::not_null<edm4eic::TrackSegmentCollection*> outputTracks) const;

};
bool checkHitPair(const Eigen::Vector3d& hit1, const Eigen::Vector3d& hit2) const;
};

} // eicrecon
} // namespace eicrecon
Loading

0 comments on commit 2e074ae

Please sign in to comment.