GAUDI User Guide

Appendix B
Options for standard components

The following is a list of options that may be set for the standard components: e.g. data files for input, print-out level for the message service, etc. The options are listed in tabular form for each component along with the default value and a short explanation. The component name is given in the table caption thus: [ComponentName].

Table B.1 Standard Options for the Application manager [ApplicationMgr]
Option name
Default value
Meaning

EvtSel1

""

"NONE" (if no event input)2

EvtMax

-1

Maximum number of events to process. The default is -1 (infinite) unless EvtSel = "NONE" in which case it is 10.

TopAlg

{}

List of top level algorithms. Format:

{<Type>/<Name>[, <Type2>/<Name2>,...]};

ExtSvc

{}

List of external services names (not known to the ApplicationMgr). Format:

{<Type>/<Name>[, <Type2>/<Name2>,...]};

OutStream

{}

Declares an output stream object for writing data to a persistent store, e.g. {"DstWriter"};

See also Table B.9

Dlls

{}

Search list of DLLs for dynamic loading (NT only). Format: {<dll1>[,<dll2>,...]};

DetStorageType

0

Detector database storage type: 7=XML

DetDbLocation

"empty"

Detector database location (filename,URL). If empty then the environment valiable XMLDDDBROOT is used.

DetDbRootName

"empty"

Name of the root node of the detector transient store

HistogramPersistency

"HBOOK"

Histogram persistency mechanism. Available options are "HBOOK" and "ROOT"

Auditors

""

List of Auditors to be loaded and to be used

The last two options define the source of the job options file and so they cannot be defined in the job options file itself. There are two possibilities to set these options, the first one is using a environment variable called JOBOPTPATH or setting the option to the application manager directly from the main program3. The coded option takes precedence.

JobOptionsType

"FILE"

Type of file (FILE implies ascii)

JobOptionsPath

"jobOptions.txt"

Path for job options source

 

Table B.2 Standard Options for the message service [MessageSvc]
Option name
Default value
Meaning

OutputLevel

0

Verboseness threshold level:

0=NIL,1=VERBOSE, 2=DEBUG, 3=INFO,

4=WARNING, 5=ERROR, 6=FATAL

Format

"% F%18W%S%7W%R%T %0W%M"

Format string.

 

Table B.3 Standard Options for all algorithms [<myAlgorithm>]

Any algorithm derived from the Algorithm base class can override the global Algorithm options thus:
Option name
Default value
Meaning

OutputLevel

0

Message Service Verboseness threshold level:

0=NIL,1=VERBOSE, 2=DEBUG, 3=INFO,4=WARNING, 5=ERROR, 6=FATAL

Enable

true

If false, application manager skips execution of this algorithm

ErrorMax

1

Job stops when this number of errors is reached

ErrorCount

0

Current error count

AuditInitialize

false

Enable/Disable auditing of Algorithm initialisation

AuditExecute

true

Enable/Disable auditing of Algorithm execution

AuditFinalize

false

Enable/Disable auditing of Algorithm finalisation

 

Table B.4 Standard Options for all services [<myService>]

Any service derived from the Service base class can override the global MessageSvc.OutputLevel thus:
Option name
Default value
Meaning

OutputLevel

0

Message Service Verboseness threshold level:

0=NIL,1=VERBOSE, 2=DEBUG, 3=INFO,4=WARNING, 5=ERROR, 6=FATAL

 

Table B.5 Standard Options for all Tools [<myTool>]

Any tool derived from the AlgTool base class can override the global MessageSvc.OutputLevel thus:
Option name
Default value
Meaning

OutputLevel

0

Message Service Verboseness threshold level:

0=NIL,1=VERBOSE, 2=DEBUG, 3=INFO,4=WARNING, 5=ERROR, 6=FATAL

 

Table B.6 Standard Options for all Associators [<myAssociator>]
Option name
Default value
Meaning

FollowLinks

true

Instruct the associator to follow the links instead of using cached information

DataLocation

""

Location where to get association information in the data store

 

Table B.7 Standard Options for all Auditors [<myAuditor>]

Any Auditor derived from the Auditor base class can override the global Auditor options thus:
Option name
Default value
Meaning

OutputLevel

0

Message Service Verboseness threshold level:

0=NIL,1=VERBOSE, 2=DEBUG, 3=INFO,4=WARNING, 5=ERROR, 6=FATAL

Enable

true

If false, application manager skips execution of this algorithm

Table B.8 Options of Algorithms in GaudiAlg package
Algorithm name
Option Name
Default value
Meaning

EventCounter

Frequency

1;

Frequency with which number of events should be reported

Prescaler

PercentPass

100.0;

Percentage of events that should be passed

Sequencer

Members

 

Names of mambers of the sequence

Sequencer

StopOverride

false;

If true, do not stop sequence if a filter fails

 

Table B.9 Options available for output streams (e.g. DstWriter)

Output stream objects are used for writing user created data into data files or databases. They are created and named by setting the option ApplicationMgr.OutStream. For each output stream the following options are available
Option name
Default value
Meaning

ItemList

{}

The list of data objects to be written to this stream, e.g.

{"/Event#1","Event/MyTracks/#1"};

EvtDataSvc

"EventDataSvc"

The service from which to retrieve objects.

Output

{}

Output data stream specification. Format:

{"DATAFILE='mydst.root' TYP='ROOT'"};

EvtConversionSvc

"EventConversionSvc"

Conversion service to be used.4

OutputFile

""

Output file name5

 

Table B.10 Standard Options for the event persistency service [PersistencySvc]
Option name
Default value
Meaning

CnvServices

{}

Sets up the event persistency service. Possible values are:

{"RootEventCnvSvc"};

{"SicbEventCnvSvc"}; or both together

Table B.11 Standard Options for the histogram service [HistogramPersistencySvc]
Option name
Default value
Meaning

OutputFile

""

Output file for histograms. No output if not defined

 

Table B.12 Standard Options for the N-tuple service [NTupleSvc]
Option name
Default value
Meaning

Input

{}

Input file(s) for n-tuples. Format:

{"FILE1 DATAFILE='tuple.hbook' OPT='OLD' TYP='HBOOK'",

["FILE2 DATAFILE='tuple.root' OPT='OLD' TYP='ROOT'",...]}

Output

{}

Output file fInput file(s) for n-tuples. Format:

{"FILE1 DATAFILE='tuple.hbook' OPT='NEW' TYP='HBOOK'",

["FILE2 DATAFILE='tuple.root' OPT='NEW' TYP='ROOT'",...]}

Type

6

Storage type. 6=HBOOK6

Table B.13 Standard Options for the Sicb event selector [EventSelector]
Option name
Default value
Meaning

Input

{}

Input data stream specification.

Format: "<tagname> = '<tagvalue>' <opt>"

Possible <tagname>:

DATAFILE = 'filename', TYP = 'technology type' OPT = 'new'|'update'|'old', SVC = 'CnvSvcName', AUTH = 'login'

For SICB data: FILE = 'xxxxx' , JOBID = 'yyyy'

FirstEvent

1

First event to process (allows skipping of preceding events)

EvtMax

All events on ApplicationMgr.EvtSel input stream

Maximum number of events to process

PrintFreq

10

Frequency with which event number is reported

JobInput

""

String of input files (same format as ApplicationMgr.EvtSel), used only for pileup event selector(s)

 

Table B.14 Event Tag Collection Selector [EventCollectionSelector]
Option name
Default value
Meaning

CnvService

"EvtTupleSvc"

Conversion service to be used

Authentication

""

Authentication to be used

Container

"B2PiPi"

Container name

Item

"Address"

Item name

Criteria

""

Selection criteria

DB

""

Database name

DbType

""

Database type

Function

"NTuple::Selector"

Selection function

 

Table B.15 Standard Options for Sicb Pileup Algorithm [PileUpAlg]
Option name
Default value
Meaning

PileUpMode

""

Pileup mode. Possible values:

"LUMISIGNAL" : Luminosity weighted for signal leading event

"LUMIMINBIAS","LUMI" : Luminosity weighted for minimum bias leading event

Table B.16 Standard Options for Particle Property Service [ParticlePropertySvc]
Option name
Default value
Meaning

ParticlePropertiesFile

"($LHCBDBASE)/cdf/particle.cdf"

Particle properties database location

 

Table B.17 Standard Options for Random Numbers Generator Service [RndmGenSvc]
Option name
Default value
Meaning

Engine

"HepRndm::Engine<RanluxEngine>"

Random number generator engine

Seeds

 

Table of generator seeds

Column

0

Number of columns in seed table -1

Row

1

Number of rows in seed table -1

Luxury

3

Luxury value for the generator

UseTable

false

Switch to use seeds table

 

Table B.18 Standard Options for Transport Service [TransportSvc]
Option name
Default value
Meaning

ChronoStatService

"ChronoStatSvc"

Name of the Chrono Service to be used

MagneticFieldService

"MagneticFieldSvc"

Name of the Magnetic Field Service to be used

DetectorDataService

"DetectorDataSvc"

Name of the Detector Data Service to be used

StandardGeometryTop

"/dd/Structure/LHCb"

Location of the top node of the detector geometry in the transient detector data store

 

Table B.19 Standard Options for Chrono and Stat Service [ChronoStatSvc]
Option name
Default value
Meaning

ChronoPrintOutTable

true

Global switch for profiling printout

PrintUserTime

true

Switch to print User Time

PrintSystemTime

false

Switch to print System Time

PrintEllapsedTime

false

Switch to print Elapsed time (Note typo in option name!)

ChronoDestinationCout

false

If true, printout goes to cout rather than MessageSvc

ChronoPrintLevel

3

Print level for profiling (values as for MessageSvc)

ChronoTableToBeOrdered

true

Switch to order printed table

StatPrintOutTable

true

Global switch for statistics printout

StatDestinationCout

false

If true, printout goes to cout rather than MessageSvc

StatPrintLevel

3

Print level for profiling (values as for MessageSvc)

StatTableToBeOrdered

true

Switch to order printed table

 

Table B.20 Standard Options for XML conversion service [XmlCnvSvc]
Option name
Default value
Meaning

AllowGenericConversion

false;

Switch for generic detector element conversion7

1. The "EvtSel" property of ApplicationMgr is replaced by the property "Input" of EventSelector. Only the value "NONE" is still valid.

2. A basic DataObject object is created as event root ("/Event")

3. The setting of properties from the main program is discussed in chapter 4.

4. This option is obsolete. Please use the TYP tag of Output option instead.

5. This option is obsolete. Please use the DATAFILE tag of the Output option instead.

6. This option is obsolete. Please use the TYP tag of the Input and Output options instead.

7. The XML conversion service allows the possibility to convert user defined detector elements to generic detector elements. This means that only the generic part of the detector element, and its associated geometry, will be converted but not the user defined detector element data. This feature can be used when the user defined detector element data are not needed (e.g. visualization) or when the corresponding user defined XML converters are not available (testing). When this feature is switched ON, the Gaudi application will run successfully with an information message saying that this feature is enabled, and will print out the information about all the detector elements to which this generic conversion is applied. The limitation of this feature is that after the generic conversion the returned reference points to a DetectorElement object and not to the user defined class. This means that SmartDataPtr class can be parameterized only by DetectorElement class and not by the user defined class.