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


#include <string>

#ifndef LArG4Parameters_h
#define LArG4Parameters_h 1

#include "fhiclcpp/ParameterSet.h"
#include "art/Framework/Services/Registry/ActivityRegistry.h"
#include "art/Framework/Services/Registry/ServiceHandle.h"
#include "art/Framework/Services/Registry/ServiceMacros.h"

#include "larcoreobj/SimpleTypesAndConstants/PhysicalConstants.h"

namespace sim {

  class LArG4Parameters {
  public:
    LArG4Parameters(fhicl::ParameterSet const& pset, art::ActivityRegistry& reg);
    ~LArG4Parameters() {}
    
    void reconfigure(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;       }
    double RecombA()                                          const { return util::kRecombA;          }
    double Recombk()                                          const { return util::kRecombk;          }
    double ModBoxA()                                          const { return util::kModBoxA;          }
    double ModBoxB()                                          const { return util::kModBoxB;          }
    bool   UseModBoxRecomb()                                  const { return fUseModBoxRecomb;        }
    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                      fOpVerbosity;           
    double                   fParticleKineticECut;   
    bool                     fStoreTrajectories;     
    bool                     fDrawNeutrals;          
    double                   fVisualizationEnergyCut;
    bool                     fUseCustomPhysics;      
    double                   fLongitudinalDiffusion; 
    double                   fTransverseDiffusion;   
    double                   fElectronClusterSize;   
    int                      fMinNumberOfElCluster;   
    std::vector<std::string> fEnabledPhysics;        
    int                      fK0Bias;                
    int                      fXSBias;                
    int                      fXBias;                 
    bool                     fKeepEMShowerDaughters; 
    bool                     fDisableWireplanes;     
    std::vector<unsigned short int> fSkipWireSignalInTPCs;  
    bool                     fUseModBoxRecomb;       
    std::string              fIonAndScintCalculator; 
    std::vector<std::string> fOpticalParamVolumes;   
    std::vector<std::string> fOpticalParamModels;    
    std::vector<int>         fOpticalParamOrientations; 
    std::vector<std::vector<std::vector<double> > > fOpticalParamParameters; 
 
    bool fLitePhotons;

    bool   fFillSimEnergyDeposits;          
    //size_t fInitialSimEnergyDepositSize;    ///< reserve size for the edep collection in LArG4
    bool   fNoElectronPropagation;          
    bool   fNoPhotonPropagation;          
  };
}


DECLARE_ART_SERVICE(sim::LArG4Parameters, LEGACY)
#endif