Page History

...

The slicPandora package currently has the following dependencies.

You need to have an installation of ROOT, which is not covered here.

You also need to install cmake yourself.

Build Instructions

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 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 should execute each new package build from your working dir.

ilcutil

# ROOT
export ROOTSYS=/path/to/root/directory
export PATH=$ROOTSYS/bin:$PATH

# Build ilcutil
svn co http://svnsrv.desy.de/public/ilctools/ilcutil/trunk ilcutil
cd ilcutil
cmake .
make install
export ILCUTIL_DIR=`pwd`
# Back to work dir.
cd ..

# Checkout PandoraPFANew
# Head checkout.
#svn co http://svnsrv.desy.de/public/PandoraPFANew/PandoraPFANew/trunk PandoraPFANew
# Use tag v00-05.
svn co http://svnsrv.desy.de/public/PandoraPFANew/PandoraPFANew/tags/v00-05 PandoraPFANew
export PandoraPFANew_DIR=`pwd`/PandoraPFANew

# Build PandoraMonitoring
#Head checkout.
#svnmkdir build
cd build
cmake ..
make install
cd ..
export ILCUTIL_DIR=`pwd`

Pandora

svn co http://svnsrv.desy.de/public/PandoraPFANew/PandoraMonitoringPandoraPFANew/trunk PandoraMonitoring
svn co http://svnsrv.desy.de/public/PandoraPFANew/PandoraMonitoring/tags/v00-04 PandoraMonitoring
cd PandoraMonitoringPandoraPFANew
mkdir build
cd build
cmake -DROOT_DIR=$ROOTSYS -DILCUTIL_DIR=$ILCUTIL_DIR -DPandoraPFANewDCMAKE_SKIP_DIRRPATH=$PandoraPFANew_DIR1 ..
make install
cd ..
export PandoraMonitoringPandoraPFANew_DIR=`pwd`
cd ..

# Setup Java
export JAVA_HOME=/path/to/java/directory
export PATH=$JAVA_HOME/bin:$PATH

# Build LCIO
cvs -d :pserver:anonymous@cvs

LCIO

svn co svn://svn.freehep.org:/lcio/cvs/lcd co -r v01-51tags/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_DIR=`pwd`

slicPandora

cvs -d :pserver:anonymous@cvs.freehep.org:/cvs/lcd co slicPandora
cd slicPandora
export SLICPANDORA_DIR=`pwd`
cd ..

# Build PandoraPFANew
cd PandoraPFANew
mkdir build
cd build
cmake -DILCUTIL_DIR=$ILCUTIL_DIR -DPandoraMonitoringDLCIO_DIR=$PandoraMonitoring$LCIO_DIR -DROOTDPandoraPFANew_DIR=$PandoraPFANew_DIR=$ROOTSYS -DCMAKE_SKIP_RPATH=1 ..
make install
cd

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.)

 ../..

# Build slicPandora
cvs -d :pserver:anonymous@cvs.freehep.org:/cvs/lcd co slicPandora
cd slicPandora
mkdir build
cd build
cmake -DBUILD_32BIT_COMPATIBLE=OFF -DROOT_DIR=$ROOTSYS -DCMAKE_MODULE_PATH=$ILCUTIL_DIR/cmakemodules \
-DLCIO_DIR=$LCIO_DIR -DPandoraPFANew_DIR=$PandoraPFANew_DIR -DPandoraMonitoring_DIR=$PandoraMonitoring_DIR ..
make install

The slicPandora project should now be built successfully with the binary installed to slicPandora/bin/PandoraFrontend.

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 accordinglyIf compilation or linking errors occur, then check that the dependencies were installed successfully.

PandoraFrontend

The PandoraFrontend binary provides a simple frontend to slicPandora. The 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 parameters syntax of this command is the following.

./bin/PandoraFrontend geometry-g myGeometry.xml -c pandoraSettingsPandoraSettings.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 2

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

...

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