PropagationTimeModel.h

Go to the documentation of this file.

#ifndef PROPAGATIONTIMEMODEL_H
#define PROPAGATIONTIMEMODEL_H

// PropagationTimeModel
//  - parameterized fast optical simulation of photon propagation times
//  - contains functions to calculate the propagation times of direct and
//  reflected photons incident each photo-detector, along with the necessary
//  ultility functions
//  - full description of model: Eur. Phys. J. C 81, 349 (2021)

// Nov 2021 by P. Green

// LArSoft libraries
#include "larcorealg/Geometry/BoxBoundedGeo.h"
#include "larcorealg/Geometry/fwd.h"
#include "larcoreobj/SimpleTypesAndConstants/geo_vectors.h"
#include "larsim/IonizationScintillation/ISTPC.h"

// fhicl
#include "fhiclcpp/fwd.h"

#include "CLHEP/Random/RandFlat.h"
#include "CLHEP/Random/RandGeneral.h"

namespace CLHEP {
  class HepRandomEngine;
}

// ROOT headers
#include "TF1.h"
#include "TH1D.h"

#include <array>
#include <vector>

namespace phot {

  class PropagationTimeModel {

  public:
    // constructor
    PropagationTimeModel(const fhicl::ParameterSet& VUVTimingParams,
                         const fhicl::ParameterSet& VISTimingParams,
                         CLHEP::HepRandomEngine& scintTimeEngine,
                         const bool doReflectedLight = false,
                         const bool GeoPropTimeOnly = false);

    // propagation time
    void propagationTime(std::vector<double>& arrivalTimes,
                         const geo::Point_t& x0,
                         const size_t OpChannel,
                         const bool Reflected = false);

  private:
    void generateVUVParams(const fhicl::ParameterSet& VUVTimingParams,
                           CLHEP::HepRandomEngine& scintTimeEngine);

    // direct / VUV light
    void getVUVTimes(std::vector<double>& arrivalTimes,
                     const double distance_in_cm,
                     const size_t angle_bin);

    void getVUVTimesGeo(std::vector<double>& arrivalTimes, const double distance_in_cm) const;

    // reflected / visible light
    void getVISTimes(std::vector<double>& arrivalTimes,
                     const geo::Point_t& scintPoint,
                     const geo::Point_t& opDetPoint);

    geo::Point_t cathodeCentre() const;
    std::vector<geo::Point_t> opDetCenters() const;
    std::vector<int> opDetOrientations() const;

    // configuration
    const bool fGeoPropTimeOnly;

    // random numbers
    CLHEP::RandFlat fUniformGen;

    // geometry properties
    geo::GeometryCore const& fGeom;
    const double fplane_depth;
    const geo::Point_t fcathode_centre;

    // photodetector geometry properties
    const std::vector<geo::Point_t> fOpDetCenter;
    const std::vector<int> fOpDetOrientation;

    // For VUV propagation time parametrization
    double fstep_size, fvuv_vgroup_mean, fvuv_vgroup_max, fmin_d, finflexion_point_distance,
      fangle_bin_timing_vuv;
    // vector containing generated VUV timing parameterisations
    std::vector<std::vector<CLHEP::RandGeneral>> fVUVTimingGen;
    // vector containing min and max range VUV timing parameterisations are
    // sampled to
    std::vector<std::vector<double>> fVUV_max;
    std::vector<std::vector<double>> fVUV_min;

    // For VIS propagation time parameterisation
    double fvis_vmean, fangle_bin_timing_vis;
    std::vector<double> fdistances_refl;
    std::vector<double> fradial_distances_refl;
    std::vector<std::vector<std::vector<double>>> fcut_off_pars;
    std::vector<std::vector<std::vector<double>>> ftau_pars;
  };

} // namespace phot

#endif