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 >:

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...
typedef GaudiAlg::TupleMapTitle	TupleMapTitle
	the actual type of (title) -> (tuple) mappping More...
typedef GaudiAlg::TupleMapID	TupleMapID
	the actual type of (Numeric ID) -> (tuple) mappping 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, class = typename std::enable_if<std::is_base_of<GaudiHistoAlg, PBASE>::value, U>::type>
	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, class = typename std::enable_if<std::is_base_of<GaudiHistoTool, PBASE>::value, U>::type>
	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...
	~GaudiTuples () override=default
	Destructor. More...

Protected Member Functions
const TupleMapTitle &	nTupleMapTitle () const
	access to the all ntuples by title More...
const TupleMapTitle &	evtColMapTitle () const
	access to the all evet tag collections by title More...
const TupleMapID &	nTupleMapID () const
	access to the all ntuples by numeric ID More...
const TupleMapID &	evtColMapID () const
	access to the all evet tag collections by numeric ID More...
virtual Tuples::TupleObj *	createNTuple (const std::string &name, NTuple::Tuple *tuple, const CLID &clid) const
	create TupleObj More...
virtual 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 Member Functions
void	initGaudiTuplesConstructor ()
	Constructor initialization and job options. More...
void	printNTupleHandler (Gaudi::Details::PropertyBase &)
	handler for "NTuplePrint" property More...
void	printEvtColHandler (Gaudi::Details::PropertyBase &)
	handler for "EvtColsPrint" property More...

Private Attributes
Gaudi::Property< bool >	m_produceNTuples {this, "NTupleProduce", true, "general switch to enable/disable N-tuples"}
Gaudi::Property< bool >	m_tuplesPrint {this, "NTuplePrint", true, "print N-tuple statistics"}
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 {this, "EvtColsPrint", false, "print statistics for Event Tag Collections "}
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
TupleMapTitle	m_nTupleMapTitle
	the actual storage of ntuples by title More...
TupleMapID	m_nTupleMapID
	the actual storage of ntuples by ID More...
TupleMapTitle	m_evtColMapTitle
	the actual storage of event collections by title More...
TupleMapID	m_evtColMapID
	the actual storage of event collections by 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 39 of file GaudiTuples.h.

Member Typedef Documentation

template<class PBASE>

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

the actual type for histogram identifier

Definition at line 44 of file GaudiTuples.h.

template<class PBASE>

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

the actual type of the tuple

Definition at line 46 of file GaudiTuples.h.

template<class PBASE>

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

the actual type of N-tuple ID

Definition at line 48 of file GaudiTuples.h.

template<class PBASE>

typedef GaudiAlg::TupleMapID GaudiTuples< PBASE >::TupleMapID

the actual type of (Numeric ID) -> (tuple) mappping

Definition at line 52 of file GaudiTuples.h.

template<class PBASE>

typedef GaudiAlg::TupleMapTitle GaudiTuples< PBASE >::TupleMapTitle

the actual type of (title) -> (tuple) mappping

Definition at line 50 of file GaudiTuples.h.

Constructor & Destructor Documentation

template<class PBASE>

template<typename U = PBASE, class = typename std::enable_if<std::is_base_of<GaudiHistoAlg, PBASE>::value, U>::type>

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 289 of file GaudiTuples.h.

                                                                 : PBASE( name, pSvcLocator )
  {
    initGaudiTuplesConstructor();
  }

template<class PBASE>

template<typename U = PBASE, class = typename std::enable_if<std::is_base_of<GaudiHistoTool, PBASE>::value, U>::type>

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 296 of file GaudiTuples.h.

      : PBASE( type, name, parent )
  {
    initGaudiTuplesConstructor();
  }

template<class PBASE>

GaudiTuples< PBASE >::~GaudiTuples ( )

overridedefault

Destructor.

Member Function Documentation

template<class PBASE >

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 347 of file GaudiTuples.icpp.

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

template<class PBASE >

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 336 of file GaudiTuples.icpp.

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

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 184 of file GaudiTuples.icpp.

{
  // look up in the table
  Tuples::TupleObj* tuple = m_evtColMapTitle[title];
  if ( tuple ) {
    return 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 );
    }
    // proposed the tuple ID
    ID = TupleID( m_evtColMapID.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 );
}

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 278 of file GaudiTuples.icpp.

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

  // look up in the table
  Tuples::TupleObj* tuple = m_evtColMapID[ID];
  if ( tuple ) {
    return Tuple( 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() ) {
    // 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" );
    }

    // 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;
    }

    tuple = createEvtCol( title, tup, clid );
  } else {
    tuple = createEvtCol( title, (NTuple::Tuple*)0, clid );
  }
  // increment the reference
  tuple->addRef();
  //
  m_evtColMapID[ID] = tuple;
  //
  tuple->addRef();
  m_evtColMapTitle[title] = tuple;
  // return
  return Tuple( tuple );
}

template<class PBASE>

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

inline

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

Definition at line 226 of file GaudiTuples.h.

{ return m_evtColDir; }

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 419 of file GaudiTuples.icpp.

{
  return m_evtColMapID.end() != m_evtColMapID.find( ID );
}

template<class PBASE>

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

inline

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

Definition at line 222 of file GaudiTuples.h.

{ return m_evtColLUN; }

template<class PBASE>

const TupleMapID& GaudiTuples< PBASE >::evtColMapID ( ) const

inlineprotected

access to the all evet tag collections by numeric ID

Definition at line 263 of file GaudiTuples.h.

{ return m_evtColMapID; }

template<class PBASE>

const TupleMapTitle& GaudiTuples< PBASE >::evtColMapTitle ( ) const

inlineprotected

access to the all evet tag collections by title

Definition at line 259 of file GaudiTuples.h.

{ return m_evtColMapTitle; }

template<class PBASE>

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

inline

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

Definition at line 228 of file GaudiTuples.h.

{ return m_evtColOffSet; }

template<class PBASE >

std::string GaudiTuples< PBASE >::evtColPath

(

)

const

get the constructed Event Tag Collection path

Definition at line 464 of file GaudiTuples.icpp.

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

template<class PBASE>

bool GaudiTuples< PBASE >::evtColsPrint ( ) const

inline

print event collections at finalization

Definition at line 234 of file GaudiTuples.h.

{ return m_evtColsPrint; }

template<class PBASE>

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

inline

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

Definition at line 224 of file GaudiTuples.h.

{ return m_evtColTopDir; }

template<class PBASE >

StatusCode GaudiTuples< PBASE >::finalize ( )

overrideprotected

standard finalization method

Returns

status code

Definition at line 111 of file GaudiTuples.icpp.

{
  if ( !( nTupleMapTitle().empty() && nTupleMapID().empty() && evtColMapTitle().empty() && evtColMapID().empty() ) ) {
    const int nNtuples = nTupleMapID().size();
    const int nEvtCols = evtColMapID().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
  releaseAndClear( m_nTupleMapTitle );

  // release ntuples and clear the container
  releaseAndClear( m_nTupleMapID );

  // release ntuples and clear the container
  releaseAndClear( m_evtColMapTitle );

  // release ntuples and clear the container
  releaseAndClear( m_evtColMapID );

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

template<class PBASE>

void GaudiTuples< PBASE >::initGaudiTuplesConstructor ( )

inlineprivate

Constructor initialization and job options.

Definition at line 332 of file GaudiTuples.h.

  {
    m_tuplesPrint.declareUpdateHandler( &GaudiTuples<PBASE>::printNTupleHandler, this );
    m_evtColsPrint.declareUpdateHandler( &GaudiTuples<PBASE>::printEvtColHandler, this );
  }

template<class PBASE >

StatusCode GaudiTuples< PBASE >::initialize ( )

overrideprotected

standard initialization method

Returns

status code

Definition at line 66 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;
}

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 146 of file GaudiTuples.icpp.

{
  // look up in the table
  auto* tuple = m_nTupleMapTitle[title];
  if ( tuple ) {
    return 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 );
    }
    // propose the tuple ID
    ID = TupleID( m_nTupleMapID.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 );
}

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 222 of file GaudiTuples.icpp.

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

  // look up in the table
  Tuples::TupleObj* tuple = m_nTupleMapID[ID];
  if ( tuple ) {
    return 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() ) {
    // 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" );
    }

    // 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;
    }

    tuple = createNTuple( title, tup, clid );
  } else {
    tuple = createNTuple( title, (NTuple::Tuple*)0, clid );
  }
  // increment the reference
  tuple->addRef();
  //
  m_nTupleMapID[ID] = tuple;
  //
  tuple->addRef();
  m_nTupleMapTitle[title] = tuple;
  // return
  return Tuple( tuple );
}

template<class PBASE>

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

inline

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

Definition at line 212 of file GaudiTuples.h.

{ return m_nTupleDir; }

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 411 of file GaudiTuples.icpp.

{
  return m_nTupleMapID.end() != m_nTupleMapID.find( ID );
}

template<class PBASE>

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

inline

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

Definition at line 208 of file GaudiTuples.h.

{ return m_nTupleLUN; }

template<class PBASE>

const TupleMapID& GaudiTuples< PBASE >::nTupleMapID ( ) const

inlineprotected

access to the all ntuples by numeric ID

Definition at line 261 of file GaudiTuples.h.

{ return m_nTupleMapID; }

template<class PBASE>

const TupleMapTitle& GaudiTuples< PBASE >::nTupleMapTitle ( ) const

inlineprotected

access to the all ntuples by title

Definition at line 257 of file GaudiTuples.h.

{ return m_nTupleMapTitle; }

template<class PBASE>

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

inline

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

Definition at line 214 of file GaudiTuples.h.

{ return m_nTupleOffSet; }

template<class PBASE >

std::string GaudiTuples< PBASE >::nTuplePath

(

)

const

get the constructed N-Tuple path

Definition at line 455 of file GaudiTuples.icpp.

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

template<class PBASE>

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

inline

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

Definition at line 210 of file GaudiTuples.h.

{ return m_nTupleTopDir; }

template<class PBASE >

void GaudiTuples< PBASE >::printEvtColHandler ( Gaudi::Details::PropertyBase &  )

private

handler for "EvtColsPrint" property

Definition at line 441 of file GaudiTuples.icpp.

{
  // no action if not yet initialized
  if ( this->FSMState() < Gaudi::StateMachine::INITIALIZED ) {
    return;
  }
  if ( this->evtColsPrint() ) {
    this->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 384 of file GaudiTuples.icpp.

{
  if ( evtColMapTitle().empty() && evtColMapID().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 : ordered( evtColMapID() ) ) {
    if ( !entry.second ) {
      continue;
    }
    const auto tuple = entry.second->tuple();
    if ( !tuple ) {
      this->error() << " NTuple::Tuple* points to NULL" << endmsg;
      continue;
    }
    this->always() << GaudiAlg::PrintTuple::print( tuple, entry.first )
                   << " Items:" << Gaudi::Utils::toString( entry.second->items() ) << endmsg;
  }
  //
  return this->evtColMapID().size();
}

template<class PBASE >

void GaudiTuples< PBASE >::printNTupleHandler ( Gaudi::Details::PropertyBase &  )

private

handler for "NTuplePrint" property

Definition at line 427 of file GaudiTuples.icpp.

{
  // no action if not yet initialized
  if ( this->FSMState() < Gaudi::StateMachine::INITIALIZED ) {
    return;
  }
  if ( this->tuplesPrint() ) {
    this->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 356 of file GaudiTuples.icpp.

{

  if ( nTupleMapTitle().empty() && nTupleMapID().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 : ordered( nTupleMapID() ) ) {
    if ( !entry.second ) {
      continue;
    }
    const NTuple::Tuple* tuple = entry.second->tuple();
    if ( !tuple ) {
      this->error() << " NTuple::Tuple* points to NULL" << endmsg;
      continue;
    }
    this->always() << GaudiAlg::PrintTuple::print( tuple, entry.first ) << endmsg;
  }
  //
  return this->nTupleMapID().size();
}

template<class PBASE>

bool GaudiTuples< PBASE >::produceEvtCols ( ) const

inline

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

Definition at line 218 of file GaudiTuples.h.

{ return m_produceEvtCols; }

template<class PBASE>

bool GaudiTuples< PBASE >::produceNTuples ( ) const

inline

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

Definition at line 204 of file GaudiTuples.h.

{ return m_produceNTuples; }

template<class PBASE>

bool GaudiTuples< PBASE >::splitEvtColDir ( ) const

inline

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

Definition at line 220 of file GaudiTuples.h.

{ return m_splitEvtColDir; }

template<class PBASE>

bool GaudiTuples< PBASE >::splitNTupleDir ( ) const

inline

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

Definition at line 206 of file GaudiTuples.h.

{ return m_splitNTupleDir; }

template<class PBASE>

bool GaudiTuples< PBASE >::tuplesPrint ( ) const

inline

print tuples at finalization

Definition at line 232 of file GaudiTuples.h.

{ return m_tuplesPrint; }

Member Data Documentation

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 365 of file GaudiTuples.h.

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 362 of file GaudiTuples.h.

template<class PBASE>

TupleMapID GaudiTuples< PBASE >::m_evtColMapID

mutableprivate

the actual storage of event collections by ID

Definition at line 377 of file GaudiTuples.h.

template<class PBASE>

TupleMapTitle GaudiTuples< PBASE >::m_evtColMapTitle

mutableprivate

the actual storage of event collections by title

Definition at line 375 of file GaudiTuples.h.

template<class PBASE>

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

private

Definition at line 361 of file GaudiTuples.h.

template<class PBASE>

Gaudi::Property<bool> GaudiTuples< PBASE >::m_evtColsPrint {this, "EvtColsPrint", false, "print statistics for Event Tag Collections "}

private

Definition at line 359 of file GaudiTuples.h.

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 363 of file GaudiTuples.h.

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 354 of file GaudiTuples.h.

template<class PBASE>

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

private

Definition at line 352 of file GaudiTuples.h.

template<class PBASE>

TupleMapID GaudiTuples< PBASE >::m_nTupleMapID

mutableprivate

the actual storage of ntuples by ID

Definition at line 372 of file GaudiTuples.h.

template<class PBASE>

TupleMapTitle GaudiTuples< PBASE >::m_nTupleMapTitle

mutableprivate

the actual storage of ntuples by title

Definition at line 370 of file GaudiTuples.h.

template<class PBASE>

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

private

Definition at line 351 of file GaudiTuples.h.

template<class PBASE>

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

private

Definition at line 353 of file GaudiTuples.h.

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 357 of file GaudiTuples.h.

template<class PBASE>

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

private

Definition at line 347 of file GaudiTuples.h.

template<class PBASE>

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

private

Definition at line 360 of file GaudiTuples.h.

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 349 of file GaudiTuples.h.

template<class PBASE>

Gaudi::Property<bool> GaudiTuples< PBASE >::m_tuplesPrint {this, "NTuplePrint", true, "print N-tuple statistics"}

private

Definition at line 348 of file GaudiTuples.h.

---

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

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