GaudiTuples< PBASE > Class Template Reference

Templated base class providing common 'ntupling' methods. More...

#include <GaudiAlg/GaudiTuples.h>

Inheritance diagram for GaudiTuples< PBASE >:

Collaboration diagram for GaudiTuples< PBASE >:

Classes
struct	id_t
struct	nTupleMapItem
struct	order_t
struct	title_t

Public Types
typedef GaudiAlg::HistoID	HistoID
	the actual type for histogram identifier More...
typedef Tuples::Tuple	Tuple
	the actual type of the tuple More...
typedef GaudiAlg::TupleID	TupleID
	the actual type of N-tuple ID More...

Public Member Functions
Tuple	nTuple (const std::string &title, const CLID &clid=CLID_ColumnWiseTuple) const
	Access an N-Tuple object (book on-demand) with unique identifier. More...
Tuple	nTuple (const TupleID &ID, const std::string &title, const CLID &clid=CLID_ColumnWiseTuple) const
	Access an N-Tuple object (book on-demand) with forced identifier. More...
Tuple	evtCol (const std::string &title, const CLID &clid=CLID_ColumnWiseTuple) const
	Access an Event Tag Collection object (book on-demand) with unique identifier. More...
Tuple	evtCol (const TupleID &ID, const std::string &title, const CLID &clid=CLID_ColumnWiseTuple) const
	Access an Event Tag Collection object (book on-demand) with forced identifier. More...
bool	produceNTuples () const
	get the flag for N-Tuple production (property "NTupleProduce") More...
bool	splitNTupleDir () const
	get the flag for N-Tuple path split (property "NTupleSplitDir") More...
const std::string &	nTupleLUN () const
	get the logical unit for N-Tuples (property "NTupleLUN") More...
const std::string &	nTupleTopDir () const
	get the top-level N-Tuple directory (property "NTupleTopDir") More...
const std::string &	nTupleDir () const
	get the N-Tuple directory (property "NTupleDir") More...
TupleID::NumericID	nTupleOffSet () const
	get the value for N-Tuple offset (property "NTupleOffSet") More...
std::string	nTuplePath () const
	get the constructed N-Tuple path More...
bool	produceEvtCols () const
	get the flag for Event Tag Collection production (property "EvtColsProduce") More...
bool	splitEvtColDir () const
	get the flag for Event Tag Collection path split (property "EvtColsSplitDir") More...
const std::string &	evtColLUN () const
	get the logical unit for Event Tag Collections (property "EvtColsLUN") More...
const std::string &	evtColTopDir () const
	get the top-level Event Tag Collection directory (property "EvtColsTopDir") More...
const std::string &	evtColDir () const
	get the Event Tag Collection directory (property "EvtColsDir") More...
TupleID::NumericID	evtColOffSet () const
	get the value for Event Tag Collection offset (property "EvtColsOffSet") More...
std::string	evtColPath () const
	get the constructed Event Tag Collection path More...
bool	tuplesPrint () const
	print tuples at finalization More...
bool	evtColsPrint () const
	print event collections at finalization More...
long	printTuples () const
	perform the actual printout of N-tuples More...
long	printEvtCols () const
	perform the actual printout of Event Tag Collections More...
bool	nTupleExists (const TupleID &ID) const
	check the existence AND validity of the N-Tuple with the given ID More...
bool	evtColExists (const TupleID &ID) const
	check the existence AND validity of the Event Tag Collection with the given ID More...
template<typename U = PBASE, typename = std::enable_if_t<std::is_base_of_v<GaudiHistoAlg, PBASE>, U>>
	GaudiTuples (const std::string &name, ISvcLocator *pSvcLocator)
	Algorithm constructor - the SFINAE constraint below ensures that this is constructor is only defined if PBASE derives from GaudiHistoAlg. More...
template<typename U = PBASE, typename = std::enable_if_t<std::is_base_of_v<GaudiHistoTool, PBASE>, U>>
	GaudiTuples (const std::string &type, const std::string &name, const IInterface *parent)
	Tool constructor - SFINAE-ed to insure this constructor is only defined if PBASE derives from AlgTool. More...

Protected Member Functions
virtual std::unique_ptr< Tuples::TupleObj >	createNTuple (const std::string &name, NTuple::Tuple *tuple, const CLID &clid) const
	create TupleObj More...
virtual std::unique_ptr< Tuples::TupleObj >	createEvtCol (const std::string &name, NTuple::Tuple *tuple, const CLID &clid) const
	create TupleObj for event tag collection More...
StatusCode	initialize () override
	standard initialization method More...
StatusCode	finalize () override
	standard finalization method More...

Private Types
template<typename... Ts>
using	indexed_by = boost::multi_index::indexed_by< Ts... >
template<typename... Ts>
using	hashed_unique = boost::multi_index::hashed_unique< Ts... >
template<typename... Ts>
using	ordered_unique = boost::multi_index::ordered_unique< Ts... >
template<typename Obj , typename Type , Type Obj::* Member>
using	member = boost::multi_index::member< Obj, Type, Member >
template<typename T >
using	tag = boost::multi_index::tag< T >
using	nTupleMap = boost::multi_index_container< nTupleMapItem, indexed_by< hashed_unique< tag< title_t >, member< nTupleMapItem, std::string, &nTupleMapItem::title > >, hashed_unique< tag< id_t >, member< nTupleMapItem, TupleID, &nTupleMapItem::id > >, ordered_unique< tag< order_t >, member< nTupleMapItem, TupleID, &nTupleMapItem::id > >> >

Private Attributes
Gaudi::Property< bool >	m_produceNTuples {this, "NTupleProduce", true, "general switch to enable/disable N-tuples"}
Gaudi::Property< bool >	m_tuplesPrint
Gaudi::Property< bool >	m_splitNTupleDir
Gaudi::Property< TupleID::NumericID >	m_nTupleOffSet {this, "NTupleOffSet", 0, "offset for numerical N-tuple ID"}
Gaudi::Property< std::string >	m_nTupleLUN {this, "NTupleLUN", "FILE1", "Logical File Unit for N-tuples"}
Gaudi::Property< std::string >	m_nTupleTopDir {this, "NTupleTopDir", "", "top-level directory for N-Tuples"}
Gaudi::Property< std::string >	m_nTupleDir
Gaudi::Property< bool >	m_produceEvtCols
Gaudi::Property< bool >	m_evtColsPrint
Gaudi::Property< bool >	m_splitEvtColDir {this, "EvtColSplitDir", false, "split long directory names into short pieces"}
Gaudi::Property< TupleID::NumericID >	m_evtColOffSet {this, "EvtColOffSet", 0, "offset for numerical N-tuple ID"}
Gaudi::Property< std::string >	m_evtColLUN {this, "EvtColLUN", "EVTCOL", "Logical File Unit for Event Tag Collections"}
Gaudi::Property< std::string >	m_evtColTopDir
Gaudi::Property< std::string >	m_evtColDir
nTupleMap	m_nTupleMap
	the actual storage of ntuples by title and ID More...
nTupleMap	m_evtColMap
	the actual storage of event collections by title and ID More...

Detailed Description

template<class PBASE>
class GaudiTuples< PBASE >

Templated base class providing common 'ntupling' methods.

Author

Chris Jones Chris.nosp@m.toph.nosp@m.er.Ro.nosp@m.b.Jo.nosp@m.nes@c.nosp@m.ern..nosp@m.ch

Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@i.nosp@m.tep..nosp@m.ru

Date

2005-08-08

Definition at line 53 of file GaudiTuples.h.

Member Typedef Documentation

hashed_unique

template<class PBASE>

template<typename... Ts>

using GaudiTuples< PBASE >::hashed_unique = boost::multi_index::hashed_unique<Ts...>

private

Definition at line 367 of file GaudiTuples.h.

HistoID

template<class PBASE>

typedef GaudiAlg::HistoID GaudiTuples< PBASE >::HistoID

the actual type for histogram identifier

Definition at line 57 of file GaudiTuples.h.

indexed_by

template<class PBASE>

template<typename... Ts>

using GaudiTuples< PBASE >::indexed_by = boost::multi_index::indexed_by<Ts...>

private

Definition at line 365 of file GaudiTuples.h.

member

template<class PBASE>

template<typename Obj , typename Type , Type Obj::* Member>

using GaudiTuples< PBASE >::member = boost::multi_index::member<Obj, Type, Member>

private

Definition at line 371 of file GaudiTuples.h.

nTupleMap

template<class PBASE>

using GaudiTuples< PBASE >::nTupleMap = boost::multi_index_container< nTupleMapItem, indexed_by<hashed_unique<tag<title_t>, member<nTupleMapItem, std::string, &nTupleMapItem::title> >, hashed_unique<tag<id_t>, member<nTupleMapItem, TupleID, &nTupleMapItem::id> >, ordered_unique<tag<order_t>, member<nTupleMapItem, TupleID, &nTupleMapItem::id> >> >

private

Definition at line 377 of file GaudiTuples.h.

ordered_unique

template<class PBASE>

template<typename... Ts>

using GaudiTuples< PBASE >::ordered_unique = boost::multi_index::ordered_unique<Ts...>

private

Definition at line 369 of file GaudiTuples.h.

tag

template<class PBASE>

template<typename T >

using GaudiTuples< PBASE >::tag = boost::multi_index::tag<T>

private

Definition at line 373 of file GaudiTuples.h.

Tuple

template<class PBASE>

typedef Tuples::Tuple GaudiTuples< PBASE >::Tuple

the actual type of the tuple

Definition at line 59 of file GaudiTuples.h.

TupleID

template<class PBASE>

typedef GaudiAlg::TupleID GaudiTuples< PBASE >::TupleID

the actual type of N-tuple ID

Definition at line 61 of file GaudiTuples.h.

Constructor & Destructor Documentation

GaudiTuples() [1/2]

template<class PBASE>

template<typename U = PBASE, typename = std::enable_if_t<std::is_base_of_v<GaudiHistoAlg, PBASE>, U>>

GaudiTuples< PBASE >::GaudiTuples ( const std::string &  name, ISvcLocator *  pSvcLocator  )

inline

Algorithm constructor - the SFINAE constraint below ensures that this is constructor is only defined if PBASE derives from GaudiHistoAlg.

Definition at line 287 of file GaudiTuples.h.

: PBASE( name, pSvcLocator ) {}

GaudiTuples() [2/2]

template<class PBASE>

template<typename U = PBASE, typename = std::enable_if_t<std::is_base_of_v<GaudiHistoTool, PBASE>, U>>

GaudiTuples< PBASE >::GaudiTuples ( const std::string &  type, const std::string &  name, const IInterface *  parent  )

inline

Tool constructor - SFINAE-ed to insure this constructor is only defined if PBASE derives from AlgTool.

Definition at line 291 of file GaudiTuples.h.

      : PBASE( type, name, parent ) {}

Member Function Documentation

createEvtCol()

template<class PBASE >

std::unique_ptr< Tuples::TupleObj > GaudiTuples< PBASE >::createEvtCol ( const std::string &  name, NTuple::Tuple *  tuple, const CLID &  clid  ) const

protectedvirtual

create TupleObj for event tag collection

Attention

The method should never used directly by users

Parameters

name	name/title
tuple	the underlying ntuple implementation
clid	unique classID for ntuple

Returns

pointer to newly created TupelObj

Definition at line 291 of file GaudiTuples.icpp.

                                                                                             {
  return Tuples::createTupleObj( this, "EvtCol '" + name + "'", tuple, clid, Tuples::EVTCOL );
}

createNTuple()

template<class PBASE >

std::unique_ptr< Tuples::TupleObj > GaudiTuples< PBASE >::createNTuple ( const std::string &  name, NTuple::Tuple *  tuple, const CLID &  clid  ) const

protectedvirtual

create TupleObj

Attention

The method should never used directly by users

Parameters

name	name/title
tuple	the underlying ntuple implementation
clid	unique classID for ntuple

Returns

pointer to newly created TupleObj

Definition at line 281 of file GaudiTuples.icpp.

                                                                                             {
  return Tuples::createTupleObj( this, "Tuple '" + name + "'", tuple, clid, Tuples::NTUPLE );
}

evtCol() [1/2]

template<class PBASE >

Tuples::Tuple GaudiTuples< PBASE >::evtCol	(	const std::string &	title,
		const CLID &	clid = CLID_ColumnWiseTuple
	)		const

Access an Event Tag Collection object (book on-demand) with unique identifier.

Tuple tuple = evtCol( "My Tag Collection" ) ;
tuple->column( "A" , sin(0.1) );
tuple->column( "B" , cos(0.1) );
tuple->column( "C" , tan(0.1) );
tuple->write();

The Event Tag Collection will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first Event Tag Collection booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given Event Tag Collection will be given when filled under conditional statements, since in these circumstances the order in which the Event Tag Collection are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given Event Tag Collection could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

Parameters

title	Unique title for Event Tag Collection
clid	N-Tuple class identifier (row or column wise)

Returns

ntuple The Event Tag Collection object

Definition at line 150 of file GaudiTuples.icpp.

                                                                                       {
  // look up in the table
  auto& m     = evtColByTitle();
  auto  tuple = m.find( title );
  if ( tuple != m.end() ) return Tuple( tuple->tuple ); // RETURN
  // Create the tuple ID
  TupleID ID;
  if ( this->useNumericAutoIDs() || title.empty() ) {
    if ( !this->useNumericAutoIDs() ) {
      this->Warning(
              "Cannot generate automatic literal ID from an empty title ! Using numeric ID instead for evtCol ID",
              StatusCode::SUCCESS )
          .ignore();
    }
    // proposed the tuple ID
    ID = TupleID( m_evtColMap.size() + 1 + evtColOffSet() );
    // adjust the proposed ID
    while ( nTupleExists( ID ) || evtColExists( ID ) ) { ID = TupleID( ID.numeric() + 1 ); }
  } else {
    // use the title to create a unique literal ID
    ID = TupleID( this->convertTitleToID( title ) );
    // Just in case ...
    while ( nTupleExists( ID ) || evtColExists( ID ) ) { ID = TupleID( ID.idAsString() + "_" ); }
  }
  // return
  return evtCol( ID, title, clid );
}

evtCol() [2/2]

template<class PBASE >

Tuples::Tuple GaudiTuples< PBASE >::evtCol	(	const TupleID &	ID,
		const std::string &	title,
		const CLID &	clid = CLID_ColumnWiseTuple
	)		const

Access an Event Tag Collection object (book on-demand) with forced identifier.

// Book Ntuple with a numeric ID
Tuple tuple = evtCol(  1,  "My Tag Collection" ) ;
// ... or
Tuple tuple = evtCol( "1", "My Tag Collection" ) ;

// ... or, Book Ntuple with a literal ID
Tuple tuple = evtCol( "mytuple", "My Tag Collection" ) ;

// ... or, Book Ntuple with a literal ID in a sub-dir
Tuple tuple = evtCol( "subdir/mytuple", "My Tag Collection" ) ;

// Fill and write
tuple->column( "A" , sin(0.1) );
tuple->column( "B" , cos(0.1) );
tuple->column( "C" , tan(0.1) );
tuple->write();

Attention

If the Event Tag Collection with given ID is already booked through automatic assignment of Event Tag Collection ID, the error will not be detected. Therefore it is recommended to use a non-trivial Event Tag Collection ID offset (property "EvtColOffSet") if one need to combine these techniques together It is still desirable to use the unique Event Tag Collection title to avoid a bad interference.

Parameters

ID	The forced Event Tag Collection ID
title	Unique title for Event Tag Collection
clid	N-Tuple class identifier (row or column wise)

Returns

ntuple The Event Tag Collection object

Definition at line 232 of file GaudiTuples.icpp.

                                                                                                           {
  // Check ID
  if ( ID.undefined() ) {
    this->Error( "Undefined NTuple ID : Title='" + title1 + "'" ).ignore();
    return Tuple( 0 );
  }

  // look up in the table
  auto& tuple = evtColByID();
  auto  i     = tuple.find( ID );
  if ( i != tuple.end() ) return Tuple( i->tuple ); // RETURN

  // convert ID to the string
  const std::string tID = ID.idAsString();

  // adjust the NTuple title
  const std::string title = title1.empty() ? ( "EvtCol #" + tID ) : title1;

  // book new ntuple
  if ( !produceEvtCols() ) {
    auto r = m_evtColMap.insert( nTupleMapItem{title, ID, createEvtCol( title, nullptr, clid )} );
    if ( !r.second ) this->Error( "Failure to createEvtCol" ).ignore();
    return Tuple( r.first->tuple );
  }
  // book NTuple
  NTuple::Tuple* tup = nullptr;
  if ( ID.numeric() ) {
    tup = this->evtColSvc()->book( evtColPath(), ID.numericID(), clid, title );
  } else if ( ID.literal() ) {
    tup = this->evtColSvc()->book( evtColPath(), ID.literalID(), clid, title );
  } else {
    this->Error( "Undefined NTuple ID" ).ignore();
  }

  // assertion
  this->Assert( tup, "Could not book the EvtCol='" + title + "'" );
  // some printout
  if ( tup->registry() && this->msgLevel( MSG::DEBUG ) ) {
    this->debug() << "Booked EvtCol '" << title << "' ID=" << tID << "' Path='" << evtColPath() << "' TS='"
                  << tup->registry()->identifier() << "'" << endmsg;
  }
  auto r = m_evtColMap.insert( nTupleMapItem{title, ID, createEvtCol( title, tup, clid )} );
  if ( !r.second ) this->Error( "Failure to createEvtCol" ).ignore();
  return Tuple( r.first->tuple );
}

evtColDir()

template<class PBASE>

const std::string& GaudiTuples< PBASE >::evtColDir ( ) const

inline

get the Event Tag Collection directory (property "EvtColsDir")

Definition at line 235 of file GaudiTuples.h.

{ return m_evtColDir; }

evtColExists()

template<class PBASE >

bool GaudiTuples< PBASE >::evtColExists

(

const TupleID &

ID

)

const

check the existence AND validity of the Event Tag Collection with the given ID

Definition at line 352 of file GaudiTuples.icpp.

                                                               {
  auto& m = evtColByID();
  return m.find( ID ) != m.end();
}

evtColLUN()

template<class PBASE>

const std::string& GaudiTuples< PBASE >::evtColLUN ( ) const

inline

get the logical unit for Event Tag Collections (property "EvtColsLUN")

Definition at line 231 of file GaudiTuples.h.

{ return m_evtColLUN; }

evtColOffSet()

template<class PBASE>

TupleID::NumericID GaudiTuples< PBASE >::evtColOffSet ( ) const

inline

get the value for Event Tag Collection offset (property "EvtColsOffSet")

Definition at line 237 of file GaudiTuples.h.

{ return m_evtColOffSet; }

evtColPath()

template<class PBASE >

std::string GaudiTuples< PBASE >::evtColPath

(

)

const

get the constructed Event Tag Collection path

Definition at line 368 of file GaudiTuples.icpp.

                                               {
  std::string path = evtColLUN() + "/" + evtColTopDir() + evtColDir();
  return splitEvtColDir() ? dirHbookName( path ) : path;
}

evtColsPrint()

template<class PBASE>

bool GaudiTuples< PBASE >::evtColsPrint ( ) const

inline

print event collections at finalization

Definition at line 243 of file GaudiTuples.h.

{ return m_evtColsPrint; }

evtColTopDir()

template<class PBASE>

const std::string& GaudiTuples< PBASE >::evtColTopDir ( ) const

inline

get the top-level Event Tag Collection directory (property "EvtColsTopDir")

Definition at line 233 of file GaudiTuples.h.

{ return m_evtColTopDir; }

finalize()

template<class PBASE >

StatusCode GaudiTuples< PBASE >::finalize ( )

overrideprotected

standard finalization method

Returns

status code

Definition at line 93 of file GaudiTuples.icpp.

       {
  if ( !( m_nTupleMap.empty() && m_evtColMap.empty() ) ) {
    const int nNtuples = m_nTupleMap.size();
    const int nEvtCols = m_evtColMap.size();
    this->always() << "Booked " << nNtuples << " N-Tuples and " << nEvtCols << " Event Tag Collections" << endmsg;
  }

  if ( produceNTuples() && tuplesPrint() ) printTuples();
  if ( produceEvtCols() && evtColsPrint() ) printEvtCols();

  // release ntuples and clear the container
  m_nTupleMap.clear();

  // release ntuples and clear the container
  m_evtColMap.clear();

  // finalize base class
  return PBASE::finalize();
}

initialize()

template<class PBASE >

StatusCode GaudiTuples< PBASE >::initialize ( )

overrideprotected

standard initialization method

Returns

status code

Definition at line 53 of file GaudiTuples.icpp.

       {
  // initialize base class
  const StatusCode sc = PBASE::initialize();
  if ( sc.isFailure() ) return sc;

  if ( produceNTuples() ) {
    // check the existance of service
    if ( this->ntupleSvc() == 0 ) { return this->Error( "INTupleSvc* points to NULL!" ); }
    // Print ntuple path
    this->Print( "The N-Tuple   path is set to be '" + nTuplePath() + "'", StatusCode( StatusCode::SUCCESS, true ),
                 MSG::DEBUG )
        .ignore();
  } else {
    this->debug() << "Production of N-Tuples is switched OFF" << endmsg;
  }

  if ( produceEvtCols() ) {
    // check the existance of service
    if ( 0 == this->evtColSvc() ) { return this->Error( "INTupleSvc* points to NULL!" ); }
    // Print EvtCol path
    this->Print( "The EventCol  path is set to be '" + evtColPath() + "'", StatusCode( StatusCode::SUCCESS, true ),
                 MSG::DEBUG )
        .ignore();
  } else {
    this->debug() << "Production of Event Collections is switched OFF" << endmsg;
  }

  return sc;
}

nTuple() [1/2]

template<class PBASE >

Tuples::Tuple GaudiTuples< PBASE >::nTuple	(	const std::string &	title,
		const CLID &	clid = CLID_ColumnWiseTuple
	)		const

Access an N-Tuple object (book on-demand) with unique identifier.

Tuple tuple = nTuple( "My N-Tuple" ) ;
tuple->column( "A" , sin(0.1) );
tuple->column( "B" , cos(0.1) );
tuple->column( "C" , tan(0.1) );
tuple->write();

Attention

The NTuple will get a unique identifier automatically assigned which by default will be equal to the histogram title. An option exists to instead use numerical IDs. In this case the first NTuple booked will be ID=1 the next ID=2 and so on. Note though this scheme is not recommended as it does NOT guarantee predictability of the ID a given NTuple will be given when filled under conditional statements, since in these circumstances the order in which the NTuple are first filled, and thus booked, will depend on the nature of the first few events read. This is particularly problematic when users submit many parallel 'sub-jobs' and then attempt to merge the final output ROOT (or HBOOK) files, since a given NTuple could have different IDs in each of the sub-jobs. Consequently it is strongly recommended that users do not use numerical automatic IDs unless they are sure they understand what they are doing.

Parameters

title	Unique title for N-Tuple
clid	N-Tuple class identifier (row or column wise)

Returns

ntuple The ntuple object

Definition at line 117 of file GaudiTuples.icpp.

                                                                                       {
  // look up in the table
  auto& m     = nTupleByTitle();
  auto  tuple = m.find( title );
  if ( tuple != m.end() ) return Tuple( tuple->tuple ); // RETURN
  // Create the tuple ID
  TupleID ID;
  if ( this->useNumericAutoIDs() || title.empty() ) {
    if ( !this->useNumericAutoIDs() ) {
      this->Warning(
              "Cannot generate automatic literal ID from an empty title ! Using numeric ID instead for nTuple ID",
              StatusCode::SUCCESS )
          .ignore();
    }
    // propose the tuple ID
    ID = TupleID( m_nTupleMap.size() + 1 + nTupleOffSet() );
    // adjust the proposed ID
    while ( nTupleExists( ID ) || evtColExists( ID ) ) { ID = TupleID( ID.numeric() + 1 ); }
  } else {
    // use the title to create a unique literal ID
    ID = TupleID( this->convertTitleToID( title ) );
    // Just in case ...
    while ( nTupleExists( ID ) || evtColExists( ID ) ) { ID = TupleID( ID.idAsString() + "_" ); }
  }
  // return
  return nTuple( ID, title, clid );
}

nTuple() [2/2]

template<class PBASE >

Tuples::Tuple GaudiTuples< PBASE >::nTuple	(	const TupleID &	ID,
		const std::string &	title,
		const CLID &	clid = CLID_ColumnWiseTuple
	)		const

Access an N-Tuple object (book on-demand) with forced identifier.

// Book Ntuple with a numeric ID
Tuple tuple = nTuple(  1,  "My tuple" ) ;
// ... or
Tuple tuple = nTuple( "1", "My tuple" ) ;

// ... or, Book Ntuple with a literal ID
Tuple tuple = nTuple( "mytuple", "My tuple" ) ;

// ... or, Book Ntuple with a literal ID in a sub-dir
Tuple tuple = nTuple( "subdir/mytuple", "My tuple" ) ;

// Fill and write NTuple
tuple->column( "A" , sin(0.1) );
tuple->column( "B" , cos(0.1) );
tuple->column( "C" , tan(0.1) );
tuple->write();

Attention

If the N-Tuple with given ID is already booked through automatic assignment of N-Tuple ID, the error will not be detected. Therefore it is recommended to use a non-trivial N-Tuple ID offset (property "NTupleOffSet") if one need to combine these techniques together It is still desirable to use the unique N-Tuple title to avoid a bad interference.

Parameters

ID	The forced N-Tuple ID
title	Unique title for N-Tuple
clid	N-Tuple class identifier (row or column wise)

Returns

ntuple The ntuple object

Definition at line 183 of file GaudiTuples.icpp.

                                                                                                           {
  // Check ID
  if ( ID.undefined() ) {
    this->Error( "Undefined NTuple ID : Title='" + title1 + "'" ).ignore();
    return Tuple( 0 );
  }

  // look up in the table
  auto& m     = nTupleByID();
  auto  tuple = m.find( ID );
  if ( tuple != m.end() ) return Tuple( tuple->tuple ); // RETURN

  // convert ID to the string
  const std::string tID = ID.idAsString();

  // adjust the NTuple title
  const std::string title = title1.empty() ? ( "NTuple #" + tID ) : title1;

  // book new ntuple
  if ( !produceNTuples() ) {
    auto r = m_nTupleMap.insert( nTupleMapItem{title, ID, createNTuple( title, nullptr, clid )} );
    if ( !r.second ) this->Error( "Failure to createNTuple" ).ignore();
    return Tuple( r.first->tuple );
  }
  // book NTupel
  NTuple::Tuple* tup = nullptr;
  if ( ID.numeric() ) {
    tup = this->ntupleSvc()->book( nTuplePath(), ID.numericID(), clid, title );
  } else if ( ID.literal() ) {
    tup = this->ntupleSvc()->book( nTuplePath(), ID.literalID(), clid, title );
  } else {
    this->Error( "Undefined NTuple ID" ).ignore();
  }

  // assertion
  this->Assert( tup, "Could not book the N-Tuple='" + title + "'" );
  // some printout
  if ( tup->registry() && this->msgLevel( MSG::DEBUG ) ) {
    this->debug() << "Booked NTuple '" << title << "' ID=" << tID << "' Path='" << nTuplePath() << "' TS='"
                  << tup->registry()->identifier() << "'" << endmsg;
  }

  auto r = m_nTupleMap.insert( nTupleMapItem{title, ID, createNTuple( title, tup, clid )} );
  if ( !r.second ) this->Error( "Failure to createNTuple" ).ignore();
  return Tuple( r.first->tuple );
  //
}

nTupleDir()

template<class PBASE>

const std::string& GaudiTuples< PBASE >::nTupleDir ( ) const

inline

get the N-Tuple directory (property "NTupleDir")

Definition at line 221 of file GaudiTuples.h.

{ return m_nTupleDir; }

nTupleExists()

template<class PBASE >

bool GaudiTuples< PBASE >::nTupleExists

(

const TupleID &

ID

)

const

check the existence AND validity of the N-Tuple with the given ID

Definition at line 344 of file GaudiTuples.icpp.

                                                               {
  auto& m = nTupleByID();
  return m.find( ID ) != m.end();
}

nTupleLUN()

template<class PBASE>

const std::string& GaudiTuples< PBASE >::nTupleLUN ( ) const

inline

get the logical unit for N-Tuples (property "NTupleLUN")

Definition at line 217 of file GaudiTuples.h.

{ return m_nTupleLUN; }

nTupleOffSet()

template<class PBASE>

TupleID::NumericID GaudiTuples< PBASE >::nTupleOffSet ( ) const

inline

get the value for N-Tuple offset (property "NTupleOffSet")

Definition at line 223 of file GaudiTuples.h.

{ return m_nTupleOffSet; }

nTuplePath()

template<class PBASE >

std::string GaudiTuples< PBASE >::nTuplePath

(

)

const

get the constructed N-Tuple path

Definition at line 360 of file GaudiTuples.icpp.

                                               {
  const std::string path = nTupleLUN() + "/" + nTupleTopDir() + nTupleDir();
  return splitNTupleDir() ? dirHbookName( path ) : path;
}

nTupleTopDir()

template<class PBASE>

const std::string& GaudiTuples< PBASE >::nTupleTopDir ( ) const

inline

get the top-level N-Tuple directory (property "NTupleTopDir")

Definition at line 219 of file GaudiTuples.h.

{ return m_nTupleTopDir; }

printEvtCols()

template<class PBASE >

long GaudiTuples< PBASE >::printEvtCols

(

)

const

perform the actual printout of Event Tag Collections

Returns

number of active Event Tag Collections

Definition at line 322 of file GaudiTuples.icpp.

                                            {
  if ( m_evtColMap.empty() ) {
    this->always() << "No Event Tag Collections are booked" << endmsg;
  } else {
    this->always() << "List of booked Event Tag Collections in directory "
                   << "\"" << evtColPath() << "\"" << endmsg;
  }
  for ( const auto& entry : this->evtColOrdered() ) {
    if ( !entry.tuple->tuple() ) {
      this->error() << " NTuple::Tuple* points to NULL" << endmsg;
      continue;
    }
    this->always() << GaudiAlg::PrintTuple::print( entry.tuple->tuple(), entry.id )
                   << " Items:" << Gaudi::Utils::toString( entry.tuple->items() ) << endmsg;
  }
  //
  return this->m_evtColMap.size();
}

printTuples()

template<class PBASE >

long GaudiTuples< PBASE >::printTuples

(

)

const

perform the actual printout of N-tuples

Returns

number of active N-Tuples

Definition at line 299 of file GaudiTuples.icpp.

                                           {

  if ( m_nTupleMap.empty() ) {
    if ( this->msgLevel( MSG::DEBUG ) ) this->debug() << "No N-Tuples   are booked" << endmsg;
  } else {
    this->always() << "List of booked N-Tuples in directory "
                   << "\"" << nTuplePath() << "\"" << endmsg;
  }

  for ( const auto& entry : this->nTupleOrdered() ) {
    if ( !entry.tuple->tuple() ) {
      this->error() << " NTuple::Tuple* points to NULL" << endmsg;
      continue;
    }
    this->always() << GaudiAlg::PrintTuple::print( entry.tuple->tuple(), entry.id ) << endmsg;
  }
  //
  return this->m_nTupleMap.size();
}

produceEvtCols()

template<class PBASE>

bool GaudiTuples< PBASE >::produceEvtCols ( ) const

inline

get the flag for Event Tag Collection production (property "EvtColsProduce")

Definition at line 227 of file GaudiTuples.h.

{ return m_produceEvtCols; }

produceNTuples()

template<class PBASE>

bool GaudiTuples< PBASE >::produceNTuples ( ) const

inline

get the flag for N-Tuple production (property "NTupleProduce")

Definition at line 213 of file GaudiTuples.h.

{ return m_produceNTuples; }

splitEvtColDir()

template<class PBASE>

bool GaudiTuples< PBASE >::splitEvtColDir ( ) const

inline

get the flag for Event Tag Collection path split (property "EvtColsSplitDir")

Definition at line 229 of file GaudiTuples.h.

{ return m_splitEvtColDir; }

splitNTupleDir()

template<class PBASE>

bool GaudiTuples< PBASE >::splitNTupleDir ( ) const

inline

get the flag for N-Tuple path split (property "NTupleSplitDir")

Definition at line 215 of file GaudiTuples.h.

{ return m_splitNTupleDir; }

tuplesPrint()

template<class PBASE>

bool GaudiTuples< PBASE >::tuplesPrint ( ) const

inline

print tuples at finalization

Definition at line 241 of file GaudiTuples.h.

{ return m_tuplesPrint; }

Member Data Documentation

m_evtColDir

template<class PBASE>

Gaudi::Property<std::string> GaudiTuples< PBASE >::m_evtColDir

private

Initial value:

{this, "EvtColDir",
                                           boost::algorithm::replace_all_copy( this->name(), ":", "_" ),
                                           "Subdirectory for Event Tag Collections"}

Definition at line 353 of file GaudiTuples.h.

m_evtColLUN

template<class PBASE>

Gaudi::Property<std::string> GaudiTuples< PBASE >::m_evtColLUN {this, "EvtColLUN", "EVTCOL", "Logical File Unit for Event Tag Collections"}

private

Definition at line 350 of file GaudiTuples.h.

m_evtColMap

template<class PBASE>

nTupleMap GaudiTuples< PBASE >::m_evtColMap

mutableprivate

the actual storage of event collections by title and ID

Definition at line 389 of file GaudiTuples.h.

m_evtColOffSet

template<class PBASE>

Gaudi::Property<TupleID::NumericID> GaudiTuples< PBASE >::m_evtColOffSet {this, "EvtColOffSet", 0, "offset for numerical N-tuple ID"}

private

Definition at line 349 of file GaudiTuples.h.

m_evtColsPrint

template<class PBASE>

Gaudi::Property<bool> GaudiTuples< PBASE >::m_evtColsPrint

private

Initial value:

{this, "EvtColsPrint", false,
                                       [this]( auto& ) {
                                         
                                         if ( this->FSMState() >= Gaudi::StateMachine::INITIALIZED &&
                                              this->evtColsPrint() )
                                           this->printEvtCols();
                                       },
                                       "print statistics for Event Tag Collections "}

Definition at line 340 of file GaudiTuples.h.

m_evtColTopDir

template<class PBASE>

Gaudi::Property<std::string> GaudiTuples< PBASE >::m_evtColTopDir

private

Initial value:

{this, "EvtColTopDir", "",
                                              "Top-level directory for Event Tag Collections"}

Definition at line 351 of file GaudiTuples.h.

m_nTupleDir

template<class PBASE>

Gaudi::Property<std::string> GaudiTuples< PBASE >::m_nTupleDir

private

Initial value:

{
      this, "NTupleDir", boost::algorithm::replace_all_copy( this->name(), ":", "_" ), "subdirectory for N-Tuples"}

Definition at line 335 of file GaudiTuples.h.

m_nTupleLUN

template<class PBASE>

Gaudi::Property<std::string> GaudiTuples< PBASE >::m_nTupleLUN {this, "NTupleLUN", "FILE1", "Logical File Unit for N-tuples"}

private

Definition at line 333 of file GaudiTuples.h.

m_nTupleMap

template<class PBASE>

nTupleMap GaudiTuples< PBASE >::m_nTupleMap

mutableprivate

the actual storage of ntuples by title and ID

Definition at line 381 of file GaudiTuples.h.

m_nTupleOffSet

template<class PBASE>

Gaudi::Property<TupleID::NumericID> GaudiTuples< PBASE >::m_nTupleOffSet {this, "NTupleOffSet", 0, "offset for numerical N-tuple ID"}

private

Definition at line 332 of file GaudiTuples.h.

m_nTupleTopDir

template<class PBASE>

Gaudi::Property<std::string> GaudiTuples< PBASE >::m_nTupleTopDir {this, "NTupleTopDir", "", "top-level directory for N-Tuples"}

private

Definition at line 334 of file GaudiTuples.h.

m_produceEvtCols

template<class PBASE>

Gaudi::Property<bool> GaudiTuples< PBASE >::m_produceEvtCols

private

Initial value:

{this, "EvtColsProduce", false,
                                         "general switch to enable/disable Event Tag Collections"}

Definition at line 338 of file GaudiTuples.h.

m_produceNTuples

template<class PBASE>

Gaudi::Property<bool> GaudiTuples< PBASE >::m_produceNTuples {this, "NTupleProduce", true, "general switch to enable/disable N-tuples"}

private

Definition at line 321 of file GaudiTuples.h.

m_splitEvtColDir

template<class PBASE>

Gaudi::Property<bool> GaudiTuples< PBASE >::m_splitEvtColDir {this, "EvtColSplitDir", false, "split long directory names into short pieces"}

private

Definition at line 348 of file GaudiTuples.h.

m_splitNTupleDir

template<class PBASE>

Gaudi::Property<bool> GaudiTuples< PBASE >::m_splitNTupleDir

private

Initial value:

{this, "NTupleSplitDir", false,
                                         "split long directory names into short pieces (suitable for HBOOK)"}

Definition at line 330 of file GaudiTuples.h.

m_tuplesPrint

template<class PBASE>

Gaudi::Property<bool> GaudiTuples< PBASE >::m_tuplesPrint

private

Initial value:

{this, "NTuplePrint", true,
                                      [this]( auto& ) {
                                        
                                        if ( this->FSMState() >= Gaudi::StateMachine::INITIALIZED &&
                                             this->tuplesPrint() )
                                          this->printTuples();
                                      },
                                      "print N-tuple statistics"}

Definition at line 322 of file GaudiTuples.h.

---

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

• GaudiAlg/GaudiAlg/GaudiTuples.h
• GaudiAlg/GaudiAlg/GaudiTuples.icpp