MuonSelector.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
//==================================================================================
//
//  ZMM_Event.cxx :       Class designed to reconstruct di-boson events
//                        in particular Z0 -> mu+ mu- events.
//  Author :              Kyle Stevenson, QMUL
//  Date :                7th December 2007
//
//==================================================================================
 
//==================================================================================
// Include files...
//==================================================================================
 
// This files header
#include "InDetPerformanceMonitoring/MuonSelector.h"
// Package Headers
#include <sstream>
// ATLAS headers
#include "AthenaKernel/getMessageSvc.h"
#include "StoreGate/StoreGateSvc.h"
#include "CLHEP/Random/RandFlat.h"
 
#include "xAODMuon/Muon.h"
#include "xAODMuon/MuonContainer.h"
 
using CLHEP::GeV;
 
// Local debug variables. Global scope, but only accessible by this file.
//static const float CGeV              =  1.0e-3;  // Conversion factor to remove evil MeV
                                                 // nonsense.
 
// Static declarations
// unsigned int MuonSelector::m_uNumInstances;
 
//==================================================================================
// Public Methods
//==================================================================================
 
MuonSelector::MuonSelector():
  m_muonSelectionTool("CP::MuonSelectionTool/MuonSelectionTool"),
  m_doDebug ( false ),
  m_doQualSelection ( false ),
  m_doIsoSelection  ( false ),
  m_doPtSelection   ( true  ),
  m_doIPSelection   ( true  ),
  m_doMCPSelection    ( true  )
{
  // SOC commented by Salva -- R22 test --
  //++s_uNumInstances;
  //std::stringstream xTmp;  xTmp << s_uNumInstances;
  //m_xSampleName     = "MuID_" + xTmp.str(); 
  // EOC commented by Salva -- R22 test --
  unsigned int inst = ++m_uNumInstances;
  m_xSampleName     = "MuID_" + std::to_string(inst);
  m_pxMuon = nullptr;
  m_bLock  = false;
 
  
  // requested muon tag (tight, medium, loose..)
  m_requestedMuonQuality = xAOD::Muon::Medium; 
 
 
  m_coneSize        = 0.4;
  m_ucJMuon_Cut     = 0; //not used
  m_IsoCut          = 0.2;
 
  m_bCutOnCombKine  = false; //not used
  m_fEtaCut         = 2.5;
  //m_fEtaCut         = 1.9;
  m_combPtCut       = 15.0*CLHEP::GeV; // GeV/c
  //    m_combPtCut       = .01*CLHEP::GeV; // GeV/c
 
  //m_ptMSCut         = 10.0*CLHEP::GeV;
  m_ptMSCut         = 0.0*CLHEP::GeV;
  m_diffZCut        = 1.5*CLHEP::mm;  // mm --> used to be 10.0*CLHEP::mm // Changed by Salva 26/january/2016
  m_diffPtCut       = 15.0*CLHEP::GeV;  // not used
  m_pVZCut          = 150.0*CLHEP::mm; // mm
 
  m_fIDPtCut        = 0.0;     // GeV/c
  m_fIDChiPerDofCut = 4.0;
  m_IDSiHitsCut     = 8;
  m_ucID_PIXCut     = 1;        // Hits
  m_ucID_SCTCut     = 4;        // Hits
  m_ucID_TRTCut     = 0;        // Hits
 
  m_msgStream =  new MsgStream(Athena::getMessageSvc(), "InDetPerformanceMonitoring");
 
  // stats
  m_testedmuons = 0;
  m_passqual = 0;
  m_passiso = 0;
  m_passpt = 0;
  m_passip = 0;
  m_passmcp = 0;
  m_passall = 0;
 
  // done
}

MuonSelector::~MuonSelector()
{
  --m_uNumInstances;
  delete m_msgStream;
}

void MuonSelector::Init()
{
  
  // check muon selection tool is available
  if (m_muonSelectionTool.retrieve().isSuccess()) {
    ( *m_msgStream) << MSG::INFO << "  * MuonSelector::Init * m_muonSelectionTool.initialize() success :)" << endmsg;
    if(m_doDebug){ std::cout << "  * MuonSelector::Init * m_muonSelectionTool.initialize() success :)" << std::endl;}
  }
  else {
    (*m_msgStream) << MSG::ERROR << "  * MuonSelector::Init * FAILURE * Muon selction tool retrieving failed :( " << endmsg;    
  }
 
  PARENT::Init();
}
 
 
 
bool MuonSelector::Reco()
{
  return true;
}

//bool MuonSelector::passSelection( const Analysis::Muon* pxMuon )
bool MuonSelector::passSelection( const xAOD::Muon* pxMuon)
{
  if(m_doDebug){ std::cout << "  * MuonSelector::passSelection * START * new muon " << pxMuon << " with pt: " << pxMuon->pt() << std::endl; }
 
  std::vector<bool> passes;
  bool pass = true;
  if ( pxMuon ) {
    // Save local copy of muon address if it's ok.
    m_pxMuon = pxMuon;
    m_testedmuons++;
    
    // Test muon pass conditions in turn
    if(m_doQualSelection){
      pass = passQualCuts();
      passes.push_back(pass);
      if (m_doDebug && !pass) std::cout <<"  * MuonSelector::passSelection * Muon Fails QualSelection"<<std::endl;
      if (pass) m_passqual++;
    }
 
    if (m_doIsoSelection){
      pass = passIsolCuts();
      passes.push_back(pass);
      if (m_doDebug && !pass) std::cout<<"  * MuonSelector::passSelection * Muon Fails Iso Selection"<<std::endl;
      if (pass) m_passiso++;
    }
 
 
    if (m_doPtSelection){
      pass = passPtCuts();
      passes.push_back(pass);
      if (m_doDebug && !pass) std::cout<<"  * MuonSelector::passSelection * Muon Fails pT Selection"<<std::endl;
      if (pass) m_passpt++;
    } 
 
    if (m_doIPSelection){
      pass = passIPCuts();
      passes.push_back(pass);
      if (m_doDebug && !pass) std::cout<<"  * MuonSelector::passSelection * Muon Fails IP Selection"<<std::endl;
      if (pass) m_passip++;
    }
 
    if (m_doMCPSelection) {
      xAOD::Muon::Quality my_quality=m_muonSelectionTool->getQuality(*pxMuon);
      if (m_doDebug) std::cout << "  * MuonSelector::passSelection * muon quality from muonsSelectionTool: " << my_quality << std::endl;
 
      pass = true; 
      if (m_requestedMuonQuality == xAOD::Muon::Tight     && my_quality > xAOD::Muon::Tight)     pass = false;
      if (m_requestedMuonQuality == xAOD::Muon::Medium    && my_quality > xAOD::Muon::Medium)    pass = false;
      if (m_requestedMuonQuality == xAOD::Muon::Loose     && my_quality > xAOD::Muon::Loose)     pass = false;
      if (m_requestedMuonQuality == xAOD::Muon::VeryLoose && my_quality > xAOD::Muon::VeryLoose) pass = false;
 
      passes.push_back(pass);
      if (m_doDebug &&  pass) std::cout<<"  * MuonSelector::passSelection * Muon Passes official m_muonSelectionTool (medium) Selection :)" << std::endl;
      if (m_doDebug && !pass) std::cout<<"  * MuonSelector::passSelection * Muon Fails official m_muonSelectionTool (medium) Selection" << std::endl;
      if (pass) m_passmcp++;
    }
 
    // check if the muon failed some of the cuts
    for (int i=0; i < int(passes.size()); i++)
      if (!passes[i]){
    if(m_doDebug) std::cout << "  * MuonSelector::passSelection * BAD MUON * muon haven't passed the " << i+1 << "th selection " << std::endl;
    return false;
      }
  } // if pxMuon exists
 
  // reached this point, the muon passed all selection criteria. This muon is good
  m_passall++;
  if(m_doDebug){ std::cout << "  * MuonSelector::passSelection  * completed. GOOD MUON " << std::endl; }
  return true;
}
 
 
//==================================================================================
// Protected Methods
//==================================================================================
void MuonSelector::BookHistograms( )
{
}
 
 
//==================================================================================
// Private Methods
//==================================================================================
bool MuonSelector::passQualCuts()
{
  bool goodTrack = false;
 
  // First get the muon track, then the summary  
  const xAOD::TrackParticle* IDTrk = m_pxMuon->trackParticle(xAOD::Muon::InnerDetectorTrackParticle); // use the Inner Detector segment
  
  if (IDTrk) {
    uint8_t dummy(-1);
    bool eBLhits = IDTrk->summaryValue( dummy, xAOD::expectBLayerHit ) ? true : false;
    int  nBLhits = IDTrk->summaryValue( dummy, xAOD::numberOfBLayerHits ) ? dummy :-1;
 
    int nhitsPIX = IDTrk->summaryValue( dummy, xAOD::numberOfPixelHits ) ? dummy :-1;
    int nhitsSCT = IDTrk->summaryValue( dummy, xAOD::numberOfSCTHits ) ? dummy :-1;
    int nhitsTRT = IDTrk->summaryValue( dummy, xAOD::numberOfTRTHits ) ? dummy :-1;
 
    int nPIXDS = IDTrk->summaryValue( dummy, xAOD::numberOfPixelDeadSensors ) ? dummy :-1;
    int nSCTDS = IDTrk->summaryValue( dummy, xAOD::numberOfSCTDeadSensors ) ? dummy :-1;
 
    int nPIXH = IDTrk->summaryValue( dummy, xAOD::numberOfPixelHoles )? dummy :-1;
    int nSCTH = IDTrk->summaryValue( dummy, xAOD::numberOfSCTHoles )? dummy :-1;
    int nTRTH = IDTrk->summaryValue( dummy, xAOD::numberOfTRTHoles )? dummy :-1;
 
    int nContribPixLayers = IDTrk->summaryValue( dummy, xAOD::numberOfContribPixelLayers )? dummy :-1; 
 
    if(m_doDebug) std::cout << "  * MuonSelector * passQualCuts() * eBLhits: " << eBLhits
                << "  nBLhits:  " << nBLhits
                << "  nhitsPIX: " << nhitsPIX
                << "  nPIXLayers: " << nContribPixLayers 
                << "  nhitsSCT: " << nhitsSCT
                << "  Silicon holes: " << nPIXH + nSCTH
                << "    nhitsTRT: " << nhitsTRT
                << "  nTRTholes: " << nTRTH
                << std::endl;
 
    if (((!eBLhits) || (nBLhits > 0))
    &&   (nhitsPIX + nPIXDS > 1 )
    &&   (nhitsSCT + nSCTDS >=6 )
    &&   (nPIXH    + nSCTH  < 2 ) ) {
      goodTrack = true;
    }
  }
 
  if (m_doDebug) {
    if (goodTrack) {
      std::cout << "   * MuonSelector * passQualCuts() * this muon satisfies the hits number QualCuts  "  << std::endl;
    }
    else {
      std::cout << "   * MuonSelector * passQualCuts() * this muon did not pass the hits number QualCuts  "  << std::endl;
    }
  }
  return goodTrack;
}

bool MuonSelector::passPtCuts()
{
 
  if(m_doDebug) std::cout << "    * MuonSelector::passPtCuts * START *" << std::endl; 
 
  const xAOD::TrackParticle* pxMuonID = m_pxMuon->trackParticle(xAOD::Muon::InnerDetectorTrackParticle);
  const xAOD::TrackParticle* pxMuonMS = m_pxMuon->trackParticle(xAOD::Muon::MuonSpectrometerTrackParticle);
  const xAOD::TrackParticle* pxMuonCB = m_pxMuon->trackParticle(xAOD::Muon::CombinedTrackParticle);
 
  double pt = 0, ptID, ptMS,ptCB;
 
  if ( !(pxMuonID || pxMuonMS || pxMuonCB)){
         if(m_doDebug) std::cout << "    * MuonSelector::passPtCuts * NO inDetTrackParticle && muonSpectrometerTrackParticle && CombinedTrackParticle: " << std::endl;
  }
 
  else {
 
    pt    = m_pxMuon->pt();
    ptID  = pxMuonID ? pxMuonID->pt() : 0.0 ;
    ptMS  = pxMuonMS ? pxMuonMS->pt() : 0.0 ;
    ptCB  = pxMuonCB ? pxMuonCB->pt() : 0.0 ;
    double fMEta = std::abs( m_pxMuon->eta() );
 
    if(m_doDebug) std::cout << "    * MuonSelector::passPtCuts * pt of each segments of this muon pxMuon: " << pt << std::endl
                << "                                                                    ptID: " << ptID << std::endl 
                << "                                                                    ptMS: " << ptMS << std::endl
                << "                                                                    ptCB: " << ptCB << std::endl
                << "                                                     fMEta pxMuon->eta(): " << fMEta << std::endl;
 
    
    if ( (fMEta < m_fEtaCut)    
     && (pt    > m_combPtCut)  
     && (ptMS  > m_ptMSCut || !pxMuonMS)
     && (ptID  > m_ptMSCut || !pxMuonID)
     ){
      // warning one can check also the difference of pt: std::abs(ptMS - ptID) < m_diffPtCut
      if(m_doDebug) std::cout << "    * MuonSelector::passPtCuts * this muon is in eta range |eta|= " << fMEta << " < EtaCut(" << m_fEtaCut << ") " << std::endl 
                  << "                                 and passed the PtCuts (" << m_combPtCut <<") "<< std::endl;
      return true;
    }
  }
  if(m_doDebug) std::cout << "    * MuonSelector::passPtCuts * this muon did not pass the PtCuts (reco pt=" << pt << ") or Eta cut " << m_fEtaCut << std::endl;
  return false;
}

bool MuonSelector::passIsolCuts()
{
  float iso_pt40(0);
  if( !m_pxMuon->isolation(iso_pt40, xAOD::Iso::ptcone40) ) {
    if(m_doDebug) { 
      std::cout << "    * MuonSelector::passIsolCuts * WARNING * No isolation variable stored on the muon" << std::endl;
      std::cout << "    * MuonSelector::passIsolCuts * this muon did not pass the IsoCuts " << std::endl;
    }
    return false;
  }
  
  else {
    double pt = m_pxMuon->pt();
    double ptSum = xAOD::Iso::ptcone40;
    if(m_doDebug) std::cout <<"    * MuonSelector::passIsolCuts *  muon pt: " << pt <<"   ptSum(ptcone40): "<< ptSum << std::endl;
    if (ptSum/pt < m_IsoCut ){
      if(m_doDebug) std::cout << "    * MuonSelector::passIsolCuts *  this muon passed the IsoCuts ptcone40 / pt= " 
                  << ptSum << " / " << pt << " = " << ptSum / pt 
                  << " < IsoCut(" << m_IsoCut << ") " << std::endl;
      return true;
    }
  }
  
  if(m_doDebug) std::cout << "    * MuonSelector::passIsolCuts * this muon did not pass the IsoCuts:" << std::endl;
  return false;
}
 

bool MuonSelector::passIPCuts()
{
  float extd0 = 0.0 ;
  float extz0 = 0.0 ;  
 
  //I'm not really sure of this logic. 
  if (m_pxMuon->inDetTrackParticleLink().isValid()) {
    const xAOD::TrackParticle* IDTrk = m_pxMuon->trackParticle(xAOD::Muon::InnerDetectorTrackParticle);  
    if (!IDTrk) {
      if (m_doDebug) std::cout << "    * MuonSelector::passIPCuts * no IDTrk --> IP failure" << std::endl;
    return false;
    }
    extd0 = IDTrk->d0();
    extz0 = IDTrk->z0()+IDTrk->vz();
    if(m_doDebug){
      std::cout << "    * MuonSelector::passIPCuts *"
        << " the IDTrack muon d0:  " << extd0
        << " the IDTrack muon z0:  " << extz0 << " = " << IDTrk->z0() << " + " << IDTrk->vz() << std::endl;
    }
  }
  else {
    if(m_doDebug) std::cout << "   * MuonSelector * passIPCuts() * no valid inDetTrackParticleLink(). Will use the combined muon IPs" << std::endl;
    
    const xAOD::TrackParticle* CBTrk = m_pxMuon->trackParticle(xAOD::Muon::CombinedTrackParticle);
    if (!CBTrk) {
      if(m_doDebug) std::cout << "   * MuonSelector * passIPCuts() * no valid CombinedTrackParticle. Giving up." << std::endl;
      return false;
    }
    else { 
      extd0 = CBTrk->d0();
      extz0 = CBTrk->z0()+CBTrk->vz();
      if(m_doDebug){
    std::cout << " * MuonSelector * passIPCuts() *"
          << " the CBTrack muon d0:  " << extd0
          << " the CBTrack muon z0:  " << extz0 << " = " << CBTrk->z0() << " + " << CBTrk->vz()<< std::endl;
      }
    }
  }
 
  // retrieve the vertices  
  const xAOD::VertexContainer *  vxContainer(nullptr);
  vxContainer = PerfMonServices::getContainer <xAOD::VertexContainer> ( PerfMonServices::VTX_COLLECTION );
  if (!vxContainer){
    if(m_doDebug) std::cout << "   * MuonSelector::passIPCuts ** fails because NO vertex collection "<< std::endl;
    return false;
  }
 
  if ( vxContainer->size()>1 ) {
    if(m_doDebug) {
      std::cout << "   * MuonSelector::passIPCuts ** vertex container is filled with " << vxContainer->size() << " vertices" <<  std::endl;
 
      // loop on vertices to check their coordinates:
      for (int ivtx=0; ivtx < (int) vxContainer->size(); ivtx++) {
    const xAOD::Vertex* thisVtx  = (*vxContainer)[ivtx];
    std::cout << "                                   vertex " << ivtx+1 << " (x,y,z) = (" << thisVtx->position().x()
          << ", " << thisVtx->position().y()
          << ", " << thisVtx->position().z()
          << ")  type= " << thisVtx->vertexType()
          << "  Npart= " << thisVtx->nTrackParticles()
          <<  std::endl;
      }
    }
        
    // new method
    if (true) {
      bool goodmuonIP = false; // by default think the IP is not good
      float minDeltaZ = 99999.; // large number
      // loop on vertices and check the muon may come from one of them
      for (int ivtx=0; ivtx < (int) vxContainer->size(); ivtx++) {
    const xAOD::Vertex* thisVtx  = (*vxContainer)[ivtx];
    // if ( (thisVtx->vertexType() == 1) && thisVtx->nTrackParticles()>2 ) {
    if ( thisVtx->nTrackParticles()>2 ) {
      if (std::abs(extz0 - thisVtx->position().z()) < minDeltaZ) minDeltaZ = std::abs(extz0 - thisVtx->position().z());
 
      // check the vertex is in the accepted Z range and that the muon is not far from the vertex
      if (m_doDebug) {
        std::cout << "           testing vtx: " << ivtx << "  vtx.z= " << thisVtx->position().z() << " trk.z= " << extz0 << "   deltaZ= " << std::abs(extz0 - thisVtx->position().z()) << "  minDeltaZ= " << minDeltaZ << std::endl;
      }
      if (std::abs(thisVtx->position().z()) < m_pVZCut && std::abs(extz0 - thisVtx->position().z()) < m_diffZCut){
        goodmuonIP = true;
        if(m_doDebug) std::cout << "    * MuonSelector::passIPCuts * this muon has passed the IPCuts for vertex " << ivtx+1
                    << "  pVZcut= " << std::abs(extz0 - thisVtx->position().z()) << " < " << m_diffZCut << std::endl
                    << "                                 vtx (x,y,z): " 
                    << " (" << thisVtx->position().x()
                    << ", " << thisVtx->position().y()
                    << ", " << thisVtx->position().z()
                    << ")   type: " << thisVtx->vertexType() 
                    << "  Npart: " << thisVtx->nTrackParticles() << std::endl;
      }
    }
      }
      if (goodmuonIP) {
    if(m_doDebug) std::cout <<"    * MuonSelector::passIPCuts * this muon has passed the IPCuts. Zcut: "<<  m_pVZCut << "  m_diffZCut " << m_diffZCut << std::endl;
    return true;
      }
    } // end new method
  }
  if(m_doDebug) std::cout <<"   * MuonSelector * passIPCuts() * this muon has not passed the IPCuts: " << std::endl;
  return false;
}

void MuonSelector::finalize()
{
  // statistics report 
  std::cout << "    * MuonSelector*  -- STATS -- " << std::endl
        << "    tested  : " << m_testedmuons << std::endl;
  if (m_doQualSelection) std::cout << "    passQual: " << m_passqual << std::endl;
  if (m_doIsoSelection)  std::cout << "    passIso : " << m_passiso << std::endl;
  if (m_doPtSelection)   std::cout << "    passpt  : " << m_passpt << std::endl;
  if (m_doIPSelection)   std::cout << "    passip  : " << m_passip << std::endl;
  if (m_doMCPSelection)  std::cout << "    passmcp : " << m_passmcp << std::endl;
  std::cout << "    passall : " << m_passall << std::endl
        << std::endl;
  
  return;
}

void MuonSelector::SetMuonQualityRequirement (std::string newname)
{
  int qualityvalue = xAOD::Muon::Tight;
 
  for_each (newname.begin(), newname.end(), [](char & c) {c = std::toupper(c);} );
  
  if (newname.find("TIGHT")    != std::string::npos) qualityvalue = xAOD::Muon::Tight;
  if (newname.find("MEDIUM")   != std::string::npos) qualityvalue = xAOD::Muon::Medium;
  if (newname.find("LOOSE")    != std::string::npos) qualityvalue = xAOD::Muon::Loose;
  if (newname.find("VERYLOOSE")!= std::string::npos) qualityvalue = xAOD::Muon::VeryLoose;
 
  m_requestedMuonQuality = qualityvalue;
 
  std::cout << " ** MuonSelector::SetMuonQualityRequirement(" << newname <<") = " << m_requestedMuonQuality << std::endl;
 
  return;
}