tjpcov.tools
============

.. py:module:: tjpcov.tools


Functions
---------

.. autoapisummary::

   tjpcov.tools.read_map_from_hdf5
   tjpcov.tools.read_map


Module Contents
---------------

.. py:function:: read_map_from_hdf5(fname, name, nside)

   Return the map stored in the hdf5 TXPipe-like file.

   :param fname: Path to the hdf5 file
   :type fname: str
   :param name: Name of the map in th hdf5 file
   :type name: str
   :param nside: Map's HEALPix nside.
   :type nside: int

   :returns: HEALPix map
   :rtype: array


.. py:function:: read_map(fname, name=None, nside=None)

   Return the map stored in the file given.

   :param fname: Path to the map file. If hdf5 it will call
                 read_map_from_hdf5 and name and nside arguments are needed.
                 Elsewise, it will be assumed a HEALPix map and read it.
   :type fname: str
   :param name: Name of the map in the hdf5 file
   :type name: str
   :param nside: Map's HEALPix nside.
   :type nside: int

   :returns: HEALPix map
   :rtype: array