#include </builds/gaudi/Gaudi/RootHistCnv/src/RCWNTupleCnv.h>

Inheritance diagram for RootHistCnv::RCWNTupleCnv:

[legend]

Collaboration diagram for RootHistCnv::RCWNTupleCnv:

[legend]

Public Member Functions
	RCWNTupleCnv (ISvcLocator *svc)
	Standard constructor. More...

Public Member Functions inherited from RootHistCnv::RNTupleCnv
StatusCode	initialize () override
	Initialize the converter. More...

StatusCode	finalize () override
	Finalize the converter. More...

StatusCode	createObj (IOpaqueAddress pAddr, DataObject &refpObj) override
	Create the transient representation of an object. More...

StatusCode	updateObj (IOpaqueAddress pAddr, DataObject refpObj) override
	Update the transient object from the other representation. More...

StatusCode	createRep (DataObject pObj, IOpaqueAddress &refpAddr) override
	Convert the transient object to the requested representation. More...

StatusCode	updateRep (IOpaqueAddress pAddr, DataObject pObj) override
	Update the converted representation of a transient object. More...

Public Member Functions inherited from RootHistCnv::RConverter
StatusCode	createRep (DataObject pObj, IOpaqueAddress &refpAddr) override
	Convert the transient object to the requested representation. More...

long	repSvcType () const override

StatusCode	error (const std::string &msg)

StatusCode	regTFile (const std::string, const TFile *)

StatusCode	findTFile (const std::string, TFile *&)

std::string	diskDirectory (const std::string &loc)

std::string	directory (const std::string &loc)

void	setDirectory (const std::string &loc)

void	setDiskDirectory (const std::string &loc)

StatusCode	createDirectory (const std::string &loc)

StatusCode	createDiskDirectory (const std::string &loc)

std::string	getDirectory ()

std::string	convertId (const std::string &) const

Public Member Functions inherited from Converter
StatusCode	initialize () override
	Initialize the converter. More...

StatusCode	finalize () override
	Initialize the converter. More...

StatusCode	setDataProvider (IDataProviderSvc *svc) override
	Set Data provider service. More...

SmartIF< IDataProviderSvc > &	dataProvider () const override
	Get Data provider service. More...

StatusCode	setConversionSvc (IConversionSvc *svc) override
	Set conversion service the converter is connected to. More...

SmartIF< IConversionSvc > &	conversionSvc () const override
	Get conversion service the converter is connected to. More...

StatusCode	setAddressCreator (IAddressCreator *creator) override
	Set address creator facility. More...

SmartIF< IAddressCreator > &	addressCreator () const override
	Retrieve address creator facility. More...

const CLID &	objType () const override
	Retrieve the class type of objects the converter produces. More...

virtual long	i_repSvcType () const
	Retrieve the class type of the data store the converter uses. More...

StatusCode	createObj (IOpaqueAddress pAddress, DataObject &refpObject) override
	Create the transient representation of an object. More...

StatusCode	fillObjRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Resolve the references of the created transient object. More...

StatusCode	updateObj (IOpaqueAddress pAddress, DataObject refpObject) override
	Update the transient object from the other representation. More...

StatusCode	updateObjRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Update the references of an updated transient object. More...

StatusCode	createRep (DataObject pObject, IOpaqueAddress &refpAddress) override
	Convert the transient object to the requested representation. More...

StatusCode	fillRepRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Resolve the references of the converted object. More...

StatusCode	updateRep (IOpaqueAddress pAddress, DataObject pObject) override
	Update the converted representation of a transient object. More...

StatusCode	updateRepRefs (IOpaqueAddress pAddress, DataObject pObject) override
	Update the references of an already converted object. More...

	Converter (long storage_type, const CLID &class_type, ISvcLocator *svc=0)
	Standard Constructor. More...

template<class T >
StatusCode	service (const std::string &name, T *&psvc, bool createIf=false) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &type, const std::string &name, T *&psvc) const
	Access a service by name, type creating it if it doesn't already exist. More...

SmartIF< IService >	service (const std::string &name, const bool createIf=true) const
	Return a pointer to the service identified by name (or "type/name") More...

Public Member Functions inherited from implements< IConverter >
void *	i_cast (const InterfaceID &tid) const override
	Implementation of IInterface::i_cast. More...

StatusCode	queryInterface (const InterfaceID &ti, void **pp) override
	Implementation of IInterface::queryInterface. More...

std::vector< std::string >	getInterfaceNames () const override
	Implementation of IInterface::getInterfaceNames. More...

	implements ()=default
	Default constructor. More...

	implements (const implements &)
	Copy constructor (zero the reference count) More...

implements &	operator= (const implements &)
	Assignment operator (do not touch the reference count). More...

unsigned long	addRef () override
	Reference Interface instance More...

unsigned long	release () override
	Release Interface instance More...

unsigned long	refCount () const override
	Current reference count More...

Static Public Member Functions
static const CLID &	classID ()
	Inquire class type. More...

Static Public Member Functions inherited from RootHistCnv::RConverter
static long	storageType ()
	Inquire storage type. More...

Protected Member Functions
StatusCode	load (TTree tree, INTuple &refpObject) override
	Create the transient representation of an object. More...

StatusCode	book (const std::string &desc, INTuple pObject, TTree &tree) override
	Book the N tuple. More...

StatusCode	writeData (TTree rtree, INTuple pObject) override
	Write N tuple data. More...

StatusCode	readData (TTree rtree, INTuple pObject, long ievt) override
	Read N tuple data. More...

Protected Member Functions inherited from RootHistCnv::RNTupleCnv
	RNTupleCnv (ISvcLocator *svc, const CLID &clid)
	Standard constructor. More...

virtual std::string	rootVarType (int)
	Return ROOT type info: More...

Protected Member Functions inherited from RootHistCnv::RConverter
	RConverter (const CLID &clid, ISvcLocator *svc)
	Standard constructor. More...

virtual StatusCode	readObject (IOpaqueAddress pAddr, DataObject &refpObj)
	Create the transient representation of an object. More...

virtual TObject *	createPersistent (DataObject *pObj)
	Create the persistent representation of an object. More...

StatusCode	createAddress (DataObject pObject, TDirectory pDir, TObject pTObject, IOpaqueAddress &refpAddr)
	Create address of the transient object according to the requested representation. More...

StatusCode	createAddress (const std::string &rzdir, const CLID &clid, long id, TObject pTobj, IOpaqueAddress &refpAddress)

StatusCode	createAddress (const std::string &rzdir, const CLID &clid, const std::string &title, TObject pTobj, IOpaqueAddress &refpAddress)

TDirectory *	changeDirectory (DataObject *pObject)
	Switch to object directory (=Parent directory) More...

Protected Member Functions inherited from Converter
SmartIF< ISvcLocator > &	serviceLocator () const
	Retrieve pointer to service locator. More...

SmartIF< IMessageSvc > &	msgSvc () const
	Retrieve pointer to message service. More...

SmartIF< IDataManagerSvc > &	dataManager () const
	Get Data Manager service. More...

Additional Inherited Members
Public Types inherited from Converter
using	Factory = Gaudi::PluginService::Factory< IConverter (ISvcLocator )>

Public Types inherited from implements< IConverter >
using	base_class = implements< Interfaces... >
	Typedef to this class. More...

using	extend_interfaces_base = extend_interfaces< Interfaces... >
	Typedef to the base of this class. More...

using	iids = typename extend_interfaces_base::ext_iids

Public Types inherited from extend_interfaces< Interfaces... >
using	ext_iids = typename Gaudi::interface_list_cat< typename Interfaces::ext_iids... >::type
	take union of the ext_iids of all Interfaces... More...

Protected Attributes inherited from RootHistCnv::RNTupleCnv
SmartIF< INTupleSvc >	m_ntupleSvc
	Reference to N tuple service. More...

Protected Attributes inherited from implements< IConverter >
std::atomic_ulong	m_refCount
	Reference counter More...

Detailed Description

Converter of Column-wise NTuple into ROOT format

Author: Charles Leggett

Definition at line 30 of file RCWNTupleCnv.h.

Constructor & Destructor Documentation

◆ RCWNTupleCnv()

RootHistCnv::RCWNTupleCnv::RCWNTupleCnv ( ISvcLocator * svc )

inline

Standard constructor.

Definition at line 35 of file RCWNTupleCnv.h.

35 : RNTupleCnv( svc, classID() ) {}

Member Function Documentation

◆ book()

StatusCode RootHistCnv::RCWNTupleCnv::book	(	const std::string &	desc,
		INTuple *	pObject,
		TTree *&	tree
	)

overrideprotectedvirtual

Book the N tuple.

Implements RootHistCnv::RNTupleCnv.

Definition at line 137 of file RCWNTupleCnv.cpp.

 {
   MsgStream log( msgSvc(), "RCWNTupleCnv" );
   rtree = new TTree( desc.c_str(), nt->title().c_str() );
   log << MSG::VERBOSE << "created tree id: " << rtree->GetName() << "  title: " << nt->title() << " desc: " << desc
       << endmsg;
  
   // Loop over the items
  
   std::string              block_name, var_name;
   long                     lowerRange, upperRange;
   long                     size = 0;
   long                     cursize, oldsize = 0;
   std::vector<std::string> item_fullname;
   //    std::vector<long> item_size,item_size2;
   std::vector<long>                                item_buf_pos, item_buf_len, item_buf_end;
   std::vector<long>                                item_range_lower, item_range_upper;
   std::vector<std::pair<std::string, std::string>> item_name;
  
   for ( const auto& i : nt->items() ) {
     std::string item;
  
     visit( *i, [&]( const auto& data ) {
       analyzeItem( this->rootVarType( data.type() ), &data, item, block_name, var_name, lowerRange, upperRange, size );
     } );
  
     item_name.emplace_back( block_name, item );
     cursize = size - oldsize;
  
     log << MSG::VERBOSE << "item: " << item << " type " << i->type() << " blk: " << block_name << " var: " << var_name
         << " rng: " << lowerRange << " " << upperRange << " sz: " << size << " " << cursize
         << " buf_pos: " << size - cursize << endmsg;
  
     item_fullname.push_back( var_name );
     item_buf_pos.push_back( size - cursize );
     item_buf_len.push_back( cursize );
     item_buf_end.push_back( size );
     item_range_lower.push_back( lowerRange );
     item_range_upper.push_back( upperRange );
  
     oldsize = size;
   }
  
   // Make a new buffer, and tell the ntuple where it is
   char* buff = nt->setBuffer( new char[size] );
  
   log << MSG::VERBOSE << "Created buffer size: " << size << " at " << (void*)buff << endmsg;
  
   // Zero out the buffer to make ROOT happy
   std::fill_n( buff, size, 0 );
  
   char* buf_pos = buff;
  
   auto end = item_name.cend();
  
   // Loop over items, creating a new branch for each one;
   unsigned int i_item = 0;
   for ( auto itr = item_name.cbegin(); itr != end; ++itr, ++i_item ) {
  
     buf_pos = buff + item_buf_pos[i_item];
  
     //      log << MSG::WARNING << "adding TBranch " << i_item << "  "
     //      << item_fullname[i_item]
     //      << "  format: " << itr->second.c_str() << "  at "
     //      << (void*) buf_pos << " (" << (void*) buff << "+"
     //      << (void*)item_buf_pos[i_item] << ")"
     //      << endmsg;
  
 #if ROOT_VERSION_CODE >= ROOT_VERSION( 5, 15, 0 )
     auto br = new TBranch( rtree,
 #else
     TBranch* br = new TBranch(
 #endif
                            item_fullname[i_item].c_str(), buf_pos, itr->second.c_str() );
  
     if ( itr->first != "AUTO_BLK" ) {
       std::string title = itr->first;
       title             = itr->first + "::" + br->GetTitle();
       br->SetTitle( title.c_str() );
     }
  
     log << MSG::DEBUG << "adding TBranch  " << br->GetTitle() << "  at " << (void*)buf_pos << endmsg;
  
     // for index items with a limited range. Must be a TLeafI!
     if ( item_range_lower[i_item] < item_range_upper[i_item] ) {
       //        log << MSG::VERBOSE << "\"" << item_fullname[i_item]
       //      << "\" is range limited " << item_range_lower[i_item] << "  "
       //      << item_range_upper[i_item] << endmsg;
       TLeafI*  index = nullptr;
       TObject* tobj  = br->GetListOfLeaves()->FindObject( item_fullname[i_item].c_str() );
       if ( tobj->IsA()->InheritsFrom( "TLeafI" ) ) {
         index = dynamic_cast<TLeafI*>( tobj );
  
         if ( index ) {
           index->SetMaximum( item_range_upper[i_item] );
           // FIXME -- add for next version of ROOT
           // index->SetMinimum( item_range_lower[i_item] );
         } else {
           log << MSG::ERROR << "Could dynamic cast to TLeafI: " << item_fullname[i_item] << endmsg;
         }
       }
     }
  
     rtree->GetListOfBranches()->Add( br );
   }
  
   log << MSG::INFO << "Booked TTree with ID: " << desc << " \"" << nt->title() << "\" in directory " << getDirectory()
       << endmsg;
  
   return StatusCode::SUCCESS;
 }

◆ classID()

static const CLID& RootHistCnv::RCWNTupleCnv::classID ( )

inlinestatic

Inquire class type.

Definition at line 33 of file RCWNTupleCnv.h.

33 { return CLID_ColumnWiseTuple; }

◆ load()

StatusCode RootHistCnv::RCWNTupleCnv::load	(	TTree *	tree,
		INTuple *&	refpObject
	)

overrideprotectedvirtual

Create the transient representation of an object.

Implements RootHistCnv::RNTupleCnv.

Definition at line 292 of file RCWNTupleCnv.cpp.

 {
   MsgStream log( msgSvc(), "RCWNTupleCnv::load" );
  
   StatusCode status;
  
   NTuple::Tuple* pObj = nullptr;
  
   std::string title = tree->GetTitle();
   log << MSG::VERBOSE << "loading CWNT " << title << " at: " << tree << endmsg;
  
   status        = m_ntupleSvc->create( CLID_ColumnWiseTuple, title, pObj );
   INTuple* ntup = dynamic_cast<INTuple*>( pObj );
   if ( !ntup ) { log << MSG::ERROR << "cannot dynamic cast to INTuple" << endmsg; }
  
   INTupleItem* item = nullptr;
  
   std::string itemName, indexName, item_type, itemTitle, blockName;
   // long numEnt, numVar;
   long                                size, totsize = 0;
   std::vector<std::pair<TLeaf*, int>> itemList;
  
   // numEnt = (int)tree->GetEntries();
   // numVar = tree->GetNbranches();
  
   // loop over all branches (==leaves)
   TObjArray* lbr = tree->GetListOfBranches();
   TIter      bitr( lbr );
   while ( TObject* tobjb = bitr() ) {
  
     TBranch* br = (TBranch*)tobjb;
     itemTitle   = br->GetTitle();
  
     int ipos = itemTitle.find( "::" );
     if ( ipos >= 0 ) {
       blockName = itemTitle.substr( 0, ipos );
     } else {
       blockName = "";
     }
  
     TObjArray* lf = br->GetListOfLeaves();
  
     TIter litr( lf );
     while ( TObject* tobj = litr() ) {
  
       bool hasRange   = false;
       int  indexRange = 0;
       int  itemSize;
       item = nullptr;
  
       //      TLeaf* tl = (TLeaf*)tobj;
       TLeaf* tl = dynamic_cast<TLeaf*>( tobj );
       if ( tl ) {
         itemName = tl->GetName();
       } else {
         log << MSG::ERROR << "cannot dynamic cast to TLeaf" << endmsg;
       }
  
       //    char* buf_pos = (char*)tl->GetValuePointer();
       //    cout << " " << itemName << "  " << blockName << "  "
       //         << (void*)buf_pos;
  
       if ( blockName != "" ) {
         log << MSG::DEBUG << "loading NTuple item " << blockName << "/" << itemName;
       } else {
         log << MSG::DEBUG << "loading NTuple item " << itemName;
       }
  
       int    arraySize{ 0 };
       TLeaf* indexLeaf = ( tl ? tl->GetLeafCounter( arraySize ) : nullptr );
  
       if ( arraySize == 0 ) { log << MSG::ERROR << "TLeaf counter size = 0. This should not happen!" << endmsg; }
  
       if ( indexLeaf ) {
         // index Arrays and Matrices
  
         indexName = indexLeaf->GetName();
         //    indexRange = tl->GetNdata();
         indexRange = indexLeaf->GetMaximum();
         itemSize   = indexRange * tl->GetLenType() * arraySize;
  
         log << "[" << indexName;
  
         // Just for Matrices
         if ( arraySize != 1 ) { log << "][" << arraySize; }
         log << "]";
  
       } else {
         itemSize = tl->GetLenType() * arraySize;
  
         indexName = "";
  
         if ( arraySize == 1 ) {
           // Simple items
         } else {
           // Arrays of constant size
           log << "[" << arraySize << "]";
         }
       }
  
       log << endmsg;
  
       //    cout << "  index: " << indexName <<  endl;
  
       //    size = tl->GetNdata() * tl->GetLenType();
       size = itemSize;
       totsize += size;
  
       hasRange = tl->IsRange();
  
       itemList.emplace_back( tl, itemSize );
  
       // Integer
       if ( tobj->IsA()->InheritsFrom( "TLeafI" ) ) {
  
         TLeafI* tli = dynamic_cast<TLeafI*>( tobj );
         if ( tli ) {
           if ( tli->IsUnsigned() ) {
             unsigned long min = 0, max = 0;
             if ( hasRange ) {
               min = tli->GetMinimum();
               max = tli->GetMaximum();
             }
  
             item = createNTupleItem( itemName, blockName, indexName, indexRange, arraySize, min, max, ntup );
           } else {
             long min = 0, max = 0;
             if ( hasRange ) {
               min = tli->GetMinimum();
               max = tli->GetMaximum();
             }
  
             item = createNTupleItem( itemName, blockName, indexName, indexRange, arraySize, min, max, ntup );
           }
         } else {
           log << MSG::ERROR << "cannot dynamic cast to TLeafI" << endmsg;
         }
  
         // Float
       } else if ( tobj->IsA()->InheritsFrom( "TLeafF" ) ) {
         float min = 0., max = 0.;
  
         TLeafF* tlf = dynamic_cast<TLeafF*>( tobj );
         if ( tlf ) {
           if ( hasRange ) {
             min = float( tlf->GetMinimum() );
             max = float( tlf->GetMaximum() );
           }
         } else {
           log << MSG::ERROR << "cannot dynamic cast to TLeafF" << endmsg;
         }
  
         item = createNTupleItem( itemName, blockName, indexName, indexRange, arraySize, min, max, ntup );
  
         // Double
       } else if ( tobj->IsA()->InheritsFrom( "TLeafD" ) ) {
         double min = 0., max = 0.;
  
         TLeafD* tld = dynamic_cast<TLeafD*>( tobj );
         if ( tld ) {
           if ( hasRange ) {
             min = tld->GetMinimum();
             max = tld->GetMaximum();
           }
         } else {
           log << MSG::ERROR << "cannot dynamic cast to TLeafD" << endmsg;
         }
  
         item = createNTupleItem( itemName, blockName, indexName, indexRange, arraySize, min, max, ntup );
  
       } else {
         log << MSG::ERROR << "Uknown data type" << endmsg;
       }
  
       if ( item ) {
         ntup->add( item ).ignore();
       } else {
         log << MSG::ERROR << "Unable to create ntuple item \"" << itemName << "\"" << endmsg;
       }
  
     } // end litr
   }   // end bitr
  
   log << MSG::DEBUG << "Total buffer size of NTuple: " << totsize << " Bytes." << endmsg;
  
   char* buf    = ntup->setBuffer( new char[totsize] );
   char* bufpos = buf;
  
   int ts = 0;
   for ( const auto& iitr : itemList ) {
     TLeaf* leaf  = iitr.first;
     int    isize = iitr.second;
  
     log << MSG::VERBOSE << "setting TBranch " << leaf->GetBranch()->GetName() << " buffer at " << (void*)bufpos
         << endmsg;
  
     leaf->GetBranch()->SetAddress( (void*)bufpos );
  
     //        //testing
     //        if (leaf->IsA()->InheritsFrom("TLeafI")) {
     //      for (int ievt=0; ievt<5; ievt++) {
     //        leaf->GetBranch()->GetEvent(ievt);
     //        int *idat = (int*)bufpos;
     //        log << MSG::WARNING << leaf->GetName() << ": " << ievt << "   "
     //            << *idat << endmsg;
  
     //      }
     //        }
  
     ts += isize;
  
     bufpos += isize;
   }
  
   if ( totsize != ts ) { log << MSG::ERROR << "buffer size mismatch: " << ts << "  " << totsize << endmsg; }
  
   refpObject = ntup;
  
   return StatusCode::SUCCESS;
 }

◆ readData()

StatusCode RootHistCnv::RCWNTupleCnv::readData	(	TTree *	rtree,
		INTuple *	pObject,
		long	ievt
	)

overrideprotectedvirtual

Read N tuple data.

Implements RootHistCnv::RNTupleCnv.

Definition at line 268 of file RCWNTupleCnv.cpp.

 {
   if ( ievt >= rtree->GetEntries() ) {
     MsgStream log( msgSvc(), "RCWNTupleCnv::readData" );
     log << MSG::ERROR << "no more entries in tree to read. max: " << rtree->GetEntries() << "  current: " << ievt
         << endmsg;
     return StatusCode::FAILURE;
   }
  
   rtree->GetEvent( ievt );
   ievt++;
  
   // copy data from ntup->buffer() to ntup->items()->buffer()
   auto& items = ntup->items();
   std::accumulate( begin( items ), end( items ), const_cast<const char*>( ntup->buffer() ),
                    []( const char* src, INTupleItem* i ) {
                      return src + visit( *i, [src]( auto& item ) { return loadItem( src, item ); } );
                    } );
  
   return StatusCode::SUCCESS;
 }

◆ writeData()

StatusCode RootHistCnv::RCWNTupleCnv::writeData	(	TTree *	rtree,
		INTuple *	pObject
	)

overrideprotectedvirtual

Write N tuple data.

Implements RootHistCnv::RNTupleCnv.

Definition at line 253 of file RCWNTupleCnv.cpp.

 {
   // Fill the tree;
   const auto& items = nt->items();
   std::accumulate( begin( items ), end( items ), nt->buffer(), []( char* dest, const INTupleItem* i ) {
     return dest + visit( *i, [dest]( const auto& item ) { return saveItem( dest, item ); } );
   } );
  
   rtree->Fill();
   nt->reset();
   return StatusCode::SUCCESS;
 }

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

RootHistCnv/src/RCWNTupleCnv.h
RootHistCnv/src/RCWNTupleCnv.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RCWNTupleCnv()

Member Function Documentation

◆ book()

◆ classID()

◆ load()

◆ readData()

◆ writeData()