MdtCalibHitBase.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
*/
 
/***************************************************************************
 * Mdt Calibration Input Event Data Model
 ***************************************************************************/
 
#ifndef MUONCALIB_MDTCALIBHITBASE_H
#define MUONCALIB_MDTCALIBHITBASE_H
 
// std
#include <float.h>
 
#include <cassert>
#include <cmath>
#include <iostream>
 
// other packages
#include "GeoPrimitives/GeoPrimitives.h"
 
// this package
#include "MuonCalibIdentifier/MuonFixedId.h"
 
namespace MuonCalib {

 
    class MdtCalibHitBase {
    public:
        static constexpr float kNoValue{FLT_MAX};
        struct defineParams {
            /* Fixed, Athena-independent Identifier*/
            MuonFixedId id{0};                                    
            int tdc{0};                                           
            int adc{0};                                           
            Amg::Vector3D globalPosition{0, 0, 0};                
            Amg::Vector3D localPosition{0, 0, 0};                 
            Amg::Vector3D localPointOfClosestApproach{0, 0, 0};   
            Amg::Vector3D globalPointOfClosestApproach{0, 0, 0};  
            float driftTime{FLT_MAX};                             
            float driftRadius{FLT_MAX};                           
            float sigma2DriftRadius{FLT_MAX};                     
            float timeFromTrackDistance{FLT_MAX};  
            float sigma2TimeFromTrackDistance{FLT_MAX};  
            float slewingTime{FLT_MAX};                  
            float bFieldTime{FLT_MAX};                   
            float propagationTime{FLT_MAX};              
            float timeOfFlight{FLT_MAX};                 
            float distanceToReadout{FLT_MAX};            
            float signedDistanceToTrack{FLT_MAX};        
            float sigma2DistanceToTrack{FLT_MAX};        
            float wiresagTime{FLT_MAX};                  
            float temperatureTime{FLT_MAX};              
            float backgroundTime{FLT_MAX};               
            float bFieldPerp{FLT_MAX};                   
            float bFieldPara{FLT_MAX};                   
            float temperature{FLT_MAX};                  
            float projSag{FLT_MAX};                      
            float tube_t0{FLT_MAX};                      
            float tube_adccal{FLT_MAX};                  
            float xtwin{FLT_MAX};                        
            float sigmaXTwin{FLT_MAX};                   
            bool segmentT0Applied{false};                
            float tubeRadius{FLT_MAX};                   
        };
 
        MdtCalibHitBase() = default;                                       
        MdtCalibHitBase &operator=(const MdtCalibHitBase &rhs) = default;  
        MdtCalibHitBase(const MdtCalibHitBase &event) = default;           
        ~MdtCalibHitBase() = default;                                      
 
        MdtCalibHitBase(const MdtCalibHitBase::defineParams &pars);
        MdtCalibHitBase(
            int tdc, int adc, const Amg::Vector3D &globalPos,
            const Amg::Vector3D &localPos);  
 
        // setters
        void setIdentifier(const MuonFixedId &id);                         
        void setTdc(unsigned short tdc);                                   
        void setAdc(unsigned short adc);                                   
        void setGlobalPos(const Amg::Vector3D &globalPos);                 
        void setLocalPos(const Amg::Vector3D &localPos);                   
        void setGlobalPointOfClosestApproach(const Amg::Vector3D &point);  
        void setLocalPointOfClosestApproach(const Amg::Vector3D &point);   
        void setDriftTime(float t);                                        
        void setDriftRadius(float r, float sigmaR);                        
        void setTubeRadius(float r);                                       
        void setDistanceToTrack(float dist, float sigmaDist);              
        void setTimeFromTrackDistance(float t, float sigmaT);  
        void setSlewingTime(float slew);                       
        void setBFieldTime(float lor);                         
        void setPropagationTime(float prop);    
        void setTimeOfFlight(float tof);        
        void setDistanceToReadout(float dist);  
        void setWiresagTime(float wsag);        
        void setTemperatureTime(float temp);    
        void setBackgroundTime(float bkgr);     
        void setBFieldPerp(float bfperp);       
        void setBFieldPara(float bfpara);       
        void setTemperature(float temp);        
        void setProjSag(float sag);             
        void setTubeT0(float t0);               
        void setTubeAdcCal(float adccal);       
        void setLocXtwin(float xtwin);          
        void setSigmaLocXtwin(float xtwin);     
        void setSegmentT0Applied(bool flag);    
 
        /* getters */
        const MuonFixedId &identify() const;                        
        const Amg::Vector3D &globalPosition() const;                
        const Amg::Vector3D &localPosition() const;                 
        const Amg::Vector3D &globalPointOfClosestApproach() const;  
        const Amg::Vector3D &localPointOfClosestApproach() const;   
        unsigned short tdcCount() const;                            
        unsigned short adcCount() const;                            
        float driftTime() const;                                    
        float driftRadius() const;                                  
        float sigmaDriftRadius() const;                             
        float sigma2DriftRadius() const;                            
        float signedDistanceToTrack() const;                        
        float sigmaDistanceToTrack() const;                         
        float sigma2DistanceToTrack() const;                        
        float tubeRadius() const;                                   
        float distanceToReadout() const;                            
        float slewingTime() const;                                  
        float bFieldTime() const;                   
        float propagationTime() const;              
        float timeOfFlight() const;                 
        float timeFromTrackDistance() const;        
        float sigmaTimeFromTrackDistance() const;   
        float sigma2TimeFromTrackDistance() const;  
        float radialResidual() const;               
        float trackResidual() const;                
        float timeResidual() const;                 
        float WiresagTime() const;                  
        float TemperatureTime() const;              
        float BackgroundTime() const;
        float bFieldPerp() const;       
        float bFieldPara() const;       
        float temperature() const;      
        float projSag() const;          
        float tubeT0() const;           
        float tubeAdcCal() const;       
        float xtwin() const;            
        float sigmaXtwin() const;       
        bool segmentT0Applied() const;  
 
        /* ostream operators */
        std::ostream &dump(std::ostream &stream) const;  
 
    private:
        defineParams m_pars{};
    };
 
}  // namespace MuonCalib
 
std::ostream &operator<<(std::ostream &stream, const MuonCalib::MdtCalibHitBase &hit);
 
#endif  // MUONCALIB_MDTCALIBHITBASE_H