CscCalibTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2020 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef CSCCALIBTOOLBASE_H
#define CSCCALIBTOOLBASE_H
 
/*******************************************************************************
 Name    : CscCalibToolBase.h
 Package : offline/MuonSpectrometer/MuonCalib/MuonCalibTools
 Author  : Ketevi A. Assamagan
 Created : March 2005
 
 DESCRIPTION:
     This class is the base class for run time CSC calibration tools.
     These calibration tools need theCSC conditions data. The conditions data
     are written and read with a different set of tools. The production of the
     conditions data can be done via ATHENA or standalone
*******************************************************************************/
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "MuonCondData/CscCondDbData.h"
#include "CscCalibTools/ICscCalibTool.h"
#include "CxxUtils/checker_macros.h"
 
#include "TF1.h"
 
#include <atomic>
#include <inttypes.h>
#include <memory>
#include <mutex>
#include <vector>
 
class CscCondDbData;
 
class CscCalibTool : public extends<AthAlgTool, ICscCalibTool> {
 
public:
  CscCalibTool(const std::string&, const std::string&, const IInterface*);
  virtual ~CscCalibTool () = default;
 
  virtual StatusCode initialize() override final;

  virtual int femtoCoulombToADCCount (uint32_t stripHashId, const double femtoCoulombs) const override final;

  virtual int numberOfElectronsToADCCount(uint32_t stripHashId, const int numberOfElecEquiv) const override final;

  virtual double adcCountToFemtoCoulomb (const float adcCounts, const float slope) const override final;
  virtual double adcCountToFemtoCoulomb (uint32_t stripHashId, const float adcCounts) const override final;

  virtual double adcCountToNumberOfElectrons (const float adcValue, const float slope) const override final;
  virtual double adcCountToNumberOfElectrons (uint32_t stripHashId, const float adcValue) const override final;

  virtual bool adcToCharge(const std::vector<uint16_t>& samples, uint32_t stripHashId,
                                 std::vector<float>& charges) const override final;

  virtual bool findCharge(const float samplingTime, const unsigned int samplingPhase,
                                const std::vector<float>& samples,double & charge, double & time) const override final;
 

  virtual double stripNoise ( uint32_t stripHashId, const bool convert=true ) const override final;

  virtual double stripRMS ( uint32_t stripHashId, const bool convert=true ) const override final;

  virtual double stripF001 ( uint32_t stripHashId, const bool convert=true ) const override final;

  virtual double stripPedestal ( uint32_t stripHashId, const bool convert=true ) const override final;

  virtual bool isGood ( uint32_t stripHashId ) const override final;

  virtual int stripStatusBit ( uint32_t stripHashId ) const override final;

  virtual bool stripT0phase ( uint32_t stripHashId ) const override final;

  virtual double stripT0base ( uint32_t stripHashId ) const override final;

  virtual double func (const double x, const float slope) const override final;
  virtual double func_prime (const double x, const float slope) const override final;
 
  virtual double signal (const double z) const override final;
  virtual double signal_amplitude (const double driftTime, const double samplingTime) const override final;
  virtual double getZ0() const override final;
 
  virtual double getSamplingTime() const override final;
  virtual double getTimeOffset() const override final;
  virtual double getSignalWidth() const override final;
  virtual double getNumberOfIntegration() const override final;
  virtual double getNumberOfIntegration2() const override final;
 
  //  virtual Double_t bipfunc (const Double_t *x, const Double_t *par);
  //  virtual Double_t dualbipfunc (const Double_t *x, const Double_t *par);
 
  // To add bipolar functions and extract drftTime and stripCharge after addition,
  // this function is defined. Return value is pair and the first one is driftTime.
  virtual std::pair<double,double> addBipfunc(const double driftTime0, const double stripCharge0,
                                              const double driftTime1, const double stripCharge1) const override final;
 
  // 09/2010
  virtual std::vector<float> getSamplesFromBipolarFunc(const double driftTime0, const double stripCharge0) const override final;
  virtual double getLatency() const override final;
 
 
  mutable std::atomic_int m_messageCnt_t0base{};
  mutable std::atomic_int m_messageCnt_t0phase{};
  //private:
  //  ../src/CscCalibTool.cxx: In member function 'virtual bool CscCalibTool::stripT0phase(uint32_t) const':
  //  ../src/CscCalibTool.cxx:351: error: increment of data-member 'CscCalibTool::m_messageCnt_t0phase' in read-only structure
  //  ../src/CscCalibTool.cxx: In member function 'virtual double CscCalibTool::stripT0base(uint32_t) const':
  //  ../src/CscCalibTool.cxx:371: error: increment of data-member 'CscCalibTool::m_messageCnt_t0base' in read-only structure
  // due to const in format?
 
private:
  float getPSlope(uint32_t stripHashId) const;
 
 
protected:
 
  SG::ReadCondHandleKey<CscCondDbData> m_readKey{this, "ReadKey", "CscCondDbData", "Key of CscCondDbData"};   
 
  bool  m_readFromDatabase;
  bool  m_slopeFromDatabase;
 
  float m_slope;
  float m_noise;
  float m_pedestal;

  // define bipolar functional shape
  // Parameters are from Kostas presentation at the following link (09/2007)
  // http://indico.cern.ch/getFile.py/access?contribId=1&resId=1&materialId=slides&confId=18787
  double m_integrationNumber;
  double m_integrationNumber2;
 
  double m_samplingTime;
  double m_signalWidth;
  double m_timeOffset; // bipolar's start time (or drift time)
 
  double m_latency; // new in 2010....latency may be controlled in CscCalibTool.
 
  unsigned int m_nSamples;
 
  bool m_onlineHLT;
  bool m_use2Samples; // for the use of only 2 samples for strip charge
 
};
 
#endif