| Wiki Markup |
|---|
{toc}
h2. Overview
The [SLIC] simulation package produces simulated physics events in the [LCIO] data format. This tutorial shows how to read these events into the [Pandora PFA New|https://svnsrv.desy.de/viewvc/PandoraPFANew/] project to create output Particle Flow Objects (PFOs).
h2. Setup
h3. Preliminaries
A Linux or Unix platform is assumed and the bash shell is used for all command-line instructions. These procedures should also work on an emulation platform like Cygwin. (untested!)
Two external packages must be installed onto your machine before setting up the SLIC to Pandora interface package. The [LCIO] package provides the data interchange format. The Pandora PFA New project is the C++ implementation of the Pandora Particle Flow Algorithm (PFA).
h3. LCIO Installation
Checkout the LCIO project from cvs.
{noformat} |
| Table of Contents |
|---|
Overview
The SLIC simulation package produces simulated physics events in the LCIO data format. This tutorial shows how to read these events into the Pandora PFA New project to create output Particle Flow Objects (PFOs).
Setup
Preliminaries
A Linux or Unix platform is assumed and the bash shell is used for all command-line instructions. These procedures should also work on an emulation platform like Cygwin. (untested!)
Two external packages must be installed onto your machine before setting up the SLIC to Pandora interface package. The LCIO package provides the data interchange format. The Pandora PFA New project is the C++ implementation of the Pandora Particle Flow Algorithm (PFA).
LCIO Installation
Checkout the LCIO project from cvs.
| No Format |
|---|
cd /workdir cvs -d :pserver:anonymous@cvs.freehep.org:/cvs/lcd co lcio {noformat} Building this project requires the [CMake|http://www.cmake.org/] tool, the installation of which is not covered here. It additionally requires command-line GNU Make. |
...
{noformat |
} cd lcio cmake . make |
Pandora PFA New Installation
Now download the Pandora project from the internet and build it. This project also requires CMake to build it.
Follow this link to download the SVN trunk of the Pandora project. Save it to your local computer (in this case to a pandora subdirectory).
| No Format |
|---|
{noformat} h3. Pandora PFA New Installation Now download the Pandora project from the internet and build it. This project also requires CMake to build it. Follow [this link|https://svnsrv.desy.de/viewvc/PandoraPFANew/PandoraPFANew/trunk/?view=tar] to download the SVN trunk of the Pandora project. Save it to your local computer (in this case to a pandora subdirectory). {noformat} cd /workdir/pandora tar -zxvf PandoraPFANew-trunk.tar.gz cd trunk cmake . make {noformat} Now we're ready to setup the project that interfaces SLIC to Pandora. |
...
h3. slicPandora Installation |
...
Checkout the slicPandora project from cvs. |
...
{noformat |
} cd /workdir cvs -d :pserver:anonymous@cvs.freehep.org:/cvs/lcd co slicPandora cd slicPandora {noformat} Copy the example setup script. |
...
{noformat |
} cp example_setup.sh my_setup.sh {noformat} Edit _my_setup.sh_ so that the PANDORAPFA and LCIO variables point to the correct locations of these packages on your computer (from the installation above). |
...
Source the new setup script. |
...
{noformat |
} . my_setup.sh {noformat} Build the slicPandora project. |
...
{noformat |
} make {noformat} The slicPandora project should now build successfully. If compilation or linking errors occur, then check that LCIO and Pandora were installed successfully and that the setup script is pointing to the correct locations of these packages. |
...
h2. Running Events |
...
LCSim
...
h3. LCSim Before the simulated LCIO events can be run through Pandora, the LCSim tracking needs to run in order to add a collection of tracks. LCSim can be run using the steering file, {sidloi3_tracking_steering.xml |
...
}. |
...
{noformat |
} java -jar ./lcsim.jar sidloi3_tracking_steering.xml {noformat} The input files section needs to be changed to point to your local simulated SLIC events. |
...
If you don't have a working LCSim setup, follow the [LCSim XML instructions|lcsim xml] to set one up. |
...
JobManagerTest
The JobManagerTest runs an example of slicPandora using sample input files. To use this event, you need to provide a symlink to an LCIO file in the slicPandora root directory and call it input.slcio.
| No Format |
|---|
h3. JobManagerTest The JobManagerTest runs an example of slicPandora using sample input files. To use this event, you need to provide a symlink to an LCIO file in the slicPandora root directory and call it _input.slcio_. {noformat} cd /workdir/slicPandora ln -s /path/to/myinput.slcio input.slcio {noformat} Execute this command to run this test. |
...
{noformat |
} ./bin/JobManagerTest {noformat} It writes out an LCIO file called _pandoraRecon.slcio_ which contains the input data as well as ReconstructedParticle and Cluster collections created by Pandora. h3. |
...
PandoraFrontend |
...
The PandoraFrontend binary provides a simple frontend to slicPandora. |
...
The syntax of this command is the following. |
...
{noformat |
}
./bin/PandoraFrontend geometry.xml pandoraSettings.xml inputEvents.slcio reconOutput.slcio [nevents]
|
The 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 command.
| No Format |
|---|
{noformat} The _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 command. {noformat} ./bin/PandoraFrontend ./examples/sidloi2_pandora.xml ./examples/PandoraSettingsNew.xml ./input.slcio ./pandoraRecon.slcio 2{noformat} The above command requires that the input events were generated in the sidloi2 detector and that a symlink has been setup pointing from "input.slcio" to your input event file. h2. |
...
Using GeomConverter to Output the Pandora 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. |
...
{noformat |
} java -jar ./target/GeomConverter-1.10-SNAPSHOT-bin.jar -o pandora ./myCompactDetector.xml ./myPandoraGeom.xml {noformat} This will write out a Pandora XML file to "myPandoraGeom.xml" from the compact description in "myCompactDetector.xml". |