Page History

...

This tutorial will show you how to process SLIC output files with the Pandora PFA New package, currently the best performing PFA algorithm, in order Particle Flow Algorithm to produce Particle Flow Objects (PFOs) (also called ReconstructedParticles) for analysis. It covers PFOs are represented by the ReconstructedParticle class in the LCIO event data format.

These instructions cover building and installing a slic-specific frontend called slicPandora and all its dependencies. Then it will go through the steps will be shown for processing slic the output using LCSim in order to prepare it for Pandora. Finally, it shows how to run slicPandora using there are instructions for running these events in slicPandora. There is also a note on how to generate brief section on generating a Pandora detector XML files file from compact descriptionsa compact detector description, the XML format used by lcsim to represent detector and geometry information.

Building SlicPandora

...

...

Preliminary Setup

A Linux or Unix platform is assumed and the bash shell is used for all command-line instructions. The actual setup procedures have been tested on Redhat Enterprise Linux 5.5 (Tikanga).

...

The cmake tool must be installed, as it is used to build most of the dependencies.

Dependencies

The slicPandora package currently has the following dependencies.

...

There are build instructions below that show all the steps necessary to build these packages.

Build Instructions

These commands can be executed to produce a working slicPandora, using a shell such as bash.

Start by making a directory where Pandora and its dependencies will be built. installed.

This is just an example. Any directory with enough space will do.

mkdir /work/pandora_build
cd /work/pandora_build

The following commands should then be executed in order from this working directory to make the slicPandora binary.

You need to have a preexisting installation of ROOT, which is not covered here. Set the path to your ROOT installation using the usual ROOTSYS environment variable.

You should execute each new package build from your working dir.

ilcutil

# CMakeModules
svn co httpshttp://svnsrv.desy.de/public/ilctools/CMakeModulesilcutil/trunk/ CMakeModulesilcutil
export CMAKE_MODULE_PATH=`pwd`/CMakeModules

# Checkout PandoraPFANew.
svn co https://svnsrv.desy.de/public/PandoraPFANew/PandoraPFANew/trunk PandoraPFANew
export PandoraPFANew_HOME=`pwd`/PandoraPFANew

# PandoraMonitoring.
svn co httpscd ilcutil
mkdir build
cd build
cmake ..
make install
cd ..
export ILCUTIL_DIR=`pwd`

Pandora

svn co http://svnsrv.desy.de/public/PandoraPFANew/PandoraMonitoringPandoraPFANew/trunk PandoraMonitoring PandoraPFANew
cd PandoraPFANew
mkdir build
cd PandoraMonitoringbuild
cmake -DROOTDILCUTIL_HOMEDIR=$ROOTSYS$ILCUTIL_DIR -DCMAKE_MODULESKIP_PATH=$CMAKE_MODULE_PATH -DPandoraPFANew_HOME=$PandoraPFANew_HOME RPATH=1 ..
make
export PandoraMonitoring_HOME=`pwd` install
cd ..

# LCIO
cvs -d :pserver:anonymous@cvsexport PandoraPFANew_DIR=`pwd`

LCIO

svn co svn://svn.freehep.org:/lcio/cvs/lcd cotags/v02-01-01 lcio
cd lcio
mkdir build
cd build
cmake -DINSTALL_DOC=OFF -DBUILD_32BIT_COMPATIBLE=OFF -DCMAKE_SKIP_RPATH=1 ..
make install
cd ..
export LCIO_HOMEDIR=`pwd`
cd ..

# Build PandoraPFANew.
cd PandoraPFANew
cmake -DCMAKE_MODULE_PATH=$CMAKE

slicPandora

cvs -d :pserver:anonymous@cvs.freehep.org:/cvs/lcd co slicPandora
cd slicPandora
export SLICPANDORA_DIR=`pwd`
mkdir build
cd build
cmake -DILCUTIL_DIR=$ILCUTIL_DIR -DLCIO_DIR=$LCIO_DIR -DPandoraPFANew_DIR=$PandoraPFANew_DIR -DCMAKE_SKIP_RPATH=1 ..
make install

If this step completes successfully without compilation or link errors, you should see a binary at slicPandora/bin/PandoraFrontend. You are basically done building slicPandora.

Pandora Settings (optional)

You should also check out the project that contains example config files for Pandora.

svn co http://svnsrv.desy.de/public/PandoraPFANew/Settings/trunk PandoraSettings

LCDetectors (optional)

There are some slicPandora geometry xml files here. (This is a rather big cvs module so might take some time to checkout.)

_MODULE_PATH -DPandoraMonitoring_HOME=$PandoraMonitoring_HOME -DROOT_HOME=$ROOTSYS .
make
cd ..

# slicPandora.
cvs -d :pserver:anonymous@cvs.freehep.org:/cvs/lcd co slicPandora
cd slicPandora
cmake -DROOT_HOME=$ROOTSYS -DCMAKE_MODULE_PATH=$CMAKE_MODULE_PATH -DLCIO_HOME=$LCIO_HOME -DPandoraPFANew_HOME=$PandoraPFANew_HOME -DPandoraMonitoring_HOME=$PandoraMonitoring_HOME .
make

LCDetectors

For example, see LCDetectors/detectors/sidloi3/sidloi3_pandora.xml and its compact detector description.

Setting the LD_LIBRARY_PATH

The shared library locations need to be specified in the LD_LIBRARY_PATH for slicPandora to run. The variable needs to be defined as follows, based on environment settings from the build.

export LD_LIBRARY_PATH=$SLICPANDORA_DIR/lib:$LCIO_DIR/lib:$PandoraPFANew_DIR/lib

If these variables are not set in the environment, then using the full, explicit path to the library directories will work fine.

Checking the Build

Now you should be able to run this command to load slicPandora.

./slicPandora/bin/PandoraFrontend

The help message should show for slicPandora. If there are errors about missing libraries, set the LD_LIBRARY_PATH variable accordinglyThe slicPandora project should now be built successfully. If compilation or linking errors occur, then check that the dependencies were installed successfully.

PandoraFrontend

The PandoraFrontend binary provides a simple frontend to slicPandora.. It uses GNU style command line switches for user input.

The following table explains the function of each of these switches.

The geometry file is in an XML format. It can be created from a compact detector description using GeomConverter with the option "-o pandora". You are required to provide some additional parameters related to sampling fractions (see LCDetectors/detectors/sidloi3 for example).

The Pandora settings XML file contains settings to configure the Pandora PFA algorithm. Example configuration files can be found in the Pandora Settings SVN project (see building instructions above) (see PandoraSettings/PandoraSettingsBasic.xml).

The LCIO input events should contain collections of LCIO CalorimeterHits named according to their subdetectors, plus a collection of LCIO Track objects called "Tracks." There also needs to be a collection called "TrackStates" containing momentum measurements at various points along the Track (see below for details of generating these files).

The LCIO output file will contain the contents of the input file plus the PFO collections created by Pandora, as well as some intermediate collections of hit objects. This file is generated by slicPandora.

The number of events to run should be a positive integer. If slicPandora runs out of events, it will print and warning but should not crash.

The number of events to skip should be a positive integer. These events are read in and discarded before event processing begins.

Here is a contrived example using all input parametersThe syntax of this command is the following.

./bin/PandoraFrontend -g geometrymyGeometry.xml pandoraSettings-c PandoraSettings.xml -i inputEvents.slcio reconOutput-l myCollections.xml -o myOutput.slcio [nevents]
-r 1000 -s 10

These are example arguments only. Actual usage will require files in the correct input data formats, namely the geometry XML, the Pandora settings file, and the XML specifying which LCIO input collections to use, if different from the defaults.

Using GeomConverter to Output the Pandora Geometry Format

The GeomConverter package can convert from compact detector descriptions to various output formats, including one for input to slicPandoraThe nevents command is optional, but all other arguments are required and must be supplied in order.

For example, to repeat the results of the JobManagerTest using PandoraFrontend, execute this commandgenerate the Pandora settings for the sidloi3 detector.

./bin/PandoraFrontend ./examples/sidloi3_pandora.xml ./examples/PandoraSettingsRelease.xml ./input.slcio ./pandoraRecon.slcio 2cvs -d :pserver:anonymous@co LCDetectors
cd LCDetectors/detectors/sidloi3
java -jar ~/.m2/repository/org/lcsim/GeomConverter/1.13-SNAPSHOT/GeomConverter-1.13-SNAPSHOT-bin.jar -o pandora compact.xml sidloi3_pandora.xml

This will create the file sidloi3_pandora.xml that can be used as input to slicPandora.

FIXME: Need to document the conditions used to set sampling fractionsThe above command requires that the input events were generated in the sidloi3 detector and that a symlink has been setup pointing from "input.slcio" to your input event file.

Running Events in SlicPandora

...

<lcsim xmlns:xs="http://www.w3.org/2001/XMLSchema-instance"
        xs:noNamespaceSchemaLocation="http://www.lcsim.org/schemas/lcsim/1.0/lcsim.xsd">
    <inputFiles>
        <file>./pi_Theta90_10GeV-0-1000_SLIC-v2r8p3_geant4-v9r3p1_QGSP_BERT_sidloi3.slcio</file>
    </inputFiles>
    <control>
        <numberOfEvents>1000</numberOfEvents>
        <verbose>true</verbose>
        <printSystemProperties>false</printSystemProperties>
    </control>
    <execute>
        <driver name="EventMarkerDriver"/>
        <driver name="CalInfoDriver"/>
        <driver name="MainTrackingDriver"/>
        <driver name="TrackStateDriver"/>
        <driver name="Writer"/>
    </execute>
    <drivers>
        <driver name="CalInfoDriver"   
                type="org.lcsim.recon.util.CalInfoDriver"/>
        <driver name="MainTrackingDriver"
                type="org.lcsim.recon.tracking.seedtracker.trackingdrivers.sidloi2.MainTrackingDriver"/>
        <driver name="EventMarkerDriver" 
                type="org.lcsim.job.EventMarkerDriver">
            <eventInterval>10</eventInterval>
        </driver>
        <driver name="TrackStateDriver"
                type="org.lcsim.recon.tracking.seedtracker.SeedTrackerTrackStateDriver"/>
        <driver name="Writer"
                type="org.lcsim.util.loop.LCIODriver">
            <outputFilePath>./pi_Theta90_10GeV-0-1000_SLIC-v2r8p3_geant4-v9r3p1_QGSP_BERT_sidloi3_lcsimTracking.slcio</outputFilePath>
        </driver>
    </drivers>
</lcsim>

...

<driver name="CalInfoDriver"   
        type="org.lcsim.recon.util.CalInfoDriver"/>
<driver name="TrackStateDriver"
        type="org.lcsim.recon.tracking.seedtracker.SeedTrackerTrackStateDriver"/>

...

Now that tracks and track states have been added to the events, we are ready to use Pandora itself.

Using GeomConverter to Output the Pandora Geometry Format

The GeomConverter package can convert from compact detector descriptions to various output formats, including one for input to slicPandora. (Installation of GeomConverter is not covered here.)

Use this command from your GeomConverter root directory to generate a Pandora geometry file from a compact detector description.

java -jar ./target/GeomConverter-1.10-SNAPSHOT-bin.jar -o pandora ./myCompactDetector.xml ./myPandoraGeom.xml

...

Links

• PandoraPFANew FAQ
• Pandora SVN Repository