EventDensityTool.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
// EventDensityTool.cxx 
 
#include "EventShapeTools/EventDensityTool.h"
#include "fastjet/JetDefinition.hh"
#include "fastjet/AreaDefinition.hh"
#include "fastjet/ClusterSequenceArea.hh"
#include "xAODEventShape/EventShape.h"
#include "xAODEventShape/EventShapeAuxInfo.h"
#include "JetEDM/PseudoJetVector.h"
#include "AsgDataHandles/ReadHandle.h"
#include "AsgDataHandles/WriteHandle.h"
 
using fastjet::JetAlgorithm;
using fastjet::JetDefinition;
using fastjet::ClusterSequence;
using fastjet::ClusterSequenceArea;
using fastjet::AreaDefinition;
using fastjet::VoronoiAreaSpec;
 
//**********************************************************************
 
EventDensityTool::EventDensityTool(const std::string& name)
  : asg::AsgTool(name),
  m_useAreaFourMom(true)
{
  declareProperty("JetAlgorithm",    m_jetalg  = "Kt");
  declareProperty("JetRadius",       m_jetrad  = 0.4);
  declareProperty("AbsRapidityMin",  m_rapmin  = 0.0);
  declareProperty("AbsRapidityMax",  m_rapmax  = 2.0);
  declareProperty("AreaDefinition",  m_areadef = "Voronoi");
  declareProperty("VoronoiRfact",    m_vrfact  = 1.0);
  declareProperty("UseFourMomArea",  m_useAreaFourMom);
  declareProperty("TrigPseudoJetGetter", m_trigPJGet);
}
 
//**********************************************************************
 
EventDensityTool::~EventDensityTool() {}
 
//**********************************************************************
 
StatusCode EventDensityTool::initialize() {
  ATH_MSG_DEBUG ("Initializing " << name() << "...");
 
  // Initialise output handle
  ATH_CHECK( m_outEDKey.initialize() );
 
  // Fetch the fastjet algorithm enum
  JetAlgorithm fjalg;
  if      ( m_jetalg == "Kt"     ) fjalg = fastjet::kt_algorithm;
  else if ( m_jetalg == "AntiKt" ) fjalg = fastjet::antikt_algorithm;
  else if ( m_jetalg == "CamKt"  ) fjalg = fastjet::cambridge_algorithm;
  else {
    ATH_MSG_ERROR("Invalid jet algorithm name: " << m_jetalg);
    ATH_MSG_ERROR("Allowed values are Kt, CamKt, AntiKt, etc.");
    return StatusCode::FAILURE;
  }
 
  // Build jet definition.
  m_fjjetdef = JetDefinition(fjalg, m_jetrad);
 
  // Build area definition.
  if ( m_areadef == "Voronoi" ) {
    m_fjareadef = AreaDefinition(fastjet::voronoi_area, VoronoiAreaSpec(m_vrfact));
  } else if ( m_areadef == "Active" || m_useAreaFourMom ) {
    // Default is fine here for now.
    // Later might want to switch to seeds and binning used in jet reco.
    // See JetRec/JetFinder for that.
  } else {
    ATH_MSG_WARNING("Unsupported area option: " << m_areadef);
    return StatusCode::FAILURE;
  }
 
  // Build the jet selector.
  if ( m_rapmin >= 0.0  &&  m_rapmax > m_rapmin ) {
    m_fjselector = fastjet::SelectorAbsRapRange(m_rapmin, m_rapmax);
  } else {
    ATH_MSG_WARNING("Invalid absolute rapidity range: ("
                    << m_rapmin << ", " << m_rapmax << ")");
    return StatusCode::FAILURE;
  }
  ATH_MSG_DEBUG("Configured properties:");
  ATH_MSG_DEBUG("     JetAlgorithm: " << m_jetalg);
  ATH_MSG_DEBUG("        JetRadius: " << m_jetrad);
  if(!m_inPJKey.key().empty()) {
    ATH_MSG_INFO("   Input: " << m_inPJKey.key() << " -> Output: " << m_outEDKey.key());
  } else {
    ATH_MSG_INFO("     TrigPJGetter: " << m_trigPJGet.name() << " -> Output: " << m_outEDKey.key());
  }
  ATH_MSG_DEBUG("   AbsRapidityMin: " << m_rapmin);
  ATH_MSG_DEBUG("   AbsRapidityMax: " << m_rapmax);
  ATH_MSG_DEBUG("   AreaDefinition: " << m_areadef);
  ATH_MSG_DEBUG("     VoronoiRfact: " << m_vrfact);
  ATH_MSG_DEBUG("Derived properties:");
  ATH_MSG_DEBUG("        Fastjet jet defn: " << m_fjjetdef.description());
  ATH_MSG_DEBUG("       Fastjet area defn: " << m_fjareadef.description());
  ATH_MSG_DEBUG("    Fastjet jet selector: " << m_fjselector.description());
  ATH_MSG_DEBUG("  Use area four-momentum: " << m_useAreaFourMom);
 
  // Input sources
  if(!m_inPJKey.key().empty() && m_trigPJGet.empty()) {
    ATH_CHECK( m_inPJKey.initialize() );
  }
  // { FIXME: To be removed when trigger moves to handles fully
  else if(m_inPJKey.key().empty() && !m_trigPJGet.empty()) {
    ATH_CHECK( m_trigPJGet.retrieve() );
  }
  // } FIXME
  else {
    ATH_MSG_ERROR( "Inconsistent/ambiguous input setup."
           << " InPJKey: " << m_inPJKey.key() 
           << " TrigPJGetter: " << m_trigPJGet.name() );
    return StatusCode::FAILURE;
  }
 
  return StatusCode::SUCCESS;
}
 
//**********************************************************************
 
StatusCode EventDensityTool::fillEventShape() const {
  
  ATH_MSG_DEBUG("Begin fillEventShape()");
 
  std::unique_ptr<xAOD::EventShape> eventShape(std::make_unique<xAOD::EventShape>());
  std::unique_ptr<xAOD::EventShapeAuxInfo> eventShapeaux(std::make_unique<xAOD::EventShapeAuxInfo>());
  eventShape->setStore( eventShapeaux.get() );
 
  // Change the order: first fill the object and then record
  ATH_CHECK(fillEventShape(eventShape.get()));  
 
  auto h_out = makeHandle(m_outEDKey);
  if ( ! h_out.record(std::move(eventShape), std::move(eventShapeaux) )) {
    ATH_MSG_WARNING("Unable to write new EventShape and aux store to event store: " << m_outEDKey.key());
  } else {
    ATH_MSG_DEBUG("Created new EventShape container: " << m_outEDKey.key());
  }
 
  return StatusCode::SUCCESS;
}
 
//**********************************************************************
StatusCode EventDensityTool::fillEventShape(xAOD::EventShape *eventShape) const {
 
  if(!m_inPJKey.key().empty() && m_trigPJGet.empty()) {
    auto h_in = makeHandle(m_inPJKey);
    if( ! h_in.isValid() ) {
      ATH_MSG_ERROR("No input PseudoJetContainer "<< m_inPJKey.key() );
      return StatusCode::FAILURE;
    }
    if ( h_in->size() == 0 ) {
      ATH_MSG_DEBUG( "Input PseudoJetContainer size()=0 for pseudojets from "<< m_inPJKey.key() );
    } else {
      ATH_MSG_DEBUG("Retrieved input pseudojets " << m_inPJKey.key() << " , count: " <<  h_in->size());
    }
    return fillEventShape(eventShape, *(h_in->casVectorPseudoJet()));
  }
  // { FIXME: To be removed when trigger moves to handles fully
  else if(m_inPJKey.key().empty() && !m_trigPJGet.empty()) {
    const PseudoJetVector& ppjv = *(m_trigPJGet->get());
    // !!! FIXME !!! Downgraded ERROR to WARNING and no FAILURE
    if ( ppjv.size() == 0 ) {
      ATH_MSG_WARNING( "Input PseudoJetVector size()=0 for pseudojets from "<< m_trigPJGet.name() );
      //return StatusCode::FAILURE;
    } else {
      ATH_MSG_DEBUG("Retrieved input pseudojets " << m_trigPJGet.name() << " , count: " <<  ppjv.size());
    }
    return fillEventShape(eventShape, ppjv);
  }
  // } FIXME
  
  return StatusCode::FAILURE;
}
 
//**********************************************************************
 
StatusCode EventDensityTool::
fillEventShape( xAOD::EventShape* eventShape, const PseudoJetVector& pjv) const { 
  ATH_MSG_DEBUG("Input pseudojet count: " << pjv.size());
  ATH_MSG_DEBUG("Event shape container address: " << eventShape);
 
  for(const auto & pj : pjv) {
    ATH_MSG_DEBUG(" pj input e="<<pj.e() << " pz="<<pj.pz() << " px="<<pj.px() );
  }
  // Find jets.
  std::unique_ptr<ClusterSequenceArea> pcsa=std::make_unique<ClusterSequenceArea>(pjv, m_fjjetdef, m_fjareadef);
  ATH_MSG_DEBUG("Found jet count: " << pcsa->inclusive_jets().size());
 
  // Extract rho.
  double rho, sigma, area;
  pcsa->get_median_rho_and_sigma(m_fjselector, m_useAreaFourMom, rho, sigma, area);
  ATH_MSG_DEBUG(" calculated rho="<< rho);
 
  // Record rho.
 
  // Fill the EventShape object
  const static SG::AuxElement::Accessor<float> rhoDec("Density");
  const static SG::AuxElement::Accessor<float> sigmaDec("DensitySigma");
  const static SG::AuxElement::Accessor<float> areaDec("DensityArea");
  rhoDec(*eventShape) = rho;
  sigmaDec(*eventShape) = sigma;
  areaDec(*eventShape) = area;
 
  ATH_MSG_DEBUG("Recorded event density:  = " << 0.001*rho << " GeV");
 
  return StatusCode::SUCCESS;
}