ResidualValidationNtupleHelper.h

Go to the documentation of this file.

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

// ResidualValidationNtupleHelper.h
//   Header file for ResidualValidationNtupleHelper
// (c) ATLAS Detector software
// Sebastian.Fleischmann@cern.ch
 
#ifndef TRK_RESIDUALVALIDATIONNTUPLEHELPER_H
#define TRK_RESIDUALVALIDATIONNTUPLEHELPER_H
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ToolHandle.h"
 
#include "TrkValInterfaces/IValidationNtupleHelperTool.h"
#include "TrkParameters/TrackParameters.h"
#include "TrkEventPrimitives/TrackStateDefs.h"
 
class AtlasDetectorID;
class TTree;
 
namespace Trk {
 
class MeasurementBase;
class IResidualPullCalculator;

 
class ResidualValidationNtupleHelper : virtual public Trk::IValidationNtupleHelperTool, public AthAlgTool {
public:
 
    // standard AlgToolmethods
    ResidualValidationNtupleHelper(const std::string&,const std::string&,const IInterface*);
    ~ResidualValidationNtupleHelper();
 
    // standard Athena methods
    StatusCode initialize();
    StatusCode finalize();

    virtual StatusCode fillMeasurementData (
        const Trk::MeasurementBase*,
        const Trk::TrackParameters*,
        //const NTuple::Item<long>& numberOfHits,
        //const std::bitset<8>& detectorType
        const int& detectorType,
        const bool& isOutlier );

    virtual StatusCode fillHoleData (
        const Trk::TrackStateOnSurface&,
        const int&);
 

    virtual StatusCode addNtupleItems (
        TTree* tree,
        const int& detectorType );

    virtual StatusCode resetVariables (
        const int& detectorType );
 
private:
 
    double calcPull(
        const double residual,
        const double locMesCov,
        const double locTrkCov ) const;
    void givePullWarning() const;
    void fillValues(const int& detectorType, double res1=-1000., double pull1=-1000., double res2=-1000., double pull2=-1000.);
 
    bool                m_pullWarning = false; 
    bool                m_trkParametersWarning; 

    ToolHandle<Trk::IResidualPullCalculator> m_residualPullCalculator;
 
    bool m_ignoreMissTrkCov;
 
    int* m_isUnbiased;
 
    // --- ntuple variables, documentation picked up by scripts for wiki tables ---
    std::vector<float>* m_PixPullPhi; 
    std::vector<float>* m_PixPullEta; 
    std::vector<float>* m_PixResPhi;  
    std::vector<float>* m_PixResEta;  
    
    std::vector<float>* m_SCTPull;    
    std::vector<float>* m_SCTRes;     
 
    std::vector<float>* m_TRTPull;    
    std::vector<float>* m_TRTRes;     
 
    std::vector<float>* m_MDTPull;    
    std::vector<float>* m_MDTRes;     
 
    std::vector<float>* m_RPCPull;    
    std::vector<float>* m_RPCRes;     
 
    std::vector<float>* m_TGCPull;    
    std::vector<float>* m_TGCRes;     
 
    std::vector<float>* m_CSCPull;    
    std::vector<float>* m_CSCRes;     
 
};
 
 inline void Trk::ResidualValidationNtupleHelper::givePullWarning() const {
   [[maybe_unused]] static const bool pullWarningOnce = [&]() {
        msg(MSG::WARNING) << "no covariance of the track parameters given, can not calc pull!" << endmsg;
        msg(MSG::WARNING) << "you may want to use the jobOption 'IgnoreMissingTrackCovariance' to calculate it anyhow." << endmsg;
        return true;
   }();
 }
 inline void Trk::ResidualValidationNtupleHelper::fillValues(const int& detectorType, double res1, double pull1, double res2, double pull2) {
   if (detectorType==TrackState::Pixel) {
        m_PixResPhi->push_back(res1);
        m_PixResEta->push_back(res2);
        m_PixPullPhi->push_back(pull1);
        m_PixPullEta->push_back(pull2);
    } else if (detectorType==TrackState::SCT) {
        m_SCTRes->push_back(res1);
        m_SCTPull->push_back(pull1);
    } else if (detectorType==TrackState::TRT) {
        m_TRTRes->push_back(res1);
        m_TRTPull->push_back(pull1);
    } else if (detectorType==TrackState::MDT) {
        m_MDTRes->push_back(res1);
        m_MDTPull->push_back(pull1);
    } else if (detectorType==TrackState::RPC) {
        m_RPCRes->push_back(res1);
        m_RPCPull->push_back(pull1);
    } else if (detectorType==TrackState::TGC) {
        m_TGCRes->push_back(res1);
        m_TGCPull->push_back(pull1);
    } else if (detectorType==TrackState::CSC) {
        m_CSCRes->push_back(res1);
        m_CSCPull->push_back(pull1);
    }
}
 
} // end of namespace
 
#endif // TRK_RESIDUALVALIDATIONNTUPLEHELPER_H