ResidualPull.h

Go to the documentation of this file.

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

//  Header file for class ResidualPull
// (c) ATLAS Detector software
// Class for residual and pull information
// Sebastian.Fleischmann@cern.ch
 
#ifndef TRK_RESIDUALPULL_H
#define TRK_RESIDUALPULL_H
 
#include <vector>
 
namespace Trk {
 
class ResidualPull
{
  // Public methods:
 
public:
  enum ResidualType
  {
    McTruth = 0,  
    Biased = 1,   
    HitOnly = 2,  
    Unbiased = 3, 
    NumberOfResidualTypes = 4
  };

  ResidualPull() = default;
  ResidualPull(std::vector<double> residual,
               std::vector<double> pull,
               bool pullValid,
               ResidualType residualType,
               int parameterKey,
               double sineStripAngle = 0.0);

  // Main methods

  const std::vector<double>& residual() const;

  const std::vector<double>& pull() const;

  bool isPullValid() const;

  int parameterKey() const;

  int dimension() const;

  ResidualType residualType() const;

  double sineStripAngle() const;
 
protected:
  // Protected Data
  std::vector<double> m_residual{};
  std::vector<double> m_pull{};
  bool m_pullValid = false;
  ResidualType m_residualType = Trk::ResidualPull::Biased;
  int m_parameterKey = 0;
  double m_sineStripAngle = 0.0;
};

// Inline methods
 
} // end of name space
#include "TrkEventPrimitives/ResidualPull.icc"
#endif // TRK_RESIDUALPULL_H