LArG4Parameters.h

Go to the documentation of this file.

//
// This service exists to pass parameters to various different
// classes in LArG4, which are not necessary directly called by
// the LArG4_module class.
//
// Ben Jones, MIT, March 2010

#ifndef LArG4Parameters_h
#define LArG4Parameters_h 1

#include "larcoreobj/SimpleTypesAndConstants/PhysicalConstants.h"

#include "art/Framework/Services/Registry/ServiceDeclarationMacros.h"
#include "fhiclcpp/fwd.h"

#include <string>
#include <vector>

namespace sim {

  class LArG4Parameters {
  public:
    LArG4Parameters(fhicl::ParameterSet const& pset);

    int OpVerbosity() const { return fOpVerbosity; }
    double ParticleKineticEnergyCut() const { return fParticleKineticECut; }
    bool StoreTrajectories() const { return fStoreTrajectories; }
    bool DrawNeutrals() const { return fDrawNeutrals; }
    double VisualizationEnergyCut() const { return fVisualizationEnergyCut; }
    bool UseCustomPhysics() const { return fUseCustomPhysics; }
    bool ModifyProtonCut() const { return fModifyProtonCut; }
    double NewProtonCut() const { return fNewProtonCut; }
    double RecombA() const { return fRecombA; }
    double Recombk() const { return fRecombk; }
    double ModBoxA() const { return fModBoxA; }
    double ModBoxB() const { return fModBoxB; }
    double EllipsModBoxA() const { return fEllipsModBoxA; }
    double EllipsModBoxB() const { return fEllipsModBoxB; }
    double EllipsModBoxR() const { return fEllipsModBoxR; }
    double LarqlChi0A() const { return fLarqlChi0A; }
    double LarqlChi0B() const { return fLarqlChi0B; }
    double LarqlChi0C() const { return fLarqlChi0C; }
    double LarqlChi0D() const { return fLarqlChi0D; }
    double LarqlAlpha() const { return fLarqlAlpha; }
    double LarqlBeta() const { return fLarqlBeta; }
    double Wph() const { return fWph; }
    double QAlpha() const { return fQAlpha; }
    bool UseModBoxRecomb() const { return fUseModBoxRecomb; }
    bool UseEllipsModBoxRecomb() const { return fUseEllipsModBoxRecomb; }
    bool UseModLarqlRecomb() const { return fUseModLarqlRecomb; }
    bool UseBinomialFlucts() const { return fUseBinomialFlucts; }
    double GeVToElectrons() const { return util::kGeVToElectrons; }
    double LongitudinalDiffusion() const { return fLongitudinalDiffusion; }
    double TransverseDiffusion() const { return fTransverseDiffusion; }
    double ElectronClusterSize() const { return fElectronClusterSize; }
    int MinNumberOfElCluster() const { return fMinNumberOfElCluster; }
    const std::vector<std::string>& EnabledPhysics() const { return fEnabledPhysics; }
    int K0Bias() const { return fK0Bias; }
    int MNXBias() const { return fXBias; }
    int MNXSBias() const { return fXSBias; }
    bool KeepEMShowerDaughters() const { return fKeepEMShowerDaughters; }
    bool DisableWireplanes() const { return fDisableWireplanes; }
    const std::vector<unsigned short int>& SkipWireSignalInTPCs() const
    {
      return fSkipWireSignalInTPCs;
    }
    const std::string& IonAndScintCalculator() const { return fIonAndScintCalculator; }
    const std::vector<std::string>& OpticalParamVolumes() const { return fOpticalParamVolumes; }
    const std::vector<std::string>& OpticalParamModels() const { return fOpticalParamModels; }
    const std::vector<int>& OpticalParamOrientations() const { return fOpticalParamOrientations; }
    const std::vector<std::vector<std::vector<double>>>& OpticalParamParameters() const
    {
      return fOpticalParamParameters;
    }
    bool UseLitePhotons() const { return fLitePhotons; }

    bool FillSimEnergyDeposits() const { return fFillSimEnergyDeposits; }
    bool NoElectronPropagation() const { return fNoElectronPropagation; }
    bool NoPhotonPropagation() const { return fNoPhotonPropagation; }

  private:
    int const fOpVerbosity; 
    double const
      fParticleKineticECut; 
    bool const fStoreTrajectories;        
    bool const fDrawNeutrals;             
    double const fVisualizationEnergyCut; 
    bool const fUseCustomPhysics;         
    bool const fModifyProtonCut; 
    double const fNewProtonCut;  
    double const
      fLongitudinalDiffusion; 
    double const fTransverseDiffusion; 
    double const fElectronClusterSize; 
    int const fMinNumberOfElCluster;   
    std::vector<std::string> const
      fEnabledPhysics; 
    int const fK0Bias; 
    int const fXSBias; 
    int const fXBias;  
    bool const fKeepEMShowerDaughters; 
    bool const fDisableWireplanes;     
    std::vector<unsigned short int> const
      fSkipWireSignalInTPCs;     
    double const fRecombA;       
    double const fRecombk;       
    double const fModBoxA;       
    double const fModBoxB;       
    double const fEllipsModBoxA; 
    double const fEllipsModBoxB; 
    double const fEllipsModBoxR; 
    double const fLarqlChi0A;    
    double const fLarqlChi0B;    
    double const fLarqlChi0C;    
    double const fLarqlChi0D;    
    double const fLarqlAlpha;    
    double const fLarqlBeta;     
    double const fWph;           
    double const fQAlpha;        
    bool const fUseModBoxRecomb; 
    bool const
      fUseEllipsModBoxRecomb; 
    bool const fUseModLarqlRecomb; 
    bool const fUseBinomialFlucts; 
    std::string const
      fIonAndScintCalculator; 
    std::vector<std::string> const
      fOpticalParamVolumes; 
    std::vector<std::string> const fOpticalParamModels; 
    std::vector<int> const
      fOpticalParamOrientations; 
    std::vector<std::vector<std::vector<double>>> const
      fOpticalParamParameters; 

    bool const fLitePhotons;

    bool const fFillSimEnergyDeposits; 
    bool const fNoElectronPropagation; 
    bool const fNoPhotonPropagation;   
  };
}

DECLARE_ART_SERVICE(sim::LArG4Parameters, SHARED)

#endif