PFlowAugmentationTool.cxx

Go to the documentation of this file.

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

// PFlowAugmentationTool.cxx
// Author: Fabrice Balli (fabrice.balli@cern.ch), Chris Young (christopher.young@cern.ch)
//
 
#include "PFlowAugmentationTool.h"
 
#include "StoreGate/WriteDecorHandle.h"
 
namespace DerivationFramework {
 
  StatusCode PFlowAugmentationTool::initialize()
  {
 
    ATH_CHECK(m_vertexContainer_key.initialize());
    ATH_CHECK(m_pfoContainer_key.initialize());
    ATH_CHECK(m_corrP4_ptKey.initialize());
    ATH_CHECK(m_z0Key.initialize());
    ATH_CHECK(m_vzKey.initialize());
    ATH_CHECK(m_d0Key.initialize());
    ATH_CHECK(m_thetaKey.initialize());
    ATH_CHECK(m_envWeightKey.initialize());
 
    return StatusCode::SUCCESS;
  }
 
  StatusCode PFlowAugmentationTool::addBranches(const EventContext& ctx) const
  {
    // Get the vertex.
    const xAOD::Vertex* pv{};
 
    auto vertexContainer = SG::makeHandle (m_vertexContainer_key, ctx);
    if (!vertexContainer.isValid()){
      ATH_MSG_WARNING("Invalid  xAOD::VertexContainer datahandle"
                      << m_vertexContainer_key.key());
      return StatusCode::FAILURE;
    }
    auto pvcont = vertexContainer.cptr();
    if ( pvcont == 0 || pvcont->size()==0 ) {
      ATH_MSG_WARNING(" Failed to retrieve PrimaryVertices collection" );
      return StatusCode::FAILURE;
    }
    for (const auto vx : *pvcont) {
      if (vx->vertexType() == xAOD::VxType::PriVtx) {
        pv = vx;
        break;
      }//If we have a vertex of type primary vertex
    }//iterate over the vertices and check their type
 
    // Use NoVtx as fall-back in case no PV is found, but the events should be rejected by the user
    // If there is no such then mark all CPFOs as unmatched
    if (pv == nullptr) {
      ATH_MSG_DEBUG("Could not find a primary vertex in this event" );
      for (auto theVertex : *pvcont) {
        if (xAOD::VxType::NoVtx == theVertex->vertexType() ) {
          pv = theVertex;
          break;
        }
      }
      if (nullptr == pv) {
        ATH_MSG_WARNING("Found neither PriVtx nor NoVtx in this event" );
      }
    }
 
    SG::WriteDecorHandle<xAOD::FlowElementContainer,float> dec_corrP4_pt(m_corrP4_ptKey, ctx);
    SG::WriteDecorHandle<xAOD::FlowElementContainer,float> dec_z0(m_z0Key, ctx);
    SG::WriteDecorHandle<xAOD::FlowElementContainer,float> dec_vz(m_vzKey, ctx);
    SG::WriteDecorHandle<xAOD::FlowElementContainer,float> dec_d0(m_d0Key, ctx);
    SG::WriteDecorHandle<xAOD::FlowElementContainer,float> dec_theta(m_thetaKey, ctx);
    SG::WriteDecorHandle<xAOD::FlowElementContainer,float> dec_envWeight(m_envWeightKey, ctx);
 
    auto pfoContainer = SG::makeHandle (m_pfoContainer_key, ctx);
    if (!pfoContainer.isValid()){
      ATH_MSG_WARNING("Invalid  xAOD::PFOContainer datahandle"
                      << m_pfoContainer_key.key());
      return StatusCode::FAILURE;
    }
    auto cpfos = pfoContainer.cptr();
 
    for ( const xAOD::FlowElement* cpfo : *cpfos ) {
      if ( cpfo == 0 ) {
        ATH_MSG_WARNING("Have NULL pointer to charged PFO");
        continue;
      }
      const xAOD::TrackParticle* ptrk = dynamic_cast<const xAOD::TrackParticle*>(cpfo->chargedObject(0));
      if ( ptrk == 0 ) {
        ATH_MSG_WARNING("Skipping charged PFO with null track pointer.");
        continue;
      }
 
      // decorate the track properties
      dec_z0(*cpfo) = ptrk->z0();
      dec_vz(*cpfo) = ptrk->vz();
      dec_d0(*cpfo) = ptrk->d0();
      dec_theta(*cpfo) = ptrk->theta();
 
      //find the weights from the tool
      float weight = 1.0;
      const static SG::AuxElement::ConstAccessor<int> accIsInDE("IsInDenseEnvironment");
      if(accIsInDE.isAvailable(*cpfo)){
        ATH_CHECK( m_weightPFOTool->fillWeight( *cpfo, weight ) );
      }
 
      // decorate the computed variables
      dec_corrP4_pt(*cpfo) = weight*cpfo->pt();
      dec_envWeight(*cpfo) = weight;
    }
 
    return StatusCode::SUCCESS;
  }
}