.. _program_listing_file_Root_MuonSelector.cxx:

Program Listing for File MuonSelector.cxx
=========================================

|exhale_lsh| :ref:`Return to documentation for file <file_Root_MuonSelector.cxx>` (``Root/MuonSelector.cxx``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   // c++ include(s):
   #include <iostream>
   #include <typeinfo>
   #include <tuple>
   
   // EL include(s):
   #include <EventLoop/Job.h>
   #include <EventLoop/StatusCode.h>
   #include <EventLoop/Worker.h>
   
   // EDM include(s):
   #include "xAODCore/ShallowCopy.h"
   #include "AthContainers/ConstDataVector.h"
   #include "xAODEventInfo/EventInfo.h"
   #include "xAODMuon/MuonContainer.h"
   #include "xAODTracking/VertexContainer.h"
   #include "xAODTracking/TrackParticlexAODHelpers.h"
   
   // package include(s):
   #include "xAODAnaHelpers/MuonSelector.h"
   #include "xAODAnaHelpers/HelperClasses.h"
   #include "xAODAnaHelpers/HelperFunctions.h"
   // #include "PATCore/TAccept.h"
   #include "TrigConfxAOD/xAODConfigTool.h"
   // tool includes
   #include "IsolationSelection/IsolationSelectionTool.h"
   #include "MuonSelectorTools/MuonSelectionTool.h"
   #include "TriggerMatchingTool/MatchingTool.h"
   #include "TriggerMatchingTool/MatchFromCompositeTool.h"
   
   // ROOT include(s):
   #include "TFile.h"
   #include "TObjArray.h"
   #include "TObjString.h"
   
   // this is needed to distribute the algorithm to the workers
   ClassImp(MuonSelector)
   
   MuonSelector :: MuonSelector () :
       Algorithm("MuonSelector")
   {
   }
   
   MuonSelector::~MuonSelector() {}
   
   EL::StatusCode MuonSelector :: setupJob (EL::Job& job)
   {
     // Here you put code that sets up the job on the submission object
     // so that it is ready to work with your algorithm, e.g. you can
     // request the D3PDReader service or add output files.  Any code you
     // put here could instead also go into the submission script.  The
     // sole advantage of putting it here is that it gets automatically
     // activated/deactivated when you add/remove the algorithm from your
     // job, which may or may not be of value to you.
   
     ANA_MSG_INFO( "Calling setupJob");
   
     job.useXAOD ();
     xAOD::Init( "MuonSelector" ).ignore(); // call before opening first file
   
     return EL::StatusCode::SUCCESS;
   }
   
   
   
   EL::StatusCode MuonSelector :: histInitialize ()
   {
     // Here you do everything that needs to be done at the very
     // beginning on each worker node, e.g. create histograms and output
     // trees.  This method gets called before any input files are
     // connected.
   
     ANA_MSG_INFO( "Calling histInitialize");
     ANA_CHECK( xAH::Algorithm::algInitialize());
   
     if ( this->numInstances() > 1 ) {
       m_isUsedBefore = true;
       ANA_MSG_INFO( "\t An algorithm of the same type has been already used " << numInstances() << " times" );
     }
   
     return EL::StatusCode::SUCCESS;
   }
   
   
   
   EL::StatusCode MuonSelector :: fileExecute ()
   {
     // Here you do everything that needs to be done exactly once for every
     // single file, e.g. collect a list of all lumi-blocks processed
   
     ANA_MSG_INFO( "Calling fileExecute");
   
     return EL::StatusCode::SUCCESS;
   }
   
   
   
   EL::StatusCode MuonSelector :: changeInput (bool /*firstFile*/)
   {
     // Here you do everything you need to do when we change input files,
     // e.g. resetting branch addresses on trees.  If you are using
     // D3PDReader or a similar service this method is not needed.
   
     ANA_MSG_INFO( "Calling changeInput");
   
     return EL::StatusCode::SUCCESS;
   }
   
   
   
   EL::StatusCode MuonSelector :: initialize ()
   {
     // Here you do everything that you need to do after the first input
     // file has been connected and before the first event is processed,
     // e.g. create additional histograms based on which variables are
     // available in the input files.  You can also create all of your
     // histograms and trees in here, but be aware that this method
     // doesn't get called if no events are processed.  So any objects
     // you create here won't be available in the output if you have no
     // input events.
   
     ANA_MSG_INFO( "Initializing MuonSelector Interface... ");
   
     // Let's see if the algorithm has been already used before:
     // if yes, will write object cutflow in a different histogram!
     //
     // This is the case when the selector algorithm is used for
     // preselecting objects, and then again for the final selection
     //
     ANA_MSG_INFO( "Algorithm name: " << m_name << " - of type " << m_className );
   
     if ( m_useCutFlow ) {
   
       // retrieve the file in which the cutflow hists are stored
       //
       TFile *file     = wk()->getOutputFile (m_cutFlowStreamName);
   
       // retrieve the event cutflows
       //
       m_cutflowHist  = (TH1D*)file->Get("cutflow");
       m_cutflowHistW = (TH1D*)file->Get("cutflow_weighted");
       m_cutflow_bin  = m_cutflowHist->GetXaxis()->FindBin(m_name.c_str());
       m_cutflowHistW->GetXaxis()->FindBin(m_name.c_str());
   
       // retrieve the object cutflow
       //
       m_mu_cutflowHist_1  = (TH1D*)file->Get("cutflow_muons_1");
   
       m_mu_cutflow_all                  = m_mu_cutflowHist_1->GetXaxis()->FindBin("all");
       m_mu_cutflow_eta_and_quaility_cut = m_mu_cutflowHist_1->GetXaxis()->FindBin("eta_and_quality_cut");
       m_mu_cutflow_ptmax_cut            = m_mu_cutflowHist_1->GetXaxis()->FindBin("ptmax_cut");
       m_mu_cutflow_ptmin_cut            = m_mu_cutflowHist_1->GetXaxis()->FindBin("ptmin_cut");
       m_mu_cutflow_ptnan_check          = m_mu_cutflowHist_1->GetXaxis()->FindBin("ptNaN_check");
       m_mu_cutflow_type_cut             = m_mu_cutflowHist_1->GetXaxis()->FindBin("type_cut");
       m_mu_cutflow_z0sintheta_cut       = m_mu_cutflowHist_1->GetXaxis()->FindBin("z0sintheta_cut");
       m_mu_cutflow_d0_cut               = m_mu_cutflowHist_1->GetXaxis()->FindBin("d0_cut");
       m_mu_cutflow_d0sig_cut            = m_mu_cutflowHist_1->GetXaxis()->FindBin("d0sig_cut");
       m_mu_cutflow_iso_cut              = m_mu_cutflowHist_1->GetXaxis()->FindBin("iso_cut");
       if( m_removeCosmicMuon )
         m_mu_cutflow_cosmic_cut              = m_mu_cutflowHist_1->GetXaxis()->FindBin("cosmic_cut");
   
   
       if ( m_isUsedBefore ) {
         m_mu_cutflowHist_2 = (TH1D*)file->Get("cutflow_muons_2");
   
         m_mu_cutflow_all       = m_mu_cutflowHist_2->GetXaxis()->FindBin("all");
         m_mu_cutflow_eta_and_quaility_cut = m_mu_cutflowHist_2->GetXaxis()->FindBin("eta_and_quality_cut");
         m_mu_cutflow_ptmax_cut         = m_mu_cutflowHist_2->GetXaxis()->FindBin("ptmax_cut");
         m_mu_cutflow_ptmin_cut         = m_mu_cutflowHist_2->GetXaxis()->FindBin("ptmin_cut");
         m_mu_cutflow_ptnan_check   = m_mu_cutflowHist_2->GetXaxis()->FindBin("ptNaN_check");
         m_mu_cutflow_type_cut      = m_mu_cutflowHist_2->GetXaxis()->FindBin("type_cut");
         m_mu_cutflow_z0sintheta_cut    = m_mu_cutflowHist_2->GetXaxis()->FindBin("z0sintheta_cut");
         m_mu_cutflow_d0_cut        = m_mu_cutflowHist_2->GetXaxis()->FindBin("d0_cut");
         m_mu_cutflow_d0sig_cut         = m_mu_cutflowHist_2->GetXaxis()->FindBin("d0sig_cut");
         m_mu_cutflow_iso_cut       = m_mu_cutflowHist_2->GetXaxis()->FindBin("iso_cut");
         if( m_removeCosmicMuon )
           m_mu_cutflow_cosmic_cut      = m_mu_cutflowHist_2->GetXaxis()->FindBin("cosmic_cut");
       }
   
     }// if m_useCutFlow
   
     m_event = wk()->xaodEvent();
     m_store = wk()->xaodStore();
   
     ANA_MSG_INFO( "Number of events in file: " << m_event->getEntries() );
   
     HelperClasses::EnumParser<xAOD::Muon::Quality> muQualityParser;
     m_muonQuality             = static_cast<int>( muQualityParser.parseEnum(m_muonQualityStr) );
     if (m_muonQualityStr=="HighPt") m_muonQuality=4;
     else if (m_muonQualityStr=="LowPt") m_muonQuality=5;
   
     m_outAuxContainerName     = m_outContainerName + "Aux."; // the period is very important!
   
     std::set<int> muonQualitySet;
     muonQualitySet.insert(0);
     muonQualitySet.insert(1);
     muonQualitySet.insert(2);
     muonQualitySet.insert(3);
     muonQualitySet.insert(4);
     muonQualitySet.insert(5);
     if ( muonQualitySet.find(m_muonQuality) == muonQualitySet.end() ) {
       ANA_MSG_ERROR( "Unknown muon quality requested: " << m_muonQuality);
       return EL::StatusCode::FAILURE;
     }
   
     // Parse input isolation WP list, split by comma, and put into a vector for later use
     // Make sure it's not empty!
     if(m_doIsolation){
       if ( m_IsoWPList.empty() ) {
         ANA_MSG_ERROR("Empty isolation WP list");
       }
       std::string token;
       std::istringstream ss(m_IsoWPList);
       while ( std::getline(ss, token, ',') ) {
         m_IsoKeys.push_back(token);
       }
     }
   
     if ( m_inContainerName.empty() ){
       ANA_MSG_ERROR( "InputContainer is empty!");
       return EL::StatusCode::FAILURE;
     }
   
     m_numEvent      = 0;
     m_numObject     = 0;
     m_numEventPass  = 0;
     m_weightNumEventPass  = 0;
     m_numObjectPass = 0;
   
     // ********************************
     //
     // Initialise CP::MuonSelectionTool
     //
     // ********************************
     //
     // Set eta and quality requirements in order to accept the muon - ID tracks required by default
     //
   
     ANA_CHECK( m_muonSelectionTool_handle.setProperty( "MaxEta", static_cast<double>(m_eta_max) ));
     ANA_CHECK( m_muonSelectionTool_handle.setProperty( "MuQuality", m_muonQuality ));
     ANA_CHECK( m_muonSelectionTool_handle.setProperty( "IsRun3Geo", m_isRun3Geo ));
     ANA_CHECK( m_muonSelectionTool_handle.setProperty( "OutputLevel", msg().level() ));
     if (m_doLRT) {
       ANA_CHECK( m_muonSelectionTool_handle.setProperty( "UseLRT", true ));
     }
     ANA_CHECK( m_muonSelectionTool_handle.retrieve());
     ANA_MSG_DEBUG("Retrieved tool: " << m_muonSelectionTool_handle);
   
     if(m_doIsolation){
       // *************************************
       //
       // Initialise CP::IsolationSelectionTool
       //
       // *************************************
   
       // Do this only for the first WP in the list
       ANA_MSG_DEBUG( "Adding isolation WP " << m_IsoKeys.at(0) << " to IsolationSelectionTool" );
       ANA_CHECK( m_isolationSelectionTool_handle.setProperty("MuonWP", (m_IsoKeys.at(0)).c_str()));
       ANA_CHECK( m_isolationSelectionTool_handle.setProperty("OutputLevel", msg().level() ));
       if (m_isoDecSuffix!="") ANA_CHECK( m_isolationSelectionTool_handle.setProperty("IsoDecSuffix", m_isoDecSuffix) );
       ANA_CHECK( m_isolationSelectionTool_handle.retrieve());
       ANA_MSG_DEBUG("Retrieved tool: " << m_isolationSelectionTool_handle);
       m_isolationSelectionTool = dynamic_cast<CP::IsolationSelectionTool*>(m_isolationSelectionTool_handle.get() ); // see header file for why
   
       // Add the remaining input WPs to the tool
       // (start from 2nd element)
       //
       for ( auto WP_itr = std::next(m_IsoKeys.begin()); WP_itr != m_IsoKeys.end(); ++WP_itr ) {
   
          ANA_MSG_DEBUG( "Adding extra isolation WP " << *WP_itr << " to IsolationSelectionTool" );
   
          if ( (*WP_itr).find("UserDefined") != std::string::npos ) {
   
            HelperClasses::EnumParser<xAOD::Iso::IsolationType> isoParser;
   
            std::vector< std::pair<xAOD::Iso::IsolationType, std::string> > myCuts;
            myCuts.push_back(std::make_pair<xAOD::Iso::IsolationType, std::string>(isoParser.parseEnum(m_TrackBasedIsoType), m_TrackIsoEff.c_str() ));
            myCuts.push_back(std::make_pair<xAOD::Iso::IsolationType, std::string>(isoParser.parseEnum(m_CaloBasedIsoType) , m_CaloIsoEff.c_str()  ));
   
            CP::IsolationSelectionTool::IsoWPType iso_type(CP::IsolationSelectionTool::Efficiency);
            if ( (*WP_itr).find("Cut") != std::string::npos ) { iso_type = CP::IsolationSelectionTool::Cut; }
   
            ANA_CHECK(  m_isolationSelectionTool->addUserDefinedWP((*WP_itr).c_str(), xAOD::Type::Muon, myCuts, "", iso_type));
   
          } else {
   
             ANA_CHECK( m_isolationSelectionTool->addMuonWP( (*WP_itr).c_str() ));
   
          }
       }
     }
   
     // **************************************
     //
     // Initialise Trig::MatchingTool
     //
     // **************************************
     if( !( m_singleMuTrigChains.empty() && m_diMuTrigChains.empty() ) ) {
   
       // grab the TrigDecTool from the ToolStore
       if(!m_trigDecTool_handle.isUserConfigured()){
         ANA_MSG_FATAL("A configured " << m_trigDecTool_handle.typeAndName() << " must have been previously created! Are you creating one in xAH::BasicEventSelection?" );
         return EL::StatusCode::FAILURE;
       }
       ANA_CHECK( m_trigDecTool_handle.retrieve());
       ANA_MSG_DEBUG("Retrieved tool: " << m_trigDecTool_handle);
   
       // in AB we need to explicitly retrieve this tool, see https://twiki.cern.ch/twiki/bin/viewauth/Atlas/R22TriggerAnalysis
       ANA_CHECK( m_scoreTool.retrieve());
   
       // Run3 got a new trigger navigation
       if (m_useRun3navigation) {
         m_trigMuonMatchTool_handle = asg::AnaToolHandle<Trig::IMatchingTool>("Trig::R3MatchingTool/TrigR3MatchingTool");
         ANA_CHECK( m_trigMuonMatchTool_handle.setProperty( "TrigDecisionTool", m_trigDecTool_handle ));
         ANA_CHECK( m_trigMuonMatchTool_handle.setProperty( "ScoringTool", m_scoreTool ));
         ANA_CHECK( m_trigMuonMatchTool_handle.setProperty("OutputLevel", msg().level() ));
         ANA_CHECK( m_trigMuonMatchTool_handle.retrieve());
         ANA_MSG_DEBUG("Retrieved tool: " << m_trigMuonMatchTool_handle);
       }
       // otherwise we have to configure the Run2-style navigation
       else {
         if( !isPHYS() ) {
           m_trigMuonMatchTool_handle = asg::AnaToolHandle<Trig::IMatchingTool>("Trig::MatchingTool/MatchingTool");
           ANA_CHECK( m_trigMuonMatchTool_handle.setProperty( "TrigDecisionTool", m_trigDecTool_handle ));
           ANA_CHECK( m_trigMuonMatchTool_handle.setProperty( "ScoringTool", m_scoreTool ));
           ANA_CHECK( m_trigMuonMatchTool_handle.setProperty("OutputLevel", msg().level() ));
           ANA_CHECK( m_trigMuonMatchTool_handle.retrieve());
           ANA_MSG_DEBUG("Retrieved tool: " << m_trigMuonMatchTool_handle);
         }
         else { // For DAOD_PHYS samples
           m_trigMuonMatchTool_handle = asg::AnaToolHandle<Trig::IMatchingTool>("Trig::MatchFromCompositeTool/MatchFromCompositeTool");
           ANA_CHECK( m_trigMuonMatchTool_handle.setProperty( "OutputLevel", msg().level() ));
           if (!m_trigInputPrefix.empty()){
             ANA_CHECK( m_trigMuonMatchTool_handle.setProperty( "InputPrefix", m_trigInputPrefix ));
             ANA_CHECK( m_trigMuonMatchTool_handle.setProperty( "RemapBrokenLinks", true) );
           }
           ANA_CHECK( m_trigMuonMatchTool_handle.retrieve());
           ANA_MSG_DEBUG("Retrieved tool: " << m_trigMuonMatchTool_handle);
         }
       }
     } else {
   
       m_doTrigMatch = false;
   
       ANA_MSG_WARNING("***********************************************************");
       ANA_MSG_WARNING( "Will not perform any muon trigger matching at this stage b/c :");
       ANA_MSG_WARNING("\t -) could not find the TrigDecisionTool in asg::ToolStore");
       ANA_MSG_WARNING("\t AND/OR");
       ANA_MSG_WARNING("\t -) all input HLT trigger chain lists are empty");
       ANA_MSG_WARNING("However, if you really didn't want to do the matching now, it's all good!");
       ANA_MSG_WARNING("***********************************************************");
     }
   
     ANA_MSG_INFO( "MuonSelector Interface succesfully initialized!" );
   
     return EL::StatusCode::SUCCESS;
   }
   
   EL::StatusCode MuonSelector :: execute ()
   {
     // Here you do everything that needs to be done on every single
     // events, e.g. read input variables, apply cuts, and fill
     // histograms and trees.  This is where most of your actual analysis
     // code will go.
   
     ANA_MSG_DEBUG( "Applying Muon Selection..." );
   
     const xAOD::EventInfo* eventInfo(nullptr);
     ANA_CHECK( HelperFunctions::retrieve(eventInfo, m_eventInfoContainerName, m_event, m_store, msg()) );
   
     // MC event weight
     //
     float mcEvtWeight(1.0);
     static SG::AuxElement::Accessor< float > mcEvtWeightAcc("mcEventWeight");
     if ( ! mcEvtWeightAcc.isAvailable( *eventInfo ) ) {
       ANA_MSG_ERROR( "mcEventWeight is not available as decoration! Aborting" );
       return EL::StatusCode::FAILURE;
     }
     mcEvtWeight = mcEvtWeightAcc( *eventInfo );
   
     m_numEvent++;
   
     // QUESTION: why this must be done in execute(), and does not work in initialize()?
     //
     if ( m_numEvent == 1 && m_trigMuonMatchTool_handle.isInitialized() ) {
   
       // parse input muon trigger chain list, split by comma and fill vector
       //
       std::string singlemu_trig;
       std::istringstream ss_singlemu_trig(m_singleMuTrigChains);
   
       while ( std::getline(ss_singlemu_trig, singlemu_trig, ',') ) {
       m_singleMuTrigChainsList.push_back(singlemu_trig);
       }
   
       std::string dimu_trig;
       std::istringstream ss_dimu_trig(m_diMuTrigChains);
   
       while ( std::getline(ss_dimu_trig, dimu_trig, ',') ) {
       m_diMuTrigChainsList.push_back(dimu_trig);
       }
   
       ANA_MSG_INFO( "Input single muon trigger chains that will be considered for matching:\n");
       for ( auto const &chain : m_singleMuTrigChainsList ) { ANA_MSG_INFO( "\t " << chain); }
       ANA_MSG_INFO( "\n");
   
       ANA_MSG_INFO( "Input di-muon trigger chains that will be considered for matching:\n");
       for ( auto const &chain : m_diMuTrigChainsList ) { ANA_MSG_INFO( "\t " << chain); }
       ANA_MSG_INFO( "\n");
   
     }
   
     // did any collection pass the cuts?
     //
     bool eventPass(false);
     bool countPass(true); // for cutflow: count for the 1st collection in the syst container - could be better as should only count for the nominal
     const xAOD::MuonContainer* inMuons(nullptr);
   
     // if input comes from xAOD, or just running one collection,
     // then get the one collection and be done with it
     //
     if ( m_inputAlgoSystNames.empty() ) {
   
       // this will be the collection processed - no matter what!!
       //
       ANA_CHECK( HelperFunctions::retrieve(inMuons, m_inContainerName, m_event, m_store, msg()) );
   
       // create output container (if requested)
       //
       ConstDataVector<xAOD::MuonContainer>* selectedMuons(nullptr);
       if ( m_createSelectedContainer ) { selectedMuons = new ConstDataVector<xAOD::MuonContainer>(SG::VIEW_ELEMENTS); }
   
       // find the selected muons, and return if event passes object selection
       //
       eventPass = executeSelection( inMuons, mcEvtWeight, countPass, selectedMuons );
   
       if ( m_createSelectedContainer ) {
         if ( eventPass ) {
           // add ConstDataVector to TStore
       //
           ANA_CHECK( m_store->record( selectedMuons, m_outContainerName ));
         } else {
           // if the event does not pass the selection, CDV won't be ever recorded to TStore, so we have to delete it!
       //
           delete selectedMuons; selectedMuons = nullptr;
         }
       }
   
     } else { // get the list of systematics to run over
   
       // get vector of string giving the syst names of the upstream algo from TStore (rememeber: 1st element is a blank string: nominal case!)
       //
       std::vector< std::string >* systNames(nullptr);
       ANA_CHECK( HelperFunctions::retrieve(systNames, m_inputAlgoSystNames, 0, m_store, msg()) );
   
       // prepare a vector of the names of CDV containers for usage by downstream algos
       // must be a pointer to be recorded in TStore
       //
       auto vecOutContainerNames = std::make_unique< std::vector< std::string > >();
       ANA_MSG_DEBUG( " input list of syst size: " << static_cast<int>(systNames->size()) );
   
       // loop over systematic sets
       //
       bool eventPassThisSyst(false);
       for ( auto systName : *systNames ) {
   
         ANA_MSG_DEBUG( " syst name: " << systName << "  input container name: " << m_inContainerName+systName );
   
         ANA_CHECK( HelperFunctions::retrieve(inMuons, m_inContainerName + systName, m_event, m_store, msg()) );
   
         // create output container (if requested) - one for each systematic
         //
         ConstDataVector<xAOD::MuonContainer>* selectedMuons(nullptr);
         if ( m_createSelectedContainer ) { selectedMuons = new ConstDataVector<xAOD::MuonContainer>(SG::VIEW_ELEMENTS); }
   
         // find the selected muons, and return if event passes object selection
         //
         eventPassThisSyst = executeSelection( inMuons, mcEvtWeight, countPass, selectedMuons );
   
         if ( countPass ) { countPass = false; } // only count objects/events for 1st syst collection in iteration (i.e., nominal)
   
         if ( eventPassThisSyst ) {
       // save the string of syst set under question if event is passing the selection
       //
       vecOutContainerNames->push_back( systName );
         }
   
         // if for at least one syst set the event passes selection, this will remain true!
         //
         eventPass = ( eventPass || eventPassThisSyst );
   
         ANA_MSG_DEBUG( " syst name: " << systName << "  output container name: " << m_outContainerName+systName );
   
         if ( m_createSelectedContainer ) {
           if ( eventPassThisSyst ) {
             // add ConstDataVector to TStore
         //
             ANA_CHECK( m_store->record( selectedMuons, m_outContainerName+systName ));
           } else {
             // if the event does not pass the selection for this syst, CDV won't be ever recorded to TStore, so we have to delete it!
             delete selectedMuons; selectedMuons = nullptr;
           }
         }
   
       } // close loop over syst sets
   
       ANA_MSG_DEBUG(" output list of syst size: " << static_cast<int>(vecOutContainerNames->size()) );
   
       // record in TStore the list of systematics names that should be considered down stream
       //
       ANA_CHECK( m_store->record( std::move(vecOutContainerNames), m_outputAlgoSystNames));
   
     }
   
     // look what we have in TStore
     //
     if(msgLvl(MSG::VERBOSE)) m_store->print();
   
     if( !eventPass ) {
       wk()->skipEvent();
       return EL::StatusCode::SUCCESS;
     }
   
     ANA_MSG_DEBUG( "Left Muon Selection..." );
     return EL::StatusCode::SUCCESS;
   
   }
   
   bool MuonSelector :: executeSelection ( const xAOD::MuonContainer* inMuons, float mcEvtWeight, bool countPass,
                           ConstDataVector<xAOD::MuonContainer>* selectedMuons )
   {
   
     ANA_MSG_DEBUG( "In  executeSelection..." );
     const xAOD::VertexContainer* vertices(nullptr);
     ANA_CHECK( HelperFunctions::retrieve(vertices, m_vertexContainerName, m_event, m_store, msg()) );
     const xAOD::Vertex *pvx = HelperFunctions::getPrimaryVertex(vertices, msg());
   
     int nPass(0); int nObj(0);
     static SG::AuxElement::Decorator< char > passSelDecor( "passSel" );
   
     for ( auto mu_itr : *inMuons ) { // duplicated of basic loop
   
       // if only looking at a subset of muons make sure all are decorated
       //
       if ( m_nToProcess > 0 && nObj >= m_nToProcess ) {
         if ( m_decorateSelectedObjects ) {
           passSelDecor( *mu_itr ) = -1;
         } else {
           break;
         }
         continue;
       }
   
       nObj++;
       bool passSel = this->passCuts( mu_itr, pvx );
       if ( m_decorateSelectedObjects ) {
         passSelDecor( *mu_itr ) = passSel;
       }
   
       // Remove events with isBadMuon (poor q/p)
       if( m_removeEventBadMuon && passSel ){
         if( m_muonSelectionTool_handle->isBadMuon( *mu_itr ) ){
           ANA_MSG_DEBUG("Rejecting event with bad muon (pt = "<<mu_itr->pt()<<")");
           return false;
         }
       }
   
       if ( passSel ) {
         nPass++;
         if ( m_createSelectedContainer ) {
           selectedMuons->push_back( mu_itr );
         }
       }
     }
   
     // for cutflow: make sure to count passed objects only once (i.e., this flag will be true only for nominal)
     //
     if ( countPass ) {
       m_numObject     += nObj;
       m_numObjectPass += nPass;
     }
   
     ANA_MSG_DEBUG( "Initial muons: " << nObj << " - Selected muons: " << nPass );
   
     // apply event selection based on minimal/maximal requirements on the number of objects per event passing cuts
     //
     if ( m_pass_min > 0 && nPass < m_pass_min ) {
       ANA_MSG_DEBUG( "Reject event: nSelectedMuons ("<<nPass<<") < nPassMin ("<<m_pass_min<<")" );
       return false;
     }
     if ( m_pass_max >= 0 && nPass > m_pass_max ) {
       ANA_MSG_DEBUG( "Reject event: nSelectedMuons ("<<nPass<<") > nPassMax ("<<m_pass_max<<")" );
       return false;
     }
   
     // for cutflow: make sure to count passed events only once (i.e., this flag will be true only for nominal)
     //
     if ( countPass ){
       m_numEventPass++;
       m_weightNumEventPass += mcEvtWeight;
     }
   
     // Perform trigger matching on the "good" (selected) muons
     //
     // NB: this part will be skipped if:
     //
     //  1. the user didn't pass any trigger chains to the algo (see initialize(): in that case, the tool is not even initialised!)
     //  2. there are no selected muons in the event
     //
     if ( m_doTrigMatch && selectedMuons ) {
   
       unsigned int nSelectedMuons = selectedMuons->size();
   
       static SG::AuxElement::Decorator< std::map<std::string,char> > isTrigMatchedMapMuDecor( "isTrigMatchedMapMu" );
   
       if ( nSelectedMuons > 0 ) {
   
         ANA_MSG_DEBUG( "Doing single muon trigger matching...");
   
         for ( auto const &chain : m_singleMuTrigChainsList ) {
   
           ANA_MSG_DEBUG( "\t checking trigger chain " << chain);
   
           for ( auto const muon : *selectedMuons ) {
   
             //  For each muon, decorate w/ a map<string,char> with the 'isMatched' info associated
             //  to each trigger chain in the input list.
             //  If decoration map doesn't exist for this muon yet, create it (will be done only for the 1st iteration on the chain names)
             //
             if ( !isTrigMatchedMapMuDecor.isAvailable( *muon ) ) {
               isTrigMatchedMapMuDecor( *muon ) = std::map<std::string,char>();
             }
             char matched = false;
             if (!m_merged_muons){
               matched = ( m_trigMuonMatchTool_handle->match( *muon, chain, m_minDeltaR ) );
             } else {
               static const SG::AuxElement::ConstAccessor<ElementLink<xAOD::MuonContainer>> originalMuonLink("originalMuonLink");
               auto originalMuon = const_cast<xAOD::Muon*>(*originalMuonLink( *muon ));
               matched = ( m_trigMuonMatchTool_handle->match(*originalMuon, chain, m_minDeltaR) );
             }
   
             ANA_MSG_DEBUG( "\t\t is muon trigger matched? " << matched);
   
             ( isTrigMatchedMapMuDecor( *muon ) )[chain] = matched;
           }
         }
   
       }
   
       // If checking dilepton trigger, form lepton pairs and test matching for each one.
       // Save a:
       //
       // multimap< chain, pair< pair<idx_i, idx_j>, ismatched > >
       //
       // as *event* decoration to store which
       // pairs are matched (to a given chain) and which aren't.
       // A multimap is used b/c a given key (i.e., a chain) can be associated to more than one pair. This is the case for e.g., trilepton events.
       //
       // By retrieving this map later on, user can decide what to do with the event
       // (Generally one could just loop over the map and save a flag if there's at least one pair that matches a given chain)
   
       if ( nSelectedMuons > 1 && !m_diMuTrigChains.empty() ) {
   
         ANA_MSG_DEBUG( "Doing di-muon trigger matching...");
   
         const xAOD::EventInfo* eventInfo(nullptr);
         ANA_CHECK( HelperFunctions::retrieve(eventInfo, m_eventInfoContainerName, m_event, m_store, msg()) );
   
         typedef std::pair< std::pair<unsigned int,unsigned int>, char> dimuon_trigmatch_pair;
         typedef std::multimap< std::string, dimuon_trigmatch_pair >    dimuon_trigmatch_pair_map;
         static SG::AuxElement::Decorator< dimuon_trigmatch_pair_map >  diMuonTrigMatchPairMapDecor( "diMuonTrigMatchPairMap" );
   
         for ( auto const &chain : m_diMuTrigChainsList ) {
   
           ANA_MSG_DEBUG( "\t checking trigger chain " << chain);
   
           //  If decoration map doesn't exist for this event yet, create it (will be done only for the 1st iteration on the chain names)
           //
           if ( !diMuonTrigMatchPairMapDecor.isAvailable( *eventInfo ) ) {
             diMuonTrigMatchPairMapDecor( *eventInfo ) = dimuon_trigmatch_pair_map();
           }
   
           std::vector<const xAOD::IParticle*> myMuons;
   
           for ( unsigned int imu = 0; imu < selectedMuons->size()-1; ++imu ) {
   
             for ( unsigned int jmu = imu+1; jmu < selectedMuons->size(); ++jmu ) {
   
               // test a new pair
               //
               myMuons.clear();
               myMuons.push_back( selectedMuons->at(imu) );
               myMuons.push_back( selectedMuons->at(jmu) );
   
               // check whether the pair is matched
               //
               char matched = m_trigMuonMatchTool_handle->match( myMuons, chain, m_minDeltaR );
   
               ANA_MSG_DEBUG( "\t\t is the muon pair ("<<imu<<","<<jmu<<") trigger matched? " << matched);
   
               // set basic matching information
               ( isTrigMatchedMapMuDecor( *myMuons[0] ) )[chain] = matched;
               ( isTrigMatchedMapMuDecor( *myMuons[1] ) )[chain] = matched;
   
               // set pair decision information
               std::pair <unsigned int, unsigned int>  chain_idxs = std::make_pair(imu,jmu);
               dimuon_trigmatch_pair  chain_decision = std::make_pair(chain_idxs,matched);
               diMuonTrigMatchPairMapDecor( *eventInfo ).insert( std::pair< std::string, dimuon_trigmatch_pair >(chain,chain_decision) );
   
             }
           }
         } //for m_diMuTrigChainsList
       } //if nSelectedMuons > 1 && !m_diMuTrigChains.empty()
     } //if m_doTrigMatch && selectedMuons
   
     ANA_MSG_DEBUG( "Left  executeSelection..." );
     return true;
   }
   
   
   EL::StatusCode MuonSelector :: postExecute ()
   {
     // Here you do everything that needs to be done after the main event
     // processing.  This is typically very rare, particularly in user
     // code.  It is mainly used in implementing the NTupleSvc.
   
     ANA_MSG_DEBUG( "Calling postExecute");
   
     return EL::StatusCode::SUCCESS;
   }
   
   
   
   EL::StatusCode MuonSelector :: finalize ()
   {
     // This method is the mirror image of initialize(), meaning it gets
     // called after the last event has been processed on the worker node
     // and allows you to finish up any objects you created in
     // initialize() before they are written to disk.  This is actually
     // fairly rare, since this happens separately for each worker node.
     // Most of the time you want to do your post-processing on the
     // submission node after all your histogram outputs have been
     // merged.  This is different from histFinalize() in that it only
     // gets called on worker nodes that processed input events.
   
     ANA_MSG_INFO( "Deleting tool instances...");
   
     if ( m_useCutFlow ) {
       ANA_MSG_INFO( "Filling cutflow");
       m_cutflowHist ->SetBinContent( m_cutflow_bin, m_numEventPass        );
       m_cutflowHistW->SetBinContent( m_cutflow_bin, m_weightNumEventPass  );
     }
   
     return EL::StatusCode::SUCCESS;
   }
   
   
   
   EL::StatusCode MuonSelector :: histFinalize ()
   {
     // This method is the mirror image of histInitialize(), meaning it
     // gets called after the last event has been processed on the worker
     // node and allows you to finish up any objects you created in
     // histInitialize() before they are written to disk.  This is
     // actually fairly rare, since this happens separately for each
     // worker node.  Most of the time you want to do your
     // post-processing on the submission node after all your histogram
     // outputs have been merged.  This is different from finalize() in
     // that it gets called on all worker nodes regardless of whether
     // they processed input events.
   
     ANA_MSG_INFO( "Calling histFinalize");
     ANA_CHECK( xAH::Algorithm::algFinalize());
     return EL::StatusCode::SUCCESS;
   }
   
   int MuonSelector :: passCuts( const xAOD::Muon* muon, const xAOD::Vertex *primaryVertex  ) {
   
     ANA_MSG_DEBUG( "In  passCuts..." );
     // fill cutflow bin 'all' before any cut
     if (!m_isUsedBefore && m_useCutFlow) m_mu_cutflowHist_1->Fill( m_mu_cutflow_all, 1 );
     if ( m_isUsedBefore && m_useCutFlow ) { m_mu_cutflowHist_2->Fill( m_mu_cutflow_all, 1 ); }
     ANA_MSG_DEBUG( "In  passCuts2..." );
     // *********************************************************************************************************************************************************************
     //
     // MuonSelectorTool cut: quality & |eta| acceptance cut
     //
   
     // quality decorators
     static SG::AuxElement::Decorator< char > isVeryLooseQDecor("isVeryLooseQ");
     static SG::AuxElement::Decorator< char > isLooseQDecor("isLooseQ");
     static SG::AuxElement::Decorator< char > isMediumQDecor("isMediumQ");
     static SG::AuxElement::Decorator< char > isTightQDecor("isTightQ");
   
     ANA_MSG_DEBUG( "Got the decors" );
     int this_quality = static_cast<int>( m_muonSelectionTool_handle->getQuality( *muon ) );
     ANA_MSG_DEBUG( "Got quality" );
   
     isVeryLooseQDecor( *muon ) = ( this_quality <= static_cast<int>(xAOD::Muon::VeryLoose) ) ? 1 : 0;
     isLooseQDecor( *muon )     = ( this_quality <= static_cast<int>(xAOD::Muon::Loose) )     ? 1 : 0;
     isMediumQDecor( *muon )    = ( this_quality <= static_cast<int>(xAOD::Muon::Medium) )    ? 1 : 0;
     isTightQDecor( *muon )     = ( this_quality <= static_cast<int>(xAOD::Muon::Tight) )     ? 1 : 0;
   
     bool acceptMuon = (bool)m_muonSelectionTool_handle->accept( *muon );
   
     if ( m_doLRT ) {
       static SG::AuxElement::Decorator< char > passIDcuts("passIDcuts");
     }
   
     ANA_MSG_DEBUG( "Doing muon quality" );
     if ( !acceptMuon ) {
       ANA_MSG_DEBUG( "Muon failed requirements of MuonSelectionTool.");
       return 0;
     }
   
     if (!m_isUsedBefore && m_useCutFlow) m_mu_cutflowHist_1->Fill( m_mu_cutflow_eta_and_quaility_cut, 1 );
     if ( m_isUsedBefore && m_useCutFlow ) { m_mu_cutflowHist_2->Fill( m_mu_cutflow_eta_and_quaility_cut, 1 ); }
   
     // *********************************************************************************************************************************************************************
     //
     // pT max cut
     //
     ANA_MSG_DEBUG( "Doing pt cuts" );
     if ( m_pT_max != 1e8 ) {
       if (  muon->pt() > m_pT_max ) {
         ANA_MSG_DEBUG( "Muon failed pT max cut.");
         return 0;
       }
     }
     if (!m_isUsedBefore && m_useCutFlow) m_mu_cutflowHist_1->Fill( m_mu_cutflow_ptmax_cut, 1 );
     if ( m_isUsedBefore && m_useCutFlow ) { m_mu_cutflowHist_2->Fill( m_mu_cutflow_ptmax_cut, 1 ); }
   
     // *********************************************************************************************************************************************************************
     //
     // pT min cut
     //
     if ( m_pT_min != 1e8 ) {
       if ( muon->pt() < m_pT_min ) {
         ANA_MSG_DEBUG( "Muon failed pT min cut.");
         return 0;
       }
     }
     if (!m_isUsedBefore && m_useCutFlow) m_mu_cutflowHist_1->Fill( m_mu_cutflow_ptmin_cut, 1 );
     if ( m_isUsedBefore && m_useCutFlow ) { m_mu_cutflowHist_2->Fill( m_mu_cutflow_ptmin_cut, 1 ); }
   
     // *********************************************************************************************************************************************************************
     //
     // pT NaN check
     //
     if ( m_pT_NaNcheck ) {
       if ( muon->pt() != muon->pt() ) {
         ANA_MSG_DEBUG( "Muon failed pT NaN check.");
         return 0;
       }
     }
     if (!m_isUsedBefore && m_useCutFlow) m_mu_cutflowHist_1->Fill( m_mu_cutflow_ptnan_check, 1 );
     if ( m_isUsedBefore && m_useCutFlow ) { m_mu_cutflowHist_2->Fill( m_mu_cutflow_ptnan_check, 1 ); }
   
     // *********************************************************************************************************************************************************************
     //
     // muon type cut
     //
     //HelperClasses::EnumParser<xAOD::Muon::MuonType> muTypeParser;
     //if ( !m_muonType.empty() ) {
     //  if ( muon->muonType() != static_cast<int>(muTypeParser.parseEnum(m_muonType))) {
     //    ANA_MSG_DEBUG( "Muon type: %d - required: %s . Failed", muon->muonType(), m_muonType.c_str());
     //    return 0;
     //  }
     //}
     //if (!m_isUsedBefore && m_useCutFlow) m_mu_cutflowHist_1->Fill( m_mu_cutflow_type_cut, 1 );
     //if ( m_isUsedBefore && m_useCutFlow ) { m_mu_cutflowHist_2->Fill( m_mu_cutflow_type_cut, 1 ); }
   
     // *********************************************************************************************************************************************************************
     //
     // impact parameter cuts
     //
   
     // Put tracking cuts here, after pt cuts, to be safe with derivations.
   
     // The following returns a pointer (which should not usually be NULL, but might be if the muon has been stripped of information) to the
     // primary TrackParticle corresponding to the MuonType of this muon.
     // This is determined in the following order:
     //  1. CombinedTrackParticle
     //  2. InnerDetectorTrackParticle
     //  3. (Extrapolated)MuonSpectrometerTrackParticle
     //
     const xAOD::TrackParticle* tp = muon->primaryTrackParticle();
   
     if ( !tp ) {
       ANA_MSG_DEBUG("Muon has no TrackParticle. Won't be selected.");
       return 0;
     }
   
     const xAOD::EventInfo* eventInfo(nullptr);
     ANA_CHECK( HelperFunctions::retrieve(eventInfo, m_eventInfoContainerName, m_event, m_store, msg()) );
   
     double d0_significance = xAOD::TrackingHelpers::d0significance( tp, eventInfo->beamPosSigmaX(), eventInfo->beamPosSigmaY(), eventInfo->beamPosSigmaXY() );
   
     // Take distance between z0 and zPV ( after referring the PV z coordinate to the beamspot position, given by vz() ), multiplied by sin(theta)
     // see https://twiki.cern.ch/twiki/bin/view/AtlasProtected/InDetTrackingDC14 for further reference
     //
     float z0sintheta = 1e8;
     if (primaryVertex) z0sintheta = ( tp->z0() + tp->vz() - primaryVertex->z() ) * sin( tp->theta() );
   
     // z0*sin(theta) cut
     //
     if ( !( fabs(z0sintheta) < m_z0sintheta_max ) ) {
         ANA_MSG_DEBUG( "Muon failed z0*sin(theta) cut.");
         return 0;
     }
     if (!m_isUsedBefore && m_useCutFlow) m_mu_cutflowHist_1->Fill( m_mu_cutflow_z0sintheta_cut, 1 );
     if ( m_isUsedBefore && m_useCutFlow ) { m_mu_cutflowHist_2->Fill( m_mu_cutflow_z0sintheta_cut, 1 ); }
   
     // decorate muon w/ z0*sin(theta) info
     static SG::AuxElement::Decorator< float > z0sinthetaDecor("z0sintheta");
     z0sinthetaDecor( *muon ) = z0sintheta;
   
     // d0 cut
     //
     if ( !( tp->d0() < m_d0_max ) ) {
         ANA_MSG_DEBUG( "Muon failed d0 cut.");
         return 0;
     }
     if (!m_isUsedBefore && m_useCutFlow) m_mu_cutflowHist_1->Fill( m_mu_cutflow_d0_cut, 1 );
     if ( m_isUsedBefore && m_useCutFlow ) { m_mu_cutflowHist_2->Fill( m_mu_cutflow_d0_cut, 1 ); }
   
     // d0sig cut
     //
     if ( !( fabs(d0_significance) < m_d0sig_max ) ) {
         ANA_MSG_DEBUG( "Muon failed d0 significance cut.");
         return 0;
     }
     if (!m_isUsedBefore && m_useCutFlow) m_mu_cutflowHist_1->Fill( m_mu_cutflow_d0sig_cut, 1 );
     if ( m_isUsedBefore && m_useCutFlow ) { m_mu_cutflowHist_2->Fill( m_mu_cutflow_d0sig_cut, 1 ); }
   
     // decorate muon w/ d0sig info
     static SG::AuxElement::Decorator< float > d0SigDecor("d0sig");
     d0SigDecor( *muon ) = static_cast<float>(d0_significance);
   
     if(m_doIsolation){
       // *********************************************************************************************************************************************************************
       //
       // isolation cut
       //
   
       // Get the "list" of input WPs with the accept() decision from the tool
       //
       auto accept_list = m_isolationSelectionTool_handle->accept( *muon );
   
       // Decorate w/ decision for all input WPs
       //
       std::string base_decor("isIsolated");
       for ( auto WP_itr : m_IsoKeys ) {
   
         std::string decorWP = base_decor + "_" + WP_itr;
   
         ANA_MSG_DEBUG( "Decorate muon with " << decorWP << " - accept() ? " << accept_list.getCutResult( WP_itr.c_str()) );
         muon->auxdecor<char>(decorWP) = static_cast<bool>( accept_list.getCutResult( WP_itr.c_str() ) );
   
       }
   
       // Apply the cut if needed
       //
       if ( !m_MinIsoWPCut.empty() && !accept_list.getCutResult( m_MinIsoWPCut.c_str() ) ) {
         ANA_MSG_DEBUG( "Muon failed isolation cut " <<  m_MinIsoWPCut );
         return 0;
       }
     }
     if (!m_isUsedBefore && m_useCutFlow) m_mu_cutflowHist_1->Fill( m_mu_cutflow_iso_cut, 1 );
     if ( m_isUsedBefore && m_useCutFlow ) { m_mu_cutflowHist_2->Fill( m_mu_cutflow_iso_cut, 1 ); }
   
     if( m_removeCosmicMuon ){
   
       double muon_d0 = tp->d0();
       double pv_z = primaryVertex ? primaryVertex->z() : 0;
       double muon_z0_exPV = tp->z0() + tp->vz() - pv_z;
   
       if( fabs(muon_z0_exPV) >= 1.0 || fabs(muon_d0) >= 0.2 ){
         ANA_MSG_DEBUG("Muon failed cosmic cut" );
         return 0;
       }
       if (!m_isUsedBefore && m_useCutFlow) m_mu_cutflowHist_1->Fill( m_mu_cutflow_cosmic_cut, 1 );
       if ( m_isUsedBefore && m_useCutFlow ) { m_mu_cutflowHist_2->Fill( m_mu_cutflow_cosmic_cut, 1 ); }
   
     }
   
   
     ANA_MSG_DEBUG( "Leave passCuts... pass" );
     return 1;
   }