PXDDQMEfficiencyNtupleSelftrackModule.cc

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#include <pxd/modules/pxdDQM/PXDDQMEfficiencyNtupleSelftrackModule.h>
#include <tracking/dataobjects/ROIid.h>
 
#include <pxd/reconstruction/PXDPixelMasker.h>
#include <mdst/dataobjects/Track.h>
#include <framework/gearbox/Const.h>
#include <framework/geometry/VectorUtil.h>
 
#include "TMatrixDSym.h"
#include <Math/Vector3D.h>
 
using namespace Belle2;
 
//-----------------------------------------------------------------
//                 Register the Module
//-----------------------------------------------------------------
REG_MODULE(PXDDQMEfficiencyNtupleSelftrack);
 
//-----------------------------------------------------------------
//                 Implementation
//-----------------------------------------------------------------
 
PXDDQMEfficiencyNtupleSelftrackModule::PXDDQMEfficiencyNtupleSelftrackModule() : Module(),
  m_vxdGeometry(VXD::GeoCache::getInstance())
{
  // Set module properties
  setDescription("Create basic histograms for PXD efficiency");
 
  // setPropertyFlags(c_ParallelProcessingCertified);// for ntuple not certified!!!
 
  // Parameter definitions
  addParam("pxdClustersName", m_pxdClustersName, "name of StoreArray with PXD cluster", std::string(""));
  addParam("recoTracksName", m_recoTracksName, "name of StoreArray with RecoTracks", std::string(""));
  addParam("tracksName", m_tracksName, "name of StoreArray with Tracks", std::string(""));
  addParam("ROIsName", m_ROIsName, "name of the list of HLT ROIs, if available in output", std::string(""));
  addParam("useAlignment", m_useAlignment, "if true the alignment will be used", true);
  addParam("pCut", m_pcut, "Set a cut on the track fit p-value (0=no cut)", double(0));
  addParam("minSVDHits", m_minSVDHits, "Number of SVD hits required in a track to be considered", 0u);
  addParam("momCut", m_momCut, "Set a cut on the track momentum in GeV/c, 0 disables", double(0));
  addParam("pTCut", m_pTCut, "Set a cut on the track pT in GeV/c, 0 disables", double(0));
  addParam("maskedDistance", m_maskedDistance, "Distance inside which no masked pixel or sensor border is allowed", int(10));
}
 
 
void PXDDQMEfficiencyNtupleSelftrackModule::terminate()
{
  auto dir = gDirectory;
  if (m_tuple) {
    if (m_file) { // no file -> no write to file
      m_file->cd();
    }
    m_tuple->Write();
    delete m_tuple;
    m_tuple = nullptr;
  }
  if (m_file) {
    m_file->Write();
    m_file->Close();
    delete m_file;
    m_file = nullptr;
  }
  dir->cd();
}
 
 
void PXDDQMEfficiencyNtupleSelftrackModule::initialize()
{
  m_file = new TFile("test.root", "recreate");
  if (m_file) m_file->cd();
  m_tuple = new TNtuple("effcontrol", "effcontrol",
                        "vxdid:u:v:p:pt:distu:distv:sigu:sigv:dist:inroi:clborder:cldead:matched:z0:d0:svdhits:charge:phi:costheta");
 
  //register the required arrays
  //Register as optional so validation for cases where they are not available still succeeds, but module will not do any meaningful work without them
  m_pxdclusters.isOptional(m_pxdClustersName);
  m_recoTracks.isOptional(m_recoTracksName);
  m_tracks.isOptional(m_tracksName);
  m_ROIs.isOptional(m_ROIsName);
}
 
 
void PXDDQMEfficiencyNtupleSelftrackModule::event()
{
  if (!m_pxdclusters.isValid()) {
    B2INFO("PXDClusters array is missing, no efficiencies");
    return;
  }
  if (!m_recoTracks.isValid()) {
    B2INFO("RecoTrack array is missing, no efficiencies");
    return;
  }
  if (!m_tracks.isValid()) {
    B2INFO("Track array is missing, no efficiencies");
    return;
  }
 
  for (auto& track : m_tracks) {
    RelationVector<RecoTrack> recoTrack = track.getRelationsTo<RecoTrack>(m_recoTracksName);
    if (!recoTrack.size()) continue;
 
    auto a_track = recoTrack[0];
    //If fit failed assume position pointed to is useless anyway
    if (!a_track->wasFitSuccessful()) continue;
 
    if (a_track->getNumberOfSVDHits() < m_minSVDHits) continue;
 
    const genfit::FitStatus* fitstatus = a_track->getTrackFitStatus();
    if (fitstatus->getPVal() < m_pcut) continue;
 
    genfit::MeasuredStateOnPlane trackstate;
    trackstate = a_track->getMeasuredStateOnPlaneFromFirstHit();
    if (trackstate.getMom().Mag() < m_momCut) continue;
    if (trackstate.getMom().Pt() < m_pTCut) continue;
 
    const TrackFitResult* ptr2 = track.getTrackFitResultWithClosestMass(Const::pion);
    if (!ptr2) {
      B2ERROR("expect a track fit result for mass");
      continue;
    }
 
    //loop over all PXD sensors to get the intersections
    std::vector<VxdID> sensors = m_vxdGeometry.getListOfSensors();
    for (VxdID& aVxdID : sensors) {
      VXD::SensorInfoBase info = m_vxdGeometry.getSensorInfo(aVxdID);
      if (info.getType() != VXD::SensorInfoBase::PXD) continue;
      //Search for intersections of the track with all PXD layers
      //Traditional (aka the person before did it like this) method
      //If there is a way to find out sensors crossed by a track directly, that would most likely be faster
 
      bool isgood = false;
      //true = track intersects current sensor
      double sigu(-9999);
      double sigv(-9999);
      ROOT::Math::XYZVector intersec_buff = getTrackInterSec(info, *a_track, isgood, sigu, sigv);
 
      if (!isgood) {
        continue;//track does not go through this sensor-> nothing to measure anyway
      } else {
 
        double u_fit = intersec_buff.X();
        double v_fit = intersec_buff.Y();
 
        int ucell_fit = info.getUCellID(intersec_buff.X());
        int vcell_fit = info.getVCellID(intersec_buff.Y());
 
        bool closeToBoarder = false;
        if (isCloseToBorder(ucell_fit, vcell_fit, m_maskedDistance)) {
          closeToBoarder = true;
        }
 
        bool closeToDead = false;
        if (isDeadPixelClose(ucell_fit, vcell_fit, m_maskedDistance, aVxdID)) {
          closeToDead = true;
        }
 
        bool fitInsideROI = false;
        if (m_ROIs.isValid()) {
          //Check if the intersection is inside a ROI
          //If not, even if measured the cluster was thrown away->Not PXD's fault
          for (auto& roit : m_ROIs) {
            if (aVxdID != roit.getSensorID()) {
              continue; //ROI on other sensor
            }
 
            if (ucell_fit < roit.getMaxUid()
                && ucell_fit > roit.getMinUid()
                && vcell_fit < roit.getMaxVid()
                && vcell_fit > roit.getMinVid()) {
              fitInsideROI = true;
            }
          }
        }
 
        //Now check if the sensor measured a hit here
 
        int bestcluster = findClosestCluster(aVxdID, intersec_buff);
        double du_clus = 0;
        double dv_clus = 0;
        double d_clus = 0;
        float charge = 0;
        bool matched = false;
        if (bestcluster >= 0) {
          double u_clus = m_pxdclusters[bestcluster]->getU();
          double v_clus = m_pxdclusters[bestcluster]->getV();
 
          //is the closest cluster close enough to the track to count as measured?
          ROOT::Math::XYZVector dist_clus(u_fit - u_clus, v_fit - v_clus, 0);
          du_clus = u_fit - u_clus;
          dv_clus = v_fit - v_clus;
          d_clus = dist_clus.R();
          charge = m_pxdclusters[bestcluster]->getCharge();
          matched = true;
        }
        float fill[22] = {float((int)aVxdID), float(u_fit), float(v_fit), float(trackstate.getMom().Mag()), float(trackstate.getMom().Pt()),
                          float(du_clus), float(dv_clus), float(sigu), float(sigv), float(d_clus),
                          float(fitInsideROI), float(closeToBoarder), float(closeToDead), float(matched),
                          float(ptr2->getZ0()), float(ptr2->getD0()), float(a_track->getNumberOfSVDHits()),
                          charge, float(trackstate.getMom().Phi()), float(trackstate.getMom().CosTheta())
                         };
        m_tuple->Fill(fill);
      }
    }
  }
}
 
 
 
ROOT::Math::XYZVector
PXDDQMEfficiencyNtupleSelftrackModule::getTrackInterSec(const VXD::SensorInfoBase& pxdSensorInfo, const RecoTrack& aTrack,
                                                        bool& isgood, double& du, double& dv)
{
  //will be set true if the intersect was found
  isgood = false;
 
  ROOT::Math::XYZVector intersec(99999999, 9999999, 0); //point outside the sensor
 
  genfit::MeasuredStateOnPlane gfTrackState = aTrack.getMeasuredStateOnPlaneFromFirstHit();
 
  //adopted (aka stolen) from tracking/modules/pxdClusterRescue/PXDClusterRescueROIModule
  try {
    // get sensor plane
    ROOT::Math::XYZVector zeroVec(0, 0, 0);
    ROOT::Math::XYZVector uVec(1, 0, 0);
    ROOT::Math::XYZVector vVec(0, 1, 0);
 
    genfit::DetPlane* sensorPlane = new genfit::DetPlane();
    sensorPlane->setO(XYZToTVector(pxdSensorInfo.pointToGlobal(zeroVec, m_useAlignment)));
    sensorPlane->setUV(XYZToTVector(pxdSensorInfo.vectorToGlobal(uVec, m_useAlignment)),
                       XYZToTVector(pxdSensorInfo.vectorToGlobal(vVec, m_useAlignment)));
 
    //boost pointer (will be deleted automatically ?!?!?)
    genfit::SharedPlanePtr sensorPlaneSptr(sensorPlane);
 
    // do extrapolation
    gfTrackState.extrapolateToPlane(sensorPlaneSptr);
  } catch (genfit::Exception& gfException) {
    B2WARNING("Fitting failed: " << gfException.getExcString());
    isgood = false;
    return intersec;
  } catch (...) {
    B2WARNING("Fitting failed: for some reason");
    isgood = false;
    return intersec;
  }
 
  //local position
  intersec = pxdSensorInfo.pointToLocal(ROOT::Math::XYZVector(gfTrackState.getPos()), m_useAlignment);
 
  //try to get the momentum
  B2DEBUG(1, "Fitted momentum on the plane p = " << gfTrackState.getMom().Mag());
 
  // no tolerance currently! Maybe one should be added!
  double tolerance = 0.0;
  bool inside = pxdSensorInfo.inside(intersec.X(), intersec.Y(), tolerance, tolerance);
 
  // get intersection point in local coordinates with covariance matrix
  TMatrixDSym covMatrix = gfTrackState.getCov(); // 5D with elements q/p,u',v',u,v in plane system
 
  // get ROI by covariance matrix and local intersection point
  du = std::sqrt(covMatrix(3, 3));
  dv = std::sqrt(covMatrix(4, 4));
 
  if (inside) isgood = true;
 
  return intersec;
}
 
 
int
PXDDQMEfficiencyNtupleSelftrackModule::findClosestCluster(const VxdID& avxdid, ROOT::Math::XYZVector intersection)
{
  int closest = -1;
  double mindist = 999999999999; //definitely outside of the sensor
 
  VXD::SensorInfoBase info = m_vxdGeometry.getSensorInfo(avxdid);
 
  //loop the clusters
  for (int iclus = 0; iclus < m_pxdclusters.getEntries(); iclus++) {
    //Do not consider as different if only segment differs!
    //As of this writing segment is never filled for clusters, but just to be sure
    VxdID clusterID = m_pxdclusters[iclus]->getSensorID();
    if (avxdid.getLayerNumber() != clusterID.getLayerNumber() ||
        avxdid.getLadderNumber() != clusterID.getLadderNumber() ||
        avxdid.getSensorNumber() != clusterID.getSensorNumber()) {
      continue;
    }
    //only cluster on the correct sensor and direction should survive
 
    double u = m_pxdclusters[iclus]->getU();
    double v = m_pxdclusters[iclus]->getV();
    ROOT::Math::XYZVector current(u, v, 0);
 
    //2D dist squared
    double dist = (intersection - current).R();
    if (dist < mindist) {
      closest = iclus;
      mindist = dist;
    }
  }
 
  return closest;
 
}
 
bool PXDDQMEfficiencyNtupleSelftrackModule::isCloseToBorder(int u, int v, int checkDistance)
{
 
  if (u - checkDistance < 0 || u + checkDistance >= 250 ||
      v - checkDistance < 0 || v + checkDistance >= 768) {
    return true;
  }
  return false;
}
 
bool PXDDQMEfficiencyNtupleSelftrackModule::isDeadPixelClose(int u, int v, int checkDistance, const VxdID& moduleID)
{
 
  //Iterate over square around the intersection to see if any close pixel is dead
  for (int u_iter = u - checkDistance; u_iter <= u + checkDistance ; ++u_iter) {
    for (int v_iter = v - checkDistance; v_iter <= v + checkDistance ; ++v_iter) {
      if (PXD::PXDPixelMasker::getInstance().pixelDead(moduleID, u_iter, v_iter)
          || !PXD::PXDPixelMasker::getInstance().pixelOK(moduleID, u_iter, v_iter)) {
        return true;
      }
    }
  }
  return false;
}