/** \mainpage GEAR \image html "../gear_banner.png"

Overview

Gear is a geometry description toolkit for ILC reconstruction software. It is easy to use and lightweight. Gear defines an abstract interface for the description of an ILC detector as needed for the development of particle flow algorithms. This description is somewhat different from the geometry description needed for the detailed simulation of the detector response, though of course related. For the simualtion one needs very detailed knowledge of the material distribution in space whereas for the reconstruction mostly a higher level description of the subdetector's charcteristics is needed. Depending on the particular reconstruction algorithm a hand full of parameters might suffice to describe a full subdetector, e.g. the main calorimeters - certainly a lot less than waht is needed for the computation of the detailed detector response with geant4. The aim of Gear is now to provide the interface this recosntruction view of the detector geometry. A first implementation uses XML files for the definition of the subdetector's geometry parameters. Currently under development is an implementation for the abstract interface to generic material properties in space, like the material's density at a given point or the integrated B-field along a (straight) path between two points.

Code Structure

At the core of the geometry description in gear is the class gear::GearMgr. An instance of that class provides the user with available implementations of the various sub-interfaces, e.g. an instance of gear::TPCParameters. All subdetector interfaces inherit from gear::GearParameters - this allows to store arbitrary named parameters of simple types and vectors of such types within any subdetector parameter interface. Also generic named parameter sections can be used through this interface, e.g in case a particular subdetector type has not yet been implemented in gear.

In the current implementation XML-files are used to provide the subdetector parameters to Gear. The user code however only applies the abstract interface and is thus independent from the XML-file implementation.

Installation

Download instructions for gear can be found here

To build gear from source you need to have CMake installed on your system

build instructions (with cmake):

$ mkdir build
$ cd build
$ cmake ..
$ make install

To build the gear tests type:
$ make tests

Example code

The file ./src/test/testgear.cc serves as a simple test and example program. Also the print-methods in ./src/gearimpl/Util.cc are a good starting point for learning how to access the information in Gear.

Here is an example XML-file with a detector description in gear.

Merging XML files

Existing XML files with detector geometry definitions can be extended by a new tool that merges two XML files:
./bin/mergeXML
This is particullarly useful if the detector description has been automatically created, e.g. by MokkaGear but is lacking some (user) specific information.

Release Notes

Gear is under development and there are frequent releases. Please check the ./release.notes

If you have any questions or proposals for new features please contact the author: frank.gaede@desy.de */