AFPSiDBasicKalmanTool.h

Go to the documentation of this file.

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

#ifndef AFP_LOCRECO_AFPSIDBASICKALMANTOOL_H
#define AFP_LOCRECO_AFPSIDBASICKALMANTOOL_H 1
 
 
#include <CLHEP/Matrix/Matrix.h>
#include <CLHEP/Matrix/Vector.h>
 
// FrameWork includes
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ServiceHandle.h"
 
// Monitoring includes
#include "AthenaMonitoringKernel/Monitored.h"
#include "AthenaMonitoringKernel/GenericMonitoringTool.h"
 
// xAOD includes
#include "xAODForward/AFPSiHitsCluster.h"
#include "xAODForward/AFPSiHitsClusterContainer.h"
#include "xAODForward/AFPTrackContainer.h"
#include "xAODForward/AFPTrackAuxContainer.h"
#include "xAODForward/AFPTrackRecoAlgID.h"
 
// AFP_LocReco includes
#include "AFP_LocReco/IAFPSiDLocRecoTrackAlgTool.h"
#include "AFP_LocReco/AFPLocRecoStationBasicObj.h"
#include "AFP_LocReco/AFPSiDBasicKalmanToolTrack.h"
 
// STL includes
#include <string>
#include <list>
#include <vector>
#include <utility> // pair
#include <algorithm> // sort
 

class AFPSiDBasicKalmanTool
  : public extends<AthAlgTool, IAFPSiDLocRecoTrackAlgTool>
{
public:
  AFPSiDBasicKalmanTool(const std::string& type,
                        const std::string& name,
                        const IInterface* parent);
 
  virtual ~AFPSiDBasicKalmanTool() override {}

  virtual StatusCode initialize() override;

  virtual StatusCode finalize() override;

  StatusCode reconstructTracks(std::unique_ptr<xAOD::AFPTrackContainer>& outputContainer, const EventContext& ctx) const override;

  const std::string& outputContainerName () const override {return m_tracksContainerName;}

  void filterTrkCollection(std::list<AFPSiDBasicKalmanToolTrack>& reconstructedTracks) const;

  unsigned int countSharedClusters(const AFPSiDBasicKalmanToolTrack& firstTrack, const AFPSiDBasicKalmanToolTrack& secondTrack) const;
        
  void clearAllLayers(AFPLocRecoStationBasicObj& my_stationClusters) const
  {my_stationClusters.clear();}
 
 
private:

  Gaudi::Property<std::string> m_tracksContainerName{this, "tracksContainerName", "AFPTrackContainer", "Name of the container in which tracks are saved"};

  Gaudi::Property<int> m_stationID{this, "stationID", 0, "ID number of station for which tracks should be reconstructed"};

  CLHEP::HepMatrix m_observationModel;

  Gaudi::Property<std::vector<float> > m_observationModelInit{this, "observationModel", {}, "vector used to initialise observation model matrix (2x4), the first four numbers correspond to the first row of the matrix"};

  CLHEP::HepMatrix m_observationNoise;

  Gaudi::Property<std::vector<float>> m_observationNoiseInit{this, "observationNoise", {}, "vector used to initialise observation noise matrix (2x2), the first two numbers correspond to the first row of the matrix"};
 

  CLHEP::HepMatrix m_processNoiseCov;

  Gaudi::Property<std::vector<float>> m_processNoiseCovInit{this, "processNoiseCov", {}, "A vector used to initialise process noise covariance matrix (4x4).The first 4 numbers correspond to the first row of the matrix."};

  CLHEP::HepMatrix m_aposterioriCov;

  Gaudi::Property<std::vector<float>> m_aposterioriCovInit{this, "aposterioriCov", {}, "A vector used to initialise a posteriori covariance matrix (4x4). The first 4 numbers correspond to the first row of the matrix."};

  Gaudi::Property<int> m_numberOfLayersInStation{this, "numberOfLayersInStations", 4, "The size of the vector sets number of stations. Each element defines number of pixel layers in the station."};

  SG::ReadHandleKey<xAOD::AFPSiHitsClusterContainer> m_hitsClusterContainerKey{this, "AFPSiHitsClusterContainerKey", "AFPSiHitsClusterContainer", "Name of the container with clusters of hits from which tracks are to be reconstructed"};

  Gaudi::Property<double> m_maxAllowedDistance{this, "maxAllowedDistance", 10, "Maximal distance at which cluster can be joined to the track"};

  Gaudi::Property<unsigned int> m_minClustersNumber{this, "minClustersNumber", 3, "Minimal number of clusters in track. If there are less clusters track is rejected"};

  Gaudi::Property<unsigned int> m_maxSharedClusters{this, "maxSharedClusters", 2, "Maximal number of hits that two tracks can share. If they share more one is deleted."};

  Gaudi::Property<float> m_clusterMaxChi2{this, "clusterMaxChi2", 3, "Maximal value of chi2 for which a cluster is added."};

  Gaudi::Property<float> m_trackMaxChi2{this, "trackMaxChi2", 3, "Maximal value of chi2 for the track."};
  
  Gaudi::Property<double> m_allowedDistanceBetweenClustersInSeed{this, "allowedDistanceBetweenClustersInSeed", 0.5, "Maximum allowed distance between clusters in a seed to be considered coming from the same proton; if the difference between clusters is 2 layers (3 layers), this distance is multiplied by 2 (3)"};
  
  Gaudi::Property<std::vector<std::pair<int,int>>> m_layersForSeeds{this, "layersForSeeds", {{0,1}}, "Pairs of layers that are used to create seeds."};
  
  void fillLayersWithClusters(AFPLocRecoStationBasicObj& my_stationClusters, SG::ReadHandle<xAOD::AFPSiHitsClusterContainer>& hitsClusterContainer) const;

  void initMatrixFromVector (CLHEP::HepMatrix& matrix, const std::vector<float>& vec1D) const;

  bool checkMatrixAndVectorSize(const CLHEP::HepMatrix& matrix, const std::vector<float>& vec1D) const
  {return ((int)vec1D.size()) == matrix.num_row()*matrix.num_col();}
  
  bool areNeighbours(const xAOD::AFPSiHitsCluster* a, const xAOD::AFPSiHitsCluster* b, const double dist) const;

  void saveToXAOD (const AFPSiDBasicKalmanToolTrack& recoTrack, std::unique_ptr<xAOD::AFPTrackContainer>& containerToFill, SG::ReadHandle<xAOD::AFPSiHitsClusterContainer>& hitsClusterContainer) const;
  
  ToolHandle<GenericMonitoringTool> m_monTool {this, "MonTool", "", "Monitoring tool"};
};
 
 
#endif // > !AFP_LOCRECO_AFPSIDBASICKALMANTOOL_H