Writer.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 2024-2026 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
#include <Gaudi/Algorithm.h>
#include <Gaudi/Functional/Consumer.h>
#include <Gaudi/Interfaces/IFileSvc.h>
#include <Gaudi/details/BranchWrapper.h>
#include <GaudiKernel/StdArrayAsProperty.h>
 
#include <mutex>
#include <tuple>
#include <utility>
 
#include <TFile.h>
#include <TTree.h>
 
#include <gsl/pointers>
 
namespace Gaudi::NTuple {

  template <typename... COLUMNS>
  class Wrapper {
  public:
    // Initialize the TTree and creates branches
    void initTree( TFile& file, std::string const& algName, std::string name,
                   std::array<std::string, sizeof...( COLUMNS )> const& branchNames ) {
      // handle the case where the name given includes '/', then it's actually a directory and a name
      auto pos = name.rfind( '/' );
      if ( pos != std::string::npos ) {
        m_dir = name.substr( 0, pos );
        name  = name.substr( pos + 1 );
      }
      // create directory if needed
      if ( m_dir != "" ) file.mkdir( m_dir.c_str(), "", true );
      // Needed for ROOT to write data of the TTree in the right file
      file.cd( m_dir.c_str() );
      // create TTree and branches
      m_tree = std::make_unique<TTree>( name.c_str(), "Tree of Writer Algorithm" ).release();
      m_branchWrappers.reserve( m_branchWrappers.size() + sizeof...( COLUMNS ) );
      createBranches( std::make_index_sequence<sizeof...( COLUMNS )>{}, algName, branchNames );
    }

    void fillTree( std::tuple<COLUMNS...> const& data ) const {
      std::scoped_lock lock{ m_mtx };
      std::apply(
          [&]( const auto&... elems ) {
            size_t index = 0;
            ( ..., m_branchWrappers[index++].setDataPtr( const_cast<void*>( static_cast<const void*>( &elems ) ) ) );
          },
          data );
      m_tree->Fill();
    }
 
    // Write the TTree to the given ROOT file
    void writeTree( TFile& file, std::string const& algName ) {
      // Change to the proper directory in the ROOT file
      file.cd( m_dir.c_str() );
      if ( m_tree->Write() <= 0 ) {
        throw GaudiException( "Failed to write TTree to ROOT file.", algName, StatusCode::FAILURE );
      }
      m_tree = nullptr;
    }
 
  private:
    TTree*                                             m_tree{ nullptr };  // Pointer to the TTree being written to
    std::string                                        m_dir{};            // Directory where to create m_tree
    mutable std::vector<Gaudi::details::BranchWrapper> m_branchWrappers{}; // Container for BranchWrapper objects
    mutable std::mutex                                 m_mtx;              // Mutex for thread-safe operations
 
    // Create branches in the TTree based on the provided names and output data types
    template <std::size_t... Is>
    void createBranches( std::index_sequence<Is...> const, std::string const& algName,
                         std::array<std::string, sizeof...( COLUMNS )> const& branchNames ) const {
      ( ..., m_branchWrappers.emplace_back(
                 m_tree, System::typeinfoName( typeid( std::tuple_element_t<Is, std::tuple<COLUMNS...>> ) ),
                 branchNames[Is], "", algName ) );
    }
  };

  template <typename Base>
  struct FileHolder : Base {
    using Base::Base;
    TFile* file() { return m_file.get(); }
    // Initialize the algorithm, set up the ROOT file and a TTree branch for each input location
    virtual StatusCode initialize() override {
      return Base::initialize().andThen( [this]() {
        m_file = m_fileSvc->getFile( m_fileId );
        if ( !m_file ) {
          this->error() << "Failed to retrieve TFile." << endmsg;
          return StatusCode::FAILURE;
        }
        return StatusCode::SUCCESS;
      } );
    }
 
  private:
    Gaudi::Property<std::string> m_fileId{ this, "OutputFile", "NTuple", "Identifier for the TFile to write to." };
    ServiceHandle<Gaudi::Interfaces::IFileSvc> m_fileSvc{ this, "FileSvc", "FileSvc" };
    std::shared_ptr<TFile>                     m_file = nullptr; // Pointer to the ROOT file
  };

  template <typename Signature, typename Traits_ = Gaudi::Functional::Traits::BaseClass_t<Gaudi::Algorithm>>
  struct SimpleWriter {
    SimpleWriter() = delete;
  };

  template <typename... OUTPUTs, typename... INPUTs, typename Traits_>
  struct SimpleWriter<std::tuple<OUTPUTs...>( const INPUTs&... ), Traits_>
      : FileHolder<Gaudi::Functional::Consumer<void( const INPUTs&... ), Traits_>> {
    using Consumer_t = FileHolder<Gaudi::Functional::Consumer<void( const INPUTs&... ), Traits_>>;
    using Consumer_t::Consumer_t;
 
    Gaudi::Property<std::string> m_ntupleTname{ this, "NTupleName", this->name(), "Name of the TTree." };
    Gaudi::Property<std::array<std::string, sizeof...( OUTPUTs )>> m_branchNames{
        this, "BranchNames", {}, "Names of the tree branches." }; // Names for the tree branches
 
    // Initialize the algorithm, set up the ROOT file and a TTree branch for each input location
    virtual StatusCode initialize() override {
      return Consumer_t::initialize().andThen( [this]() {
        m_ntuple.initTree( *this->file(), this->name(), m_ntupleTname.value(), m_branchNames.value() );
        return StatusCode::SUCCESS;
      } );
    }
 
    // Fill the TTree with transformed data
    void fillTree( const std::tuple<OUTPUTs...>& data ) const { m_ntuple.fillTree( data ); }
 
    // Finalize the algorithm by writing the TTree to the file and closing it
    virtual StatusCode finalize() override {
      m_ntuple.writeTree( *this->file(), this->name() );
      return Consumer_t::finalize();
    }
 
  private:
    Wrapper<OUTPUTs...> m_ntuple;
  };

  template <typename Signature, typename Traits_ = Gaudi::Functional::Traits::BaseClass_t<Gaudi::Algorithm>>
  struct Writer {
    Writer() = delete; // If you wish to not provide any transformation for your data, please use the
                       // NTuple::GenericWriter
    // algorithm
  };

  template <typename... OUTPUTs, typename... INPUTs, typename Traits_>
  struct Writer<std::tuple<OUTPUTs...>( const INPUTs&... ), Traits_>
      : SimpleWriter<std::tuple<OUTPUTs...>( const INPUTs&... ), Traits_> {
 
    using SimpleWriter_t = SimpleWriter<std::tuple<OUTPUTs...>( const INPUTs&... ), Traits_>;
    using SimpleWriter_t::SimpleWriter_t;

    virtual std::tuple<OUTPUTs...> transform( const INPUTs&... inputs ) const = 0;
 
    // Execute the algorithm for each event, retrieving data from the event store and writing it to the TTree
    void operator()( const INPUTs&... inputs ) const override {
      auto transformedData = transform( inputs... );
      this->fillTree( transformedData );
    }
  };
 
} // namespace Gaudi::NTuple