.. _filter-tools:

filter-tools Documentation
==========================

**Maintainer:** Erik Blaufuss

.. toctree::
   :maxdepth: 3

   release_notes

Overview
~~~~~~~~
A set of tools used in the online filter.  Also used in 
verifying and simulating the online filters.

The Modules
~~~~~~~~~~~
* :js:data:`CreateFilterMask` - A c++ module to create a I3FilterResultMap (aka FilterMask) based on I3Bools located in the Frame
* :js:data:`FilterMaskMaker` - A c++ module to create a FilterResultMap (aka FilterMask) based on I3Bools in the frame with configurable prescales.
* :js:data:`DistributePnFObjects` - A module used to help rehydrate the QP frame structure in the compact PFFilt files transfered from pole.
* :js:data:`I3IcePickModule_FilterMaskFilter` - An icepick module that select frames based on a online fiter result
* :js:data:`FilterCheckModule` - A utility module that is used to compare an I3FilterResultMap against a set of I3Bools
* :js:data:`ParticleCheck` - A utility module to compare sets of I3Particles. 
* :js:data:`FilterMask2Bools` - Creates a set of I3Bools in the frame based on the contrnts of the  I3FilterResultMap.
* :js:data:`KeepFromSubstream` - A utility module used in the online filter to flatten the QP strucure for the PFFilt files. Keeps selected objects in Q frame and labels them to match the source split and subevent number.
* :js:data:`OrPframeFilterMasks` - A utility module used in the online filter to combine the filter results in I3FilterResultMap entries from multiple P frames.

Also see the :ref:`doxygen <filter-tools-cpp>` docs.