.. hpproj documentation master file, created by
   sphinx-quickstart on Tue Oct 11 17:36:27 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to HealPixProjection's documentation!
=============================================

HealPixProjection is a project to allow easy and efficient projection of healpix maps onto planar grids. It can be used as a standalone program :func:`hpproj.cutsky`

.. code-block:: bash

    $ cutsky 0.0 0.0 --mapfilenames HFI_SkyMap_857_2048_R2.00_full.fits

or as a python function

.. code-block:: python

    from hpproj import cutsky
    result = cutsky([0.0, 0.0], maps={'HFI 857': {'filename': 'HFI_SkyMap_857_2048_R2.00_full.fits'}})

or as a python class, for optimization when producting several cuts

.. code:: python

    from hpproj import CutSky, to_coord
    cutsky = CutSky({'Planck 857': {'filename': 'HFI_SkyMap_857_2048_R2.00_full.fits'}})
    result = cutsky.cut_fits(to_coord([0., 0.])


.. note::

    For science applications requiring high photometric accuracy, we recommend the drizzlib software developed by CADE, which uses a flux-conserving drizzling method to reproject data between HEALPix and local WCS. Drizzlib is available as standalone software (IDL python) here: http://cade.irap.omp.eu/dokuwiki/doku.php?id=software . An online interface, drizzweb, is available here: http://drizzweb.irap.omp.eu/ .

    You can also have a look into the :func:`reproject.reproject_from_healpix` function from the `reproject <https://reproject.readthedocs.io/en/stable/>`_ package.


Features
--------

- Galactic and equatorial system supported
- All projection system from :class:`~astropy.wcs`
- Project several healpix maps at once, efficiently !
- Output in ``fits``, ``png`` or ``votable``
- Perform :doc:`n-dim projections <usage>` !

See :doc:`usage` for more information on how to use ``cutsky``


Installation
------------

Install ``hpproj`` using pip :

.. code:: bash

    $ pip install hpproj

or by running setuptools on `source <https://git.ias.u-psud.fr/abeelen/hpproj/tree/master>`_. For more information see the :ref:`installation page<installation>`.


Contribute
----------

- `Issues Tracker <https://git.ias.u-psud.fr/abeelen/hpproj/issues>`_
- `Source Code <https://git.ias.u-psud.fr/abeelen/hpproj/tree/master>`_

Support
-------

If you are having issues, please let us know.

License
-------

This project is licensed under the LGPL+3.0 license.


Contents:
=========

.. toctree::
   :maxdepth: 2

   installation
   usage
   projection
   visu
   API

Indices and tables
==================

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