NeuralCalibrator.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file NeuralCalibrator.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2023 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once

#include "Acts/EventData/SourceLink.hpp"
#include "Acts/Utilities/CalibrationContext.hpp"
#include <Acts/Plugins/Onnx/OnnxRuntimeBase.hpp>
#include <ActsExamples/EventData/MeasurementCalibration.hpp>

#include <filesystem>

namespace ActsExamples {

class NeuralCalibrator : public MeasurementCalibrator {
 public:
  NeuralCalibrator(const std::filesystem::path& modelPath,
                   size_t nComponents = 1,
                   std::vector<size_t> volumeIds = {7, 8, 9});

  void calibrate(
      const MeasurementContainer& measurements,
      const ClusterContainer* clusters, const Acts::GeometryContext& gctx,
      const Acts::CalibrationContext& cctx, const Acts::SourceLink& sourceLink,
      Acts::MultiTrajectory<Acts::VectorMultiTrajectory>::TrackStateProxy&
          trackState) const override;

  bool needsClusters() const override { return true; }

 private:
  Ort::Env m_env;
  Acts::OnnxRuntimeBase m_model;
  size_t m_nComponents;
  size_t m_nInputs =
      57;  // TODO make this configurable? e.g. for changing matrix size?

  // TODO: this should probably be handled outside of the calibrator,
  // by setting up a GeometryHierarchyMap<MeasurementCalibrator>
  std::vector<size_t> m_volumeIds;
  PassThroughCalibrator m_fallback;
};

}  // namespace ActsExamples