ftag::MetadataAlg Class Reference

#include <MetadataAlg.h>

Inheritance diagram for ftag::MetadataAlg:

Collaboration diagram for ftag::MetadataAlg:

Public Member Functions
	MetadataAlg (const std::string &name, ISvcLocator *pSvcLocator)
StatusCode	initialize () override
StatusCode	execute () override
StatusCode	finalize () override
void	handle (const Incident &) override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
bool	isGoodBook (const xAOD::CutBookkeeper &cbk) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ServiceHandle< StoreGateSvc >	m_inputMetaStore
ToolHandle< PMGTools::IPMGTruthWeightTool >	m_truthWeightTool
ServiceHandle< IH5GroupSvc >	m_output_svc
Gaudi::Property< std::string >	m_json_output
ServiceHandle< IH5GroupSvc >	m_hist_output_svc
Gaudi::Property< bool >	m_enable_systematics
Gaudi::Property< std::set< std::string > >	m_allowed_streams
std::unordered_map< size_t, OriginalAodCounts >	m_weights
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default).
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default).
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 23 of file MetadataAlg.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

MetadataAlg()

ftag::MetadataAlg::MetadataAlg	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 64 of file MetadataAlg.cxx.

                             :
    AthAlgorithm(name, pSvcLocator),
    m_inputMetaStore("StoreGateSvc/InputMetaDataStore", name)
  {
  }

Member Function Documentation

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & hndl, const SG::VarHandleKeyType &  )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode ftag::MetadataAlg::execute ( )

override

Definition at line 99 of file MetadataAlg.cxx.

  {
    return StatusCode::SUCCESS;
  }

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return Algorithm::extraOutputDeps();
}

finalize()

StatusCode ftag::MetadataAlg::finalize ( )

override

Definition at line 181 of file MetadataAlg.cxx.

  {
 
    if (m_weights.empty()) {
      ATH_MSG_WARNING("No CutBookkeeper weights collected; skipping output.");
      return StatusCode::SUCCESS;
    }
 
    std::vector<CP::SystematicSet> systematics;
    systematics.emplace_back();               // nominal always first
    if (m_enable_systematics) {
      for (const CP::SystematicVariation& v :
           m_truthWeightTool->affectingSystematics()) {
        ATH_MSG_DEBUG(
          "using systematic " << CP::SystematicSet({v}).name());
        systematics.emplace_back(CP::SystematicSet({v}));
      }
    }
 
    std::optional<H5::Group> h5_cbk;
    if (!m_output_svc.empty()) {
      h5_cbk = H5::Group(m_output_svc->group()->createGroup(top_group));
    }
    std::optional<boost::json::object> json_cbk;
    if (!m_json_output.empty()) {
      json_cbk = boost::json::object{};
    }
 
    for (const CP::SystematicSet &sys : systematics)
    {
      const std::string sysname = sys.name().empty() ? "nominal": sys.name();
      const OriginalAodCounts &weights = m_weights.at(
        m_truthWeightTool->getSysWeightIndex(sys));
 
      if (h5_cbk) {
        H5::Group sysgroup(h5_cbk->createGroup(sysname));
        addCounts(sysgroup, weights);
      }
      if (json_cbk) {
        boost::json::object& cbk_root = *json_cbk;
        addCounts(cbk_root[sysname].emplace_object(), weights);
      }
    }
    if (json_cbk) {
      std::ofstream out(m_json_output.value());
      boost::json::object jroot {
        {top_group, *json_cbk}
      };
      out << jroot << std::endl;
    }
 
    if (!m_hist_output_svc.empty()) {
      namespace bh = boost::histogram;
 
      // Build index->name map and index list in one pass.
      using sys_map_t = std::map<size_t, std::string>;
      sys_map_t sys_map;
      std::vector<size_t> indices;
      for (const CP::SystematicSet& sys : systematics) {
        size_t idx = m_truthWeightTool->getSysWeightIndex(sys);
        sys_map[idx] = sys.name().empty() ? "nominal" : sys.name();
        indices.push_back(idx);
      }
 
      // Categorical axis: bin value = index, metadata = map for labels.
      using map_meta_t = std::pair<std::string, sys_map_t>;
      using sys_ax_t = bh::axis::category<size_t, map_meta_t>;
      const sys_ax_t ax(indices, map_meta_t{"systematic", sys_map});
 
      // Weighted histogram: bin=(sumOfWeights, sumOfWeightsSquared).
      auto h_w = bh::make_weighted_histogram(ax);
 
      // Integer histogram: nEventsProcessed.
      using int64_storage = bh::dense_storage<int64_t>;
      auto h_n = bh::make_histogram_with(int64_storage{}, ax);
 
      // Fill by systematic index.
      for (size_t idx : indices) {
        const auto& w = m_weights.at(idx);
        const auto bin = ax.index(idx);
        h_w.at(bin) =
          bh::accumulators::weighted_sum<double>(
            w.sumOfWeights, w.sumOfWeightsSquared);
        h_n.at(bin) =
          static_cast<int64_t>(w.nEventsProcessed);
      }
 
      H5::Group hist_grp(
        m_hist_output_svc->group()
          ->createGroup("cutBookkeeperHists"));
      H5Utils::hist::write_hist_to_group(
        hist_grp, h_w, "sumOfWeights");
      H5Utils::hist::write_hist_to_group(
        hist_grp, h_n, "nEventsProcessed");
    }
 
    return StatusCode::SUCCESS;
  }

handle()

void ftag::MetadataAlg::handle ( const Incident & inc )

override

Definition at line 104 of file MetadataAlg.cxx.

  {
 
    // skip all incidents beyond the start of input files
    if (inc.type() != IncidentType::BeginInputFile) return;
 
    ATH_MSG_DEBUG("Updating CutBookkeeper information");
 
    // Retrieve complete CutBookkeeperContainer
    const xAOD::CutBookkeeperContainer *completeCBC{};
    auto rc = m_inputMetaStore->retrieve(completeCBC, "CutBookkeepers");
    if (!rc.isSuccess()) throw std::runtime_error(
      "could not retrieve CutBookkeepers");
 
    // Find the max cycle
    int maxCycle{-1};
    const xAOD::CutBookkeeper *allEvents{};
    for (const xAOD::CutBookkeeper *cbk : *completeCBC)
    {
      ATH_MSG_DEBUG(
        "Complete cbk name: " << cbk->name() <<
        " - stream: " << cbk->inputStream()
        );
 
      if (cbk->cycle() > maxCycle && isGoodBook(*cbk))
      {
        allEvents = cbk;
        maxCycle = cbk->cycle();
      }
    }
 
    if (allEvents == nullptr)
    {
      throw std::runtime_error(
        "Could not find AllExecutedEvents CutBookkeeper information.");
    }
 
    for (const xAOD::CutBookkeeper *cbk : *completeCBC)
    {
      if (cbk->cycle() == maxCycle && isGoodBook(*cbk))
      {
        static const std::regex re("AllExecutedEvents.*_([0-9]+)");
        // Get the CBK index
        size_t index{0};
        std::smatch match;
        if (std::regex_match(cbk->name(), match, re))
        {
          index = std::stoi(match[1]);
        }
        m_weights[index] += getCounts(*cbk);
      }
    }
 
    // now try systematics-aware containers
    for (size_t index{1}; index < m_truthWeightTool->getWeightNames().size(); ++index)
    {
      std::string cbkName = "CutBookkeepers_weight_" + std::to_string(index);
      if (!m_inputMetaStore->contains<xAOD::CutBookkeeperContainer>(cbkName))
      {
        ATH_MSG_VERBOSE("No container named " << cbkName << "available");
        continue;
      }
 
      if (!m_inputMetaStore->retrieve(completeCBC, cbkName).isSuccess()) {
        throw std::runtime_error("could not retrieve " + cbkName);
      }
      for (const xAOD::CutBookkeeper *cbk : *completeCBC)
      {
        if (cbk->cycle() == maxCycle && isGoodBook(*cbk))
        {
          m_weights[index] += getCounts(*cbk);
        }
      }
    }
  }

initialize()

StatusCode ftag::MetadataAlg::initialize ( )

override

Definition at line 78 of file MetadataAlg.cxx.

  {
    // register with incident service
    ServiceHandle<IIncidentSvc> incSvc( "IncidentSvc", name() );
    CHECK( incSvc.retrieve() );
    // remove first to make sure it's not called twice
    incSvc->removeListener( this, IncidentType::BeginInputFile );
    incSvc->addListener( this, IncidentType::BeginInputFile, 0, true );
 
    CHECK(m_truthWeightTool.retrieve());
 
    if (!m_output_svc.empty()) {
      ATH_CHECK(m_output_svc.retrieve());
    }
    if (!m_hist_output_svc.empty()) {
      ATH_CHECK(m_hist_output_svc.retrieve());
    }
 
    return StatusCode::SUCCESS;
  }

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

isGoodBook()

bool ftag::MetadataAlg::isGoodBook ( const xAOD::CutBookkeeper & cbk ) const

private

Definition at line 72 of file MetadataAlg.cxx.

  {
    return cbk.name() == "AllExecutedEvents"
      && m_allowed_streams.value().contains(cbk.inputStream());
  }

msg()

MsgStream & AthCommonMsg< Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_allowed_streams

Gaudi::Property<std::set<std::string> > ftag::MetadataAlg::m_allowed_streams

private

Initial value:

{
      this, "allowedStreams",
      {"StreamAOD", "StreamEVGEN", "StreamEVNT",
       "StreamDAOD_PHYS", "StreamDAOD_PHYSLITE"},
      "CutBookkeeper inputStream values accepted as AllExecutedEvents"
    }

Definition at line 54 of file MetadataAlg.h.

                                                       {
      this, "allowedStreams",
      {"StreamAOD", "StreamEVGEN", "StreamEVNT",
       "StreamDAOD_PHYS", "StreamDAOD_PHYSLITE"},
      "CutBookkeeper inputStream values accepted as AllExecutedEvents"
    };

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

m_enable_systematics

Gaudi::Property<bool> ftag::MetadataAlg::m_enable_systematics

private

Initial value:

{
      this, "enableSystematics", true,
      "include systematic variations (false = nominal only)"}

Definition at line 51 of file MetadataAlg.h.

                                             {
      this, "enableSystematics", true,
      "include systematic variations (false = nominal only)"};

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

m_hist_output_svc

ServiceHandle<IH5GroupSvc> ftag::MetadataAlg::m_hist_output_svc

private

Initial value:

{
      this, "h5OutputHists", "",
      "output service for histogram output"}

Definition at line 48 of file MetadataAlg.h.

                                                 {
      this, "h5OutputHists", "",
      "output service for histogram output"};

m_inputMetaStore

ServiceHandle< StoreGateSvc > ftag::MetadataAlg::m_inputMetaStore

private

Definition at line 38 of file MetadataAlg.h.

m_json_output

Gaudi::Property<std::string> ftag::MetadataAlg::m_json_output

private

Initial value:

{
      this, "jsonOutput", "", "json output file"
    }

Definition at line 45 of file MetadataAlg.h.

                                           {
      this, "jsonOutput", "", "json output file"
    };

m_output_svc

ServiceHandle<IH5GroupSvc> ftag::MetadataAlg::m_output_svc

private

Initial value:

{
      this, "h5Output", "", "output file service"}

Definition at line 43 of file MetadataAlg.h.

                                            {
      this, "h5Output", "", "output file service"};

m_truthWeightTool

ToolHandle<PMGTools::IPMGTruthWeightTool> ftag::MetadataAlg::m_truthWeightTool

private

Initial value:

{
      this, "truthWeightTool", "PMGTools::PMGTruthWeightTool",
      "the truth weight tool"}

Definition at line 40 of file MetadataAlg.h.

                                                              {
      this, "truthWeightTool", "PMGTools::PMGTruthWeightTool",
      "the truth weight tool"};

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

m_weights

std::unordered_map<size_t, OriginalAodCounts> ftag::MetadataAlg::m_weights

private

Definition at line 60 of file MetadataAlg.h.

---

The documentation for this class was generated from the following files:

• MetadataAlg.h
• MetadataAlg.cxx