.. image:: _static/hyperscreen_logo.png


===========
HyperScreen
===========
-----------------------------------------------------------------------
 Improved Background Rejection for the *Chandra* High Resolution Camera
-----------------------------------------------------------------------

.. image:: https://img.shields.io/pypi/v/hyperscreen.svg
        :target: https://pypi.python.org/pypi/hyperscreen


.. image:: https://readthedocs.org/projects/hyperscreen/badge/?version=latest
        :target: https://hyperscreen.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status


.. image:: https://img.shields.io/travis/granttremblay/hyperscreen.svg
        :target: https://travis-ci.com/granttremblay/hyperscreen
        :alt: Build Status


.. image:: https://img.shields.io/coveralls/github/granttremblay/hyperscreen
        :target: https://coveralls.io/github/granttremblay/hyperscreen?branch=master
        :alt: Test Coverage
        

.. image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat
        :target: http://www.astropy.org/
        :alt: Powered by Astropy

.. image:: https://img.shields.io/pypi/l/sphinx_rtd_theme.svg
        :target: https://pypi.python.org/pypi/sphinx_rtd_theme/
        :alt: License


**HyperScreen** is a package implementing an improved background rejection algorithm 
for the *Chandra* High Resolution Camera for basic data reductions
of CCD images. It provides the essential tools for processing of CCD images
in a framework that provides error propagation and bad pixel tracking
throughout the reduction process.

An improved background rejection algorithm for the *Chandra* High Resolution Camera (HRC)




Features
--------

* HyperScreen dynamically creates a hyperbolic acceptance zone on a *tap-by-tap* basis. 
* TODO

Credits
-------

Grant Tremblay, Ralph Kraft, Paul Nulsen, Dan Patnaude, & Alexey Vikhlinin


* Free software: MIT license


Getting started
---------------

.. toctree::
   :maxdepth: 1

   installation
   usage
   authors



Using `HyperScreen`
-------------------

.. toctree::
    :maxdepth: 2

    getting_started

    api


.. toctree::
    :maxdepth: 1

    api


* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`