JiveXML Package

Author

Nikos.nosp@m..Kon.nosp@m.stant.nosp@m.inid.nosp@m.is@ce.nosp@m.rn.c.nosp@m.h, Eric..nosp@m.Jans.nosp@m.en@he.nosp@m.f.ru.nosp@m..nl, Juerg.nosp@m.en.T.nosp@m.homas.nosp@m.@cer.nosp@m.n.ch

Introduction

This is the core package containing the code for producing the XML event files for the Atlantis event display. User documentation for JiveXML can be found here.

The main component of JiveXML is the AlgTool EventData2XML. This is ultimately responsible for producing the XML files for atlantis. For each datatype you want to put in the XML file, EventData2XML initializes and calls an AlgTool. Each such AlgTool conforms with the abstract interface JiveXML::IDataRetriever and inherits from the JiveXML::DataRetriever base class AlgTool, and all it does is access the corresponding data from StoreGate, extract the relevant info and produce an XML fragment which is passed back to EventData2XML, which at the end writes out the complete XML file, one per event.

Being an AlgTool, EventData2XML can be called conditionally at each event (so as to produce XML files only for interesting or pathological events). However it is often simpler (and sometimes desirable) to produce an XML file for each event processed in athena. For this there is the athena Algorithm JiveXML::AlgoJiveXML, which does nothing but initialize and then execute the EventData2XML AlgTool.

JiveXML properties

• FileNamePrefix : Prefix of output XML files ( default JiveXML )
• AtlasRelease : The offline release version, appears in the XML files
• DataTypes : array of strings, each containing the name of a DataRetriever (corresponding to a given datatype)
• WriteToFile : in online more, in addition to sending the XML data through the network from athena to atlantis, you can also write them to files ( default True )
• OnlineMode : when True it starts a server on a separate thread which sends XML data to Atlantis through the network (default false)
• ServerPort : the network port number to use in OnlineMode; normally, never needs to be changed ( default 48965 )
• WriteGeometry : when True it produces two XML files AGeometry.xml and AMuonGeometry.xml, which contain all the geometry info that Atlantis needs (info obtained directly from GeoModel)
• IgnoreEventInfo : when True the event/run number are ignored and instead the XML file names have the form FileNamePrefix_0_X, where X is incremented every time EventData2XML is called. Potentially useful if you want to call EventData2XML more than once for the same event (e.g. for different Trigger RoIs?) ( default False )