SimParam.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
 
#ifndef O2_TRD_SIMPARAM_H
#define O2_TRD_SIMPARAM_H
 
#include <array>
#include "Rtypes.h" // for ClassDef
 
namespace o2
{
namespace trd
{
 
class SimParam
{
 public:
  enum class GasMixture { Xenon,
                          Argon };
 
  SimParam();
  SimParam(const SimParam&) = delete;
  SimParam& operator=(const SimParam&) = delete;
 
  void init();
 
  // Cached magnetic field, to be called by the user before using DiffusionAndTimeStructEstimator::GetDiffCoeff
  void cacheMagField();
 
  // Setters
  void setGasGain(float gasgain) { mGasGain = gasgain; }
  void setNoise(float noise) { mNoise = noise; }
  void setChipGain(float chipgain) { mChipGain = chipgain; }
  void setADCoutRange(float range) { mADCoutRange = range; }
  void setADCinRange(float range) { mADCinRange = range; }
  void setADCbaseline(int basel) { mADCbaseline = basel; }
  void setDiffusion(bool flag = true) { mDiffusionOn = flag; }
  void setElAttach(bool flag = true) { mElAttachOn = flag; }
  void setElAttachProp(float prop) { mElAttachProp = prop; }
  void setTimeResponse(bool flag = true) { mTRFOn = flag; }
  void setCrossTalk(bool flag = true) { mCTOn = flag; }
  void setPadCoupling(float v) { mPadCoupling = v; }
  void setTimeCoupling(float v) { mTimeCoupling = v; }
  void setTimeStruct(bool flag = true) { mTimeStructOn = flag; }
  void setPadResponse(bool flag = true) { mPRFOn = flag; }
  void setExB(bool flag = true) { mExBOn = flag; }
  void setSamplingFrequency(float freq) { mSamplingFrequency = freq; }
  void setTRF(int trf, float mu = 0., float sigma = 0.3)
  {
    mTRF = trf;
    mMu = mu;
    mSigma = sigma;
  }
 
  // Getters
  float getGasGain() const { return mGasGain; }
  float getNoise() const { return mNoise; }
  float getChipGain() const { return mChipGain; }
  float getADCoutRange() const { return mADCoutRange; }
  float getADCinRange() const { return mADCinRange; }
  int getADCbaseline() const { return mADCbaseline; }
  float getTRFlo() const { return mTRFlo; }
  float getTRFhi() const { return mTRFhi; }
  float getPadCoupling() const { return mPadCoupling; }
  float getTimeCoupling() const { return mTimeCoupling; }
  bool diffusionOn() const { return mDiffusionOn; }
  bool elAttachOn() const { return mElAttachOn; }
  float getElAttachProp() const { return mElAttachProp; }
  bool trfOn() const { return mTRFOn; }
  bool ctOn() const { return mCTOn; }
  bool timeStructOn() const { return mTimeStructOn; }
  bool prfOn() const { return mPRFOn; }
  int getNumberOfPadsInPadResponse() const { return mNPadsInPadResponse; }
  double timeResponse(double) const;
  double crossTalk(double) const;
  bool isExBOn() const { return mExBOn; }
  bool isXenon() const { return (mGasMixture == GasMixture::Xenon); }
  bool isArgon() const { return (mGasMixture == GasMixture::Argon); }
  GasMixture getGasMixture() const { return mGasMixture; }
  float getSamplingFrequency() const { return mSamplingFrequency; }
  float getCachedField() const;
 
 private:
  void sampleTRF();
 
  float mNoise{1250.f};                 
  float mChipGain{12.4f};               
  float mADCoutRange{1023.f};           
  float mADCinRange{2000.f};            
  int mADCbaseline{10};                 
  bool mDiffusionOn{true};              
  bool mElAttachOn{false};              
  float mElAttachProp{0.f};             
  bool mTRFOn{true};                    
  bool mCTOn{true};                     
  bool mPRFOn{true};                    
  int mNPadsInPadResponse{3};           
  static constexpr int mNBinsMax = 200; 
 
  // From CommonParam
  GasMixture mGasMixture{GasMixture::Xenon};
  bool mExBOn{true};              
  bool mFieldCached{false};       
  float mField{0.};               
  float mSamplingFrequency{10.f}; 
 
  // Use 0.46, instead of the theroetical value 0.3, since it reproduces better
  // the test beam data, even tough it is not understood why.
  float mPadCoupling{.46f}; 
  float mTimeCoupling{.4f}; 
  bool mTimeStructOn{true}; 
 
  std::array<float, mNBinsMax> mTRFsmp{};                            
  std::array<float, mNBinsMax> mCTsmp{};                             
  int mTRF{0};                                                       
  float mMu{0.};                                                     
  float mSigma{0.03};                                                
  int mTRFbin{200};                                                  
  float mTRFlo{-.4f};                                                
  float mTRFhi{3.58f};                                               
  float mInvTRFwid{static_cast<float>(mTRFbin) / (mTRFhi - mTRFlo)}; 
  float mGasGain{4000.f};                                            
 
  ClassDefNV(SimParam, 2); // The TRD simulation parameters
};
 
} // namespace trd
} // namespace o2
#endif