TRTDigSettings.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/

//                                                             //
// File: TRTDigSettings.h                                      //
//                                                             //
// Author: Thomas Kittelmann <kittel@nbi.dk>                   //
//                                                             //
// First version: April 2005. Rewritten November 2005.         //
//                                                             //
// Class containing parameters and settings used by            //
// TRT digitization.                                           //
//                                                             //
 
#ifndef TRT_DIGITIZATION_TRTDIGSETTINGS_H
#define TRT_DIGITIZATION_TRTDIGSETTINGS_H
 
#include "AthenaBaseComps/AthMessaging.h"
 
#include <map>
#include <string>
 
class Algorithm;
class AlgTool;
namespace InDetDD { class TRT_DetectorManager; }

class TRTDigSettings : public AthMessaging {
 
public:

  TRTDigSettings();

  void initialize( const InDetDD::TRT_DetectorManager* detmgr);

  void addPropertiesForOverrideableParameters( Algorithm * alg );

  void addPropertiesForOverrideableParameters( AlgTool * algt );

  void print( const std::string& front = "" ) const;

  void printFlagsForOverrideableParameters( const std::string& front = "" ) const;
 
  //==============================================================//
  //                       Accessor methods                       //
  //==============================================================//
 
  int digVers() const;
 
  bool useAttenuation() const;
  double attenuationLength() const;

  double trEfficiencyBarrel(int strawGasType) const;

  double trEfficiencyEndCapA(int strawGasType) const;
  double trEfficiencyEndCapB(int strawGasType) const;

  double ionisationPotential(int strawGasType) const;

  double smearingFactor(int strawGasType) const;
 
  //--- Digitization parameters:
 
  unsigned int digVersion() const;
  bool useMagneticFieldMap() const;

  double timeInterval() const;
  unsigned int numberOfBins() const;
  unsigned int numberOfBinsInEncodingBin() const;
  double minDiscriminatorWidth() const;
  double discriminatorSettlingTime() const;
  double discriminatorDeadTime() const;

  double lowThresholdBar(int strawGasType) const;
  double lowThresholdEC(int strawGasType) const;

  double highThresholdBarShort(int strawGasType) const;
  double highThresholdBarLong(int strawGasType) const;
  double highThresholdECAwheels(int strawGasType) const;
  double highThresholdECBwheels(int strawGasType) const;

  int htT0shiftBarShort()  const;
  int htT0shiftBarLong()   const;
  int htT0shiftECAwheels() const;
  int htT0shiftECBwheels() const;

  int ltT0shiftBarShort(int strawGasType)  const;
  int ltT0shiftBarLong(int strawGasType)   const;
  int ltT0shiftECAwheels(int strawGasType) const;
  int ltT0shiftECBwheels(int strawGasType) const;
 
  //--- Common straw geometry parameters:

  double innerRadiusOfStraw() const;

  double outerRadiusOfWire() const;

  double lengthOfDeadRegion() const;

  bool timeCorrection() const;

  double signalPropagationSpeed() const;
 
  //--- Calculating electronics time shifts:

  double distanceToTimeFactor() const;
  double maxVertexDisplacement() const;
  double timeOffsetCalcVertexX() const;
  double timeOffsetCalcVertexY() const;
  double timeOffsetCalcVertexZ() const;
  bool electronicsAreAtFarEnd() const;
  bool timeshiftsSymmetricForPhiSectors() const;
 
  //---  Pile up:

  unsigned int numberOfCrossingsBeforeMain() const;
  double pileUpSDOsMinEkin() const;//MC Truth saving for pile-up events
 
  //--- Noise parameters:

  bool noiseInUnhitStraws() const;
  bool noiseInSimhits() const;
 
  //--- Composition of electronics noise:

  double fastElectronicsNoisePulseDistance() const;
  double slowPeriodicNoisePulseDistance() const;
  double slowPeriodicNoisePulseFraction() const;

  double averageNoiseLevel() const;

  double crossTalkNoiseLevel() const;
  double crossTalkNoiseLevelOtherEnd() const;
 
  //--- Threshold fluctuations:

  double relativeLowThresholdFluctuation() const;  // 0 means no LT fluctuation
  double relativeHighThresholdFluctuation() const; // 0 means no HT fluctuation
 
  //--- Field (for effects on drift time):

  double solenoidFieldStrength() const;
 
  //--- Special runs:

  unsigned int cosmicFlag() const;
  bool isCTB() const;
  bool isOverlay() const;
 
  bool killEndCap() const;          
  bool killBarrel() const;          
  double jitterTimeOffset() const;
  bool doCosmicTimingPit() const;

  bool doCrosstalk() const;
 
  unsigned int storeSDO() const;
 
  bool getT0FromData() const;
 
  //Delta-ray suppression switch
  double TrtRangeCutProperty() const;
 
private:
  //==============================================================//
  //                           Private                            //
  //==============================================================//

  void defineVariables();

  void fillDefaults(const InDetDD::TRT_DetectorManager* detmgr);

  void processOverrides();
 
  //---First a list of data members used for holding the parameters:
  bool m_useMagneticFieldMap = false;
  bool m_getT0FromData = false;
  unsigned int m_storeSDO = 0U;            
 
  double m_ionisationPotential = 0.0;       
  double m_ionisationPotentialArgon = 0.0;  
  double m_ionisationPotentialKrypton = 0.0;  
  double m_smearingFactor = 0.0;            
  double m_smearingFactorArgon = 0.0;       
  double m_smearingFactorKrypton = 0.0;       
 
  double m_timeInterval = 0.0;             
  unsigned int m_numberOfBins = 0U;        
  unsigned int m_numberOfBinsInEncodingBin = 0U;  
  double m_minDiscriminatorWidth = 0.0;     
  double m_discriminatorSettlingTime = 0.0; 
  double m_discriminatorDeadTime = 0.0;     
  double m_signalPropagationSpeed = 0.0;
  double m_distanceToTimeFactor = 0.0; 
 
  double m_lowThresholdBar = 0.0;         
  double m_lowThresholdEC = 0.0;         
 
  double m_lowThresholdBarArgon = 0.0;         
  double m_lowThresholdECArgon = 0.0;         
 
  double m_lowThresholdBarKrypton = 0.0;         
  double m_lowThresholdECKrypton = 0.0;         
 
  double m_highThresholdBarShort = 0.0;        
  double m_highThresholdBarLong = 0.0;        
  double m_highThresholdECAwheels = 0.0;        
  double m_highThresholdECBwheels = 0.0;        
 
  double m_highThresholdBarShortArgon = 0.0;        
  double m_highThresholdBarLongArgon = 0.0;        
  double m_highThresholdECAwheelsArgon = 0.0;        
  double m_highThresholdECBwheelsArgon = 0.0;        
 
  double m_highThresholdBarShortKrypton = 0.0;        
  double m_highThresholdBarLongKrypton = 0.0;        
  double m_highThresholdECAwheelsKrypton = 0.0;        
  double m_highThresholdECBwheelsKrypton = 0.0;        
 
  int m_htT0shiftBarShort = 0; 
  int m_htT0shiftBarLong = 0;
  int m_htT0shiftECAwheels = 0;
  int m_htT0shiftECBwheels = 0;
 
  int m_ltT0shiftBarShortXe = 0; 
  int m_ltT0shiftBarShortKr = 0;
  int m_ltT0shiftBarShortAr = 0;
  int m_ltT0shiftBarLongXe = 0;
  int m_ltT0shiftBarLongKr = 0;
  int m_ltT0shiftBarLongAr = 0;
  int m_ltT0shiftECAwheelsXe = 0;
  int m_ltT0shiftECAwheelsKr = 0;
  int m_ltT0shiftECAwheelsAr = 0;
  int m_ltT0shiftECBwheelsXe = 0;
  int m_ltT0shiftECBwheelsKr = 0;
  int m_ltT0shiftECBwheelsAr = 0;
 
  double m_innerRadiusOfStraw = 0.0;   
  double m_outerRadiusOfWire = 0.0;    
  double m_lengthOfDeadRegion = 0.0;   
 
  bool m_timeCorrection = false; 
 
  unsigned int m_numberOfCrossingsBeforeMain = 0U; 
  double m_pileUpSDOsMinEkin = 0.0;      
  double m_maxVertexDisplacement = 0.0;  
  double m_timeOffsetCalcVertexX = 0.0;  
  double m_timeOffsetCalcVertexY = 0.0;  
  double m_timeOffsetCalcVertexZ = 0.0;  
  bool m_electronicsAreAtFarEnd = false;   
  bool m_timeshiftsSymmetricForPhiSectors = false;  
 
  double m_trEfficiencyBarrel = 0.0; 
  double m_trEfficiencyEndCapA = 0.0; 
  double m_trEfficiencyEndCapB = 0.0; 
  double m_trEfficiencyBarrelArgon = 0.0; 
  double m_trEfficiencyEndCapAArgon = 0.0; 
  double m_trEfficiencyEndCapBArgon = 0.0; 
  double m_trEfficiencyBarrelKrypton = 0.0; 
  double m_trEfficiencyEndCapAKrypton = 0.0; 
  double m_trEfficiencyEndCapBKrypton = 0.0; 
 
  bool m_noiseInUnhitStraws = false;   
  bool m_noiseInSimhits = false;       
 
  bool m_isCTB = false;                
 
  bool m_killEndCap = false;           
  bool m_killBarrel = false;           
  double m_jitterTimeOffset = 0.0;   
  bool m_doCosmicTimingPit = false;    
  bool m_doCrosstalk = false;          
 
  unsigned int m_cosmicFlag = 0U;   
  bool m_isOverlay = false;   
 
  double m_fastElectronicsNoisePulseDistance = 0.0; 
  double m_slowPeriodicNoisePulseDistance = 0.0;    
  double m_slowPeriodicNoisePulseFraction = 0.0;    
  double m_averageNoiseLevel = 0.0;                 
  double m_crosstalkNoiseLevel = 0.0;               
  double m_crosstalkNoiseLevelOtherEnd = 0.0;       
 
  double m_relativeLowThresholdFluctuation = 0.0;   
  double m_relativeHighThresholdFluctuation = 0.0;  
  double m_solenoidFieldStrength = 0.0;             
 
  bool m_useAttenuation = false;
  double m_attenuationLength = 0.0;
 
  double m_trtRangeCutProperty = 0.0; 
 
  //Now follows infrastructure for handling all the parameters in a robust way:

  void defineNewVariable(const std::string & name,
                         double * datamember,
                         const std::string & description,
                         const std::string & unitname,
                         double unitval,
                         double lowrange,
                         double highrange);

  void defineNewUIntVariable(const std::string & name,
                             unsigned int * datamember,
                             const std::string & description,
                             unsigned int lowrange,
                             unsigned int highrange);

  void defineNewIntVariable(const std::string & name,
                            int * datamember,
                            const std::string & description,
                            int lowrange,
                            int highrange);

  void defineNewBoolVariable(const std::string & name,
                             bool * datamember,
                             const std::string & description);

  struct doubleparameter {
    std::string description;
    double * directvaraddress{};
    std::string unitname;  
    double unit{};
    double okrange_low{}; 
    double okrange_high{};
    double valueSetByUser{};
  };

  struct intboolparameter {
    std::string description;
    //Two of these are put to null to indicate type:
    int * directvaraddress_int{};
    unsigned int * directvaraddress_uint{};
    bool * directvaraddress_bool{};
    int okrange_low{}; int okrange_high{};
    int valueSetByUser{};
  };

  std::map <std::string,doubleparameter>  m_doubleparMap;
  std::map <std::string,intboolparameter> m_intboolparMap;
 
  double m_propertyNotSetMagicNumber{};
  int m_propertyNotSetMagicNumber_int{};
};
 
#include "TRTDigSettings.icc"
 
#endif