RMGOutputTools.hh

// Copyright (C) 2025 Toby Dixon <https://orcid.org/0000-0001-8787-6336>
//
// This program is free software: you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option) any
// later version.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
// FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
// details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
#ifndef _RMG_OUTPUT_TOOLS_HH_
#define _RMG_OUTPUT_TOOLS_HH_
 
#include <map>
#include <unordered_map>
#include <vector>
 
#include "G4AffineTransform.hh"
#include "G4Step.hh"
#include "G4ThreeVector.hh"
#include "G4VSolid.hh"
 
#include "RMGDetectorHit.hh"
#include "RMGDetectorMetadata.hh"

namespace RMGOutputTools {

  enum class PositionMode {
    kPreStep,
    kPostStep,
    kAverage,
    kBoth,
  };
 

  struct ClusterPars {
      bool combine_low_energy_tracks;
      bool reassign_gamma_energy;
      double track_energy_threshold;
      double surface_thickness;
      double cluster_distance;
      double cluster_distance_surface;
      double cluster_time_threshold;
  };

  G4ThreeVector get_position(RMGDetectorHit* hit, RMGOutputTools::PositionMode mode);

  double get_distance(RMGDetectorHit* hit, RMGOutputTools::PositionMode mode);

  double distance_to_surface(const G4VPhysicalVolume* pv, const G4ThreeVector& position);

  double distance_to_surface(
      const G4VPhysicalVolume* pv,
      const G4ThreeVector& position,
      bool is_distance_check_germanium_only
  );

  bool is_within_surface_safety(
      const G4VPhysicalVolume* pv,
      const G4ThreeVector& position,
      double safety,
      bool is_distance_check_germanium_only = false
  );

  std::shared_ptr<RMGDetectorHitsCollection> pre_cluster_hits(
      const RMGDetectorHitsCollection* hits,
      ClusterPars cluster_pars,
      bool has_distance_to_surface,
      bool has_velocity
  );

  RMGDetectorHit* average_hits(
      std::vector<RMGDetectorHit*> hits,
      bool compute_distance_to_surface,
      bool compute_velocity
  );

  bool check_step_point_containment(const G4StepPoint* step_point, RMGDetectorType det_type);

  std::map<int, std::vector<RMGDetectorHit*>> combine_low_energy_tracks(
      const std::map<int, std::vector<RMGDetectorHit*>>& hits_map,
      const ClusterPars& cluster_pars,
      bool has_distance_to_surface
  );

  void redistribute_gamma_energy(
      std::map<int, std::vector<RMGDetectorHit*>> hits_map,
      ClusterPars cluster_pars,
      bool has_distance_to_surface
  );
} // namespace RMGOutputTools
 
#endif
 
// vim: tabstop=2 shiftwidth=2 expandtab