################################
The icerec meta-project
################################

.. toctree::
   :glob:
   :maxdepth: 2


The IceRec working group (IceCube WBS 1.5.2) delivers the
reconstruction code **icerec**, a meta-project in the IceCube
Offline Software frame. This page documents the projects of the
dataclass based icerec **trunk**. Major parts of **icerec**
are hit/pulse extraction and cleaning, fast (first guess)
reconstruction methods that will operate on Pole and elaborate
(Likelihood) algorithms to work offline. 

The software will be 
`documented <http://software.icecube.wisc.edu/offline/projects/cmake/documentation.html>`_
and 
`code reviewed <http://software.icecube.wisc.edu/offline/code_standards.html>`_
and 
`formally (module) tested <http://software.icecube.wisc.edu/offline/projects/cmake/i3test.html>`_
Further tests will encompass physics comparisons with simulated and real data.


IceRec projects
===============

In this section all IceRec projects are listed with links to their documentation.

Calibration and Feature extraction
----------------------------------

Projects related to waveform calibration and feature / pulse extraction.

.. list-table::
   :widths: 25 15 30 30
   :header-rows: 1
   :stub-columns: 1

   * - Project
     - Documentation
     - Code Review
     - Other documents
   * - `FeatureExtractor <../doxygen/FeatureExtractor/index.html>`__
     - `inspect <../inspect/FeatureExtractor.html>`__
     - T Schmidt
     - 
   * - `SLCHitExtractor <../doxygen/SLCHitExtractor/index.html>`__
     - `inspect <../inspect/SLCHitExtractor.html>`__
     - `T Feusels, Oct 06, 09 <http://lists.icecube.wisc.edu/pipermail/icerec/2009-October/004235.html>`__
     - 
   * - `NFE <../doxygen/NFE/index.html>`__
     - `inspect <../inspect/NFE.html>`__
     - `P Toale and A Olivas, Jun 23, 10 <http://lists.icecube.wisc.edu/pipermail/dataclass/2010-June/010091.html>`__
     - `M Wallraff, internal report 201003002, 26 March 2010 <http://internal.icecube.wisc.edu/reports/details.php?type=report&id=icecube%2F201003002>`__
   * - :ref:`wavedeform <wavedeform-main>`
     - `inspect <../inspect/wavedeform.html>`__
     - `F Kislat, Feb 25, 11 <http://lists.icecube.wisc.edu/pipermail/icerec/2011-February/004425.html>`__
     -
   * - :ref:`wavereform <wavereform-main>`
     - `inspect <../inspect/wavereform.html>`__
     - `F Kislat, Apr 07, 11 <http://lists.icecube.wisc.edu/pipermail/icerec/2011-April/004452.html>`__
     -
   * - `portia <../doxygen/portia/index.html>`__
     - `inspect <../inspect/portia.html>`__
     - `A Olivas, Feb 26, 07 <http://lists.icecube.wisc.edu/mailman/private/icerec/2008-March/003814.html>`__
     -


Pulse treatment / Cleaning
--------------------------

Modules operating on hits / pulses, mostly for hit cleaning.

.. list-table::
   :widths: 25 15 30 30
   :header-rows: 1

   * - Project
     - Documentation
     - Code Review
     - Other documents
   * - `pulse-splitter <../doxygen/pulse-splitter/index.html>`__
     - `inspect <../inspect/pulse-splitter.html>`__
     - `K Meagher, Sep 18, 07 <http://www.icecube.wisc.edu/mailman/private/icerec/2007-September/003504.html>`__
     -
   * - `SeededRTCleaning <../doxygen/SeededRTCleaning/index.html>`__
     - `inspect <../inspect/SeededRTCleaning.html>`__
     - `D Boersma, Sep 03, 09 <http://lists.icecube.wisc.edu/pipermail/icerec/2009-September/004228.html>`__
     - 
   * - `static-twc <../doxygen/static-twc/index.html>`__
     - `inspect <../inspect/static-twc.html>`__
     - `N Whitehorn, Oct 14, 10 <http://lists.icecube.wisc.edu/pipermail/icerec/attachments/20101014/369153fa/attachment.obj>`__
     -
   * - `coinc-twc <../doxygen/coinc-twc/index.html>`__
     - `inspect <../inspect/coinc-twc.html>`__
     - `J van Santen, Feb 22, 11 <http://lists.icecube.wisc.edu/pipermail/icerec/2011-February/004423.html>`__
     -
   * - `core-removal <../doxygen/core-removal/index.html>`__
     - `inspect <../inspect/core-removal.html>`__
     - `E Middell, Nov 24, 09 <http://lists.icecube.wisc.edu/pipermail/icerec/2009-November/004268.html>`__
     - 
   * - `lowe-noise-cleaner <../doxygen/lowe-noise-cleaner/index.html>`__
     - `inspect <../inspect/lowe-noise-cleaner.html>`__ 
     - `F Kislat, Mar 02, 09 <http://lists.icecube.wisc.edu/pipermail/icerec/2009-March/004176.html>`__
     -


Filtering and Triggering
---------------------

Trigger, Filter implementations and DST.

.. list-table::
   :widths: 25 15 30 30
   :header-rows: 1

   * - Project
     - Documentation
     - Code Review
     - Other documents
   * - smallshower-filter
     - `Doxygen <../doxygen/smallshower-filter/index.html>`__, `inspect <../inspect/smallshower-filter.html>`__
     - `J Eisch, Nov 12, 09 <http://lists.icecube.wisc.edu/pipermail/icerec/2009-November/004259.html>`__
     -
   * - DeepCore_Filter
     - `Doxygen <../doxygen/DeepCore_Filter/index.html>`__, `inspect <../inspect/DeepCore_Filter.html>`__
     - `E Middell, Mar 23, 10 <http://lists.icecube.wisc.edu/pipermail/icerec/2010-March/004328.html>`__
     -
   * - dst
     - `Doxygen <../doxygen/dst/index.html>`__, `inspect <../inspect/dst.html>`__
     - 
     -
   * - dst-extractor
     - `Doxygen <../doxygen/dst-extractor/index.html>`__, `inspect <../inspect/dst-extractor.html>`__
     -
     -
   * - superdst
     - :ref:`Documentation <superdst-main>`, `inspect <../inspect/superdst.html>`__
     - `P Toale, Apr 14, 11 <http://lists.icecube.wisc.edu/pipermail/icerec/2011-April/004454.html>`__
     -
   * - trigger-sim
     - `Doxygen <../doxygen/trigger-sim/index.html>`__, `inspect <../inspect/trigger-sim.html>`__
     -
     -
   * - trigger-splitter
     - `Doxygen <../doxygen/trigger-splitter/index.html>`__, `inspect <../inspect/trigger-splitter.html>`__
     - `R. Franke, Oct 21, 11 <http://lists.icecube.wisc.edu/pipermail/icerec/2011-October/004548.html>`__
     -
   * - `TopologicalSplitter <../doxygen/TopologicalTplitter/index.html>`__
     - `inspect <../inspect/TopologicalSplitter.html>`__
     - `J v.Santen, Aug 08, 12 <http://lists.icecube.wisc.edu/pipermail/icerec/2012-August/004693.html>`__
     -

Gulliver
----------

The gulliver suite of projects.

.. list-table::
   :widths: 25 15 30 30
   :header-rows: 1

   * - Project
     - Documentation
     - Code Review
     - Other documents
   * - gulliver
     - `Doxygen <../doxygen/gulliver/index.html>`__, `inspect <../inspect/gulliver.html>`__
     - `M Merck, Jul 16, 07 <http://www.ifh.de/~kislat/www/icerec/docs/docs_material/CodeReview-gulliver-etc.pdf>`__
     -
   * - gulliver-modules
     - `Doxygen <../doxygen/gulliver-modules/index.html>`__, `inspect <../inspect/gulliver-modules.html>`__
     -
     -
   * - lilliput
     - `Doxygen <../doxygen/lilliput/index.html>`__, `inspect <../inspect/lilliput.html>`__
     -
     -
   * - paraboloid
     - `Doxygen <../doxygen/paraboloid/index.html>`__, `inspect <../inspect/paraboloid.html>`__
     -
     -
   * - bayesian-priors
     - `Doxygen <../doxygen/bayesian-priors/index.html>`__, `inspect <../inspect/bayesian-priors.html>`__
     - `M Merck, Mar 14, 08 <http://lists.icecube.wisc.edu/mailman/private/icerec/2008-March/003844.html>`__
     -


Muon reconstruction
-------------------

Muon hypothesis based reconstructions.

.. list-table::
   :widths: 25 15 30 30
   :header-rows: 1

   * - Project
     - Documentation
     - Code Review
     - Other documents
   * - I3DirectWalk
     - `Doxygen <../doxygen/I3DirectWalk/index.html>`__, `inspect <../inspect/I3DirectWalk.html>`__  
     - `N Whitehorn, Dec 16, 10 <http://lists.icecube.wisc.edu/pipermail/icerec/2010-December/004404.html>`__
     - `Internal report <http://www.ifh.de/~kislat/www/icerec/docs/docs_material/DirectWalk_Effective_Area.pdf>`__
   * - IceDwalk
     - `Doxygen <../doxygen/IceDwalk/index.html>`__, `inspect <../inspect/IceDwalk.html>`__  
     - `D Rutledge, Jan 12, 08 <http://www.icecube.wisc.edu/mailman/private/icerec/2008-January/003682.html>`__
     - `Performance <http://wiki.icecube.wisc.edu/index.php/IceDwalk>`__
   * - dipolefit
     - `Doxygen <../doxygen/dipolefit/index.html>`__, `inspect <../inspect/dipolefit.html>`__ 
     - `M Greene, Mar 17, 05 <http://lists.icecube.wisc.edu/mailman/private/icerec/2005-March/000616.html>`__
     - Comparison `w SL for AMANDA and I4 <http://icecube.wisc.edu/~hagar/Reco2.html>`__
   * - linefit
     - `Doxygen <../doxygen/linefit/index.html>`__, `inspect <../inspect/linefit.html>`__  
     - `M Greene, Feb 24, 05 <http://lists.icecube.wisc.edu/mailman/private/icerec/2005-February/000467.html>`__
     - Comparison `w SL for AMANDA and I4 <http://icecube.wisc.edu/~hagar/Reco2.html>`__
   * - improvedLinefit
     - `Doxygen <../doxygen/improvedLinefit/index.html>`__, `inspect <../inspect/improvedLinefit.html>`__  
     - `N Whitehorn, Nov 14, 11 <http://lists.icecube.wisc.edu/pipermail/icerec/2011-November/004563.html>`__
     - 
   * - mue
     - `Doxygen <../doxygen/mue/index.html>`__, `inspect <../inspect/mue.html>`__ 
     - `R Franke, Jan 27, 09 <http://lists.icecube.wisc.edu/pipermail/icerec/2009-January/004151.html>`__
     -
   * - photorec-llh
     - `Doxygen <../doxygen/photorec-llh/index.html>`__, `inspect <../inspect/photorec-llh.html>`__
     - `M Merck, Jul 16, 07 <http://www.ifh.de/~kislat/www/icerec/docs/docs_material/CodeReview-gulliver-etc.pdf>`__
     -     
   * - finiteReco
     - `Doxygen <../doxygen/finiteReco/index.html>`__, `inspect <../inspect/finiteReco.html>`__
     - `J Davis, Oct 19, 09 <http://lists.icecube.wisc.edu/pipermail/icerec/2009-October/004251.html>`__
     -
   * - ehe-star
     - `Doxygen <../doxygen/ehe-star/index.html>`__, `inspect <../inspect/ehe-star.html>`__
     - `S Panknin, Nov 12, 08 <http://lists.icecube.wisc.edu/pipermail/icerec/2008-November/004094.html>`__, `response <http://lists.icecube.wisc.edu/pipermail/icerec/2008-December/004137.html>`__
     -
   * - ophelia
     - `Doxygen <../doxygen/ophelia/index.html>`__, `inspect <../inspect/ophelia.html>`__
     - `G Kohnen, Oct 30, 08 <http://www.ifh.de/~kislat/www/icerec/docs/docs_material/Code_Review_Ophelia.pdf>`__
     -
   * - double-muon
     - `Doxygen <../doxygen/double-muon/index.html>`__, `inspect <../inspect/double-muon.html>`__
     - `A Olivas, Jan 28, 09 <http://www.ifh.de/~kislat/www/icerec/docs/docs_material/DoubleMuonReview.pdf>`__
     -
   * - muon-bundle-reco
     - `Doxygen <../doxygen/muon-bundle-reco/index.html>`__, `inspect <../inspect/muon-bundle-reco.html>`__ 
     - `S Grullon, Jul 14, 06 <http://www.icecube.wisc.edu/mailman/private/icerec/2006-July/002799.html>`__ & ff.
     -
   * - millipede
     - `Doxygen <../doxygen/millipede/index.html>`__, `inspect <../inspect/millipede.html>`__
     - `M Wallraff, Jan 18, 12 <http://web.physik.rwth-aachen.de/~icecubemgr/?n=PersonalLogs.MillipedeCodeReview>`__
     -  <http://anacreon.physics.wisc.edu/~nwhitehorn/millipede.pdf>
   * - truncated_energy
     - `Doxygen <../doxygen/truncated_energy/index.html>`__, `inspect <../inspect/truncated_energy.html>`__
     - `M Wolf, Oct 21, 11 <http://lists.icecube.wisc.edu/pipermail/icerec/2011-October/004549.html>`__
     -
   * - MuonVariables
     - `Doxygen <../doxygen/MuonVariables/index.html>`__, `inspect <../inspect/MuonVariables.html>`__ 
     - `C Kopper, Feb 10, 12 <http://lists.icecube.wisc.edu/pipermail/icerec/2012-February/004625.html>`__ 
     - 

Cascade reconstruction
----------------------

Cascade hypothesis based reconstructions.

.. list-table::
   :widths: 25 15 30 30
   :header-rows: 1

   * - Project
     - Documentation
     - Code Review
     - Other documents
   * - cfirst
     - `Doxygen <../doxygen/cfirst/index.html>`__, `inspect <../inspect/cfirst.html>`__  
     - `D Pieloth, Feb 18, 05 <http://www-zeuthen.desy.de/~dpieloth/icecube/codereviews/CFirstCodeReviewDoc.html>`__
     - Comparison `w SL and MC <http://www.ice.phys.psu.edu/~eidolon/CFirst.html>`__
   * - clast
     - `Doxygen <../doxygen/clast/index.html>`__, `inspect <../inspect/clast.html>`__
     - `J van Santen, Aug 24, 09 <http://lists.icecube.wisc.edu/pipermail/icerec/2009-August/004223.html>`__ and ff.
     - 
   * - cscd-llh
     - `Doxygen <../doxygen/cscd-llh/index.html>`__, `inspect <../inspect/cscd-llh.html>`__ 
     - `S Klepser, Dec 20, 05 <http://lists.icecube.wisc.edu/mailman/private/icerec/2005-December/001750.html>`__
     - Data-MC comparisons `Apr <http://www.ifh.de/~kislat/www/icerec/docs/docs_material/cscd-llh.pdf>`__ `Jul <http://www.ifh.de/~kislat/www/icerec/docs/docs_material/cscd_reco.ps.gz>`__
   * - credo
     - `Doxygen <../doxygen/credo/index.html>`__, `inspect <../inspect/credo.html>`__
     - `T Feusels, Nov 26, 09 <http://lists.icecube.wisc.edu/pipermail/icerec/2009-November/004275.html>`__
     -
   * - AtmCscdEnergyReco
     - `Doxygen <../doxygen/AtmCscdEnergyReco/index.html>`__, `inspect <../inspect/AtmCscdEnergyReco.html>`__ 
     - `E Middell, Aug 06, 09 <http://lists.icecube.wisc.edu/pipermail/icerec/2009-August/004217.html>`__ and ff.
     - 
   * - CascadeVariables
     - `Doxygen <../doxygen/CascadeVariables/index.html>`__, `inspect <../inspect/CascadeVariables.html>`__ 
     - `L Mohrmann, Feb 08, 12 <http://lists.icecube.wisc.edu/pipermail/icerec/2012-February/004623.html>`__ 
     - 


IceTop
----------

IceTop related projects: hit extraction, calibration, cleaning, and reconstruction.

.. list-table::
   :widths: 25 15 30 30
   :header-rows: 1

   * - Project
     - Documentation
     - Code Review
     - Other documents
   * - toprec
     - `Doxygen <../doxygen/toprec/index.html>`__, `inspect <../inspect/toprec.html>`__  
     - `M Beimforde, Dec 2, 05 <http://www.ifh.de/~kislat/www/icerec/docs/docs_material/CodeReview-toprec.htm>`__
     - `Internal report on lateral fit <http://internal.icecube.wisc.edu/reports/details.php?type=report&id=icecube%2F200702001>`__
     -
   * - topeventcleaning
     - `Doxygen <../doxygen/topeventcleaning/index.html>`__, `inspect <../inspect/topeventcleaning.html>`__  
     -
     -
   * - tpx
     - `Doxygen <../doxygen/tpx/index.html>`__, `inspect <../inspect/tpx.html>`__  
     - `N Whitehorn, Aug 18, 11 <http://lists.icecube.wisc.edu/pipermail/icerec/2011-August/004495.html>`__
     -


Utilities
----------

Various utilities.

.. list-table::
   :widths: 25 15 30 30
   :header-rows: 1

   * - Project
     - Documentation
     - Code Review
     - Other documents
   * - DomTools
     - `Doxygen <../doxygen/DomTools/index.html>`__, `inspect <../inspect/DomTools.html>`__ 
     - `R Franke, Jul 21, 06 <http://www.icecube.wisc.edu/mailman/private/icerec/2006-July/002836.html>`__
     -
   * - simclasses
     - `Doxygen <../doxygen/simclasses/index.html>`__
     -
     -
   * - photospline
     -
     - 
     - Not a module, but a library to use spline fitted photonics tables in photonics-service
   * - photonics-service
     - `Doxygen <../doxygen/photonics-service/index.html>`__, `inspect <../inspect/photonics-service.html>`__
     - `D Boersma, Oct 23, 08 <http://www.ifh.de/~kislat/www/icerec/docs/docs_material/photonics-service-CODEREVIEW.pdf>`__
     -
   * - BadDomList
     - `Doxygen <../doxygen/BadDomList/index.html>`__, `inspect <../inspect/BadDomList.html>`__ 
     - `S Panknin, Mar 27, 08 <http://lists.icecube.wisc.edu/mailman/private/icerec/2008-March/003876.html>`__
     -
   * - ipdf
     - `Doxygen <../doxygen/ipdf/index.html>`__, `inspect <../inspect/ipdf.html>`__ 
     - `J Pretz, Feb 14, 06 <http://lists.icecube.wisc.edu/mailman/private/icerec/2006-February/002007.html>`__
     - `more documentation <http://www.ifh.de/~kislat/www/icerec/docs/docs_material/ipdf_www/ipdf.html>`__
   * - fill-ratio
     - `Doxygen <../doxygen/fill-ratio/index.html>`__, `inspect <../inspect/fill-ratio.html>`__
     - `A Lucke, Jun 22, 07 <http://www.icecube.wisc.edu/mailman/private/icerec/2007-June/003382.html>`__ 
     -
   * - tensor-of-inertia
     - `Doxygen <../doxygen/tensor-of-inertia/index.html>`__, `inspect <../inspect/tensor-of-inertia.html>`__ 
     - `T Hauschild <http://lists.icecube.wisc.edu/mailman/private/icerec/2005-February/000442.html>`__ / `T Straszheim <http://lists.icecube.wisc.edu/mailman/private/icerec/2005-February/000440.html>`__, Feb 21, 05
     - Comparison `w MC and recoos <http://icecube.wisc.edu/~hagar/reco/moi/Moment_of_inertia.html>`__
   * - particleforge
     - `Doxygen <../doxygen/particleforge/index.html>`__, `inspect <../inspect/particleforge.html>`__
     - `S Panknin, Aug 24, 09 <http://lists.icecube.wisc.edu/pipermail/icerec/2009-August/004224.html>`__
     - 
   * - cramer-rao
     - `Doxygen <../doxygen/cramer-rao/index.html>`__, `inspect <../inspect/cramer-rao.html>`__
     - `R Franke, Sep 02, 09 <http://lists.icecube.wisc.edu/pipermail/icerec/2009-September/004226.html>`__
     - 
   * - flat-ntuple
     - `Doxygen <../doxygen/flat-ntuple/index.html>`__, `inspect <../inspect/flat-ntuple.html>`__ 
     - `D Turcan, Jul 13, 06 <http://www.icecube.wisc.edu/mailman/private/icerec/2006-July/002795.html>`__ & reply
     -
   * - topeventbrowser
     - `Doxygen <../doxygen/topeventbrowser/index.html>`__, `inspect <../inspect/topeventbrowser.html>`__
     -
     -
   * - `CommonVariables <../doxygen/CommonVariables/index.html>`__
     - `inspect <../inspect/CommonVariables.html>`__
     - `E Jacobi, Sep 24, 12 <http://lists.icecube.wisc.edu/pipermail/icerec/2012-September/004709.html>`__
     -


Dependencies
============

The IceRec **trunk** depends on **offline-software V13-01-00**
<http://software.icecube.wisc.edu/offline/>`_, e.g. 
`phys-services <http://software.icecube.wisc.edu/offline/projects/phys-services/index.html>`_, 
`dataclasses <http://software.icecube.wisc.edu/offline/projects/dataclasses/index.html>`_.

-- **Author** Emanuel Jacobi (January 2, 2013)