NTupleSvc.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-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
 
// Framework include files
#include <GaudiKernel/DataSvc.h>
#include <GaudiKernel/IDataSourceMgr.h>
#include <GaudiKernel/INTupleSvc.h>
 
// STL include files
#include <map>

class NTupleSvc : public extends<DataSvc, INTupleSvc, IDataSourceMgr> {
protected:
  struct Connection final {
    IConversionSvc* service;
    Connection( IConversionSvc* s ) : service( s ) {}
    Connection( const Connection& c ) : service( c.service ) {}
  };
  typedef std::vector<std::string>            DBaseEntries;
  typedef std::pair<std::string, std::string> Prop;
 
public:
  StatusCode initialize() override;
  StatusCode reinitialize() override;
  StatusCode finalize() override;
  IConversionSvc* getDataLoader( IRegistry* pReg ) override;

  NTuple::Directory* createDirectory( DataObject* pParent, const std::string& title ) override;
  NTuple::Directory* createDirectory( DataObject* pParent, long id ) override;
  NTuple::Directory* createDirectory( const std::string& dirPath, long id ) override;
  NTuple::Directory* createDirectory( const std::string& dirPath, const std::string& title ) override;
  NTuple::Directory* createDirectory( const std::string& fullPath ) override;

  StatusCode create( const CLID& typ, const std::string& title, NTuple::Tuple*& refpTuple ) override;
  NTuple::Tuple* book( const std::string& fullPath, const CLID& type, const std::string& title ) override;
  NTuple::Tuple* book( const std::string& dirPath, const std::string& relPath, const CLID& type,
                       const std::string& title ) override;
  NTuple::Tuple* book( const std::string& dirPath, long id, const CLID& type, const std::string& title ) override;
  NTuple::Tuple* book( DataObject* pParent, const std::string& relPath, const CLID& type,
                       const std::string& title ) override;
  NTuple::Tuple* book( DataObject* pParent, long id, const CLID& type, const std::string& title ) override;
  NTuple::Tuple* access( const std::string& fullPath, const std::string& filename ) override;
  StatusCode save( const std::string& fullPath ) override;
  StatusCode save( NTuple::Tuple* tuple ) override;
  StatusCode save( DataObject* pParent, const std::string& relPath ) override;
  StatusCode writeRecord( NTuple::Tuple* tuple ) override;
  StatusCode writeRecord( const std::string& fullPath ) override;
  StatusCode writeRecord( DataObject* pParent, const std::string& relPath ) override;
  StatusCode readRecord( NTuple::Tuple* tuple ) override;
  StatusCode readRecord( const std::string& fullPath ) override;
  StatusCode readRecord( DataObject* pParent, const std::string& relPath ) override;

  bool isConnected( const std::string& identifier ) const override;

  StatusCode connect( const std::string& ident ) override;
  StatusCode connect( const std::string& ident, std::string& logname ) override;
  StatusCode disconnect( const std::string& nam ) override;
  StatusCode disconnectAll() override;

  NTupleSvc( const std::string& name, ISvcLocator* svc );
 
protected:
  StatusCode createService( const std::string& nam, const std::string& typ, const std::vector<Prop>& props,
                            IConversionSvc*& pSvc );
  void releaseConnection( Connection& c );
  StatusCode attachTuple( const std::string& filename, const std::string& logname, const char typ, const long t );
  StatusCode updateDirectories();
 
  Gaudi::Property<DBaseEntries> m_input{ this, "Input", {}, "input streams" };
  Gaudi::Property<DBaseEntries> m_output{ this, "Output", {}, "output streams" };
 
  Gaudi::Property<int>  m_basketsize{ this, "BasketSize", 32000, "BasketSize" }; // ROOT default
  Gaudi::Property<bool> m_diskBuffer{
      this, "DiskBuffer", false,
      "Append rows of column-wise tuples to a file on disk during the run and build the TTrees at finalize" };
  Gaudi::Property<std::string> m_diskBufferDir{ this, "DiskBufferDirectory", "",
                                                "Where to put the buffer directory; empty = next to the output file" };
  Gaudi::Property<int>         m_diskBufferCompression{ this, "DiskBufferCompression", 3,
                                                "zstd level for the disk buffer files, 0 = uncompressed" };
  Gaudi::Property<int>         m_diskBufferBlockSize{
      this, "DiskBufferBlockSize", 64 * 1024,
      "Bytes of rows collected per tuple before a block is compressed and written: the memory held per "
              "tuple, and what zstd can see at once (only worth raising when consecutive rows are near-copies)" };

  std::map<std::string, Connection> m_connections;
};