:py:mod:`km3astro.testing_tools`
================================

.. py:module:: km3astro.testing_tools

.. autoapi-nested-parse::

   km3astro.testing_tools for tests/test_benchmark.py

   ..
       !! processed by numpydoc !!


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


Functions
~~~~~~~~~

.. autoapisummary::

   km3astro.testing_tools.test_Skycoord_separation
   km3astro.testing_tools.test_benchmark_conversion
   km3astro.testing_tools.test_angle_separation



.. py:function:: test_Skycoord_separation(SC_true, SC_check)

   
   Calculate the angle separation between two SkyCoord object


   :Parameters:

       **SC_true** : astropy.SkyCoord
           Sky coordinate of reference

       **SC_check** : astropy.SkyCoord
           Sky coordinate to be checked

   :Returns:

       **sep_deg** : float
           The angle between the two Sky coordinate object













   ..
       !! processed by numpydoc !!

.. py:function:: test_benchmark_conversion(table_true, table_check)

   
   Calculate the angle separation between two pandas DataFrame of SkyCoord object


   :Parameters:

       **table_true** : pandas.DataFrame(astropy.SkyCoord)
           Pandas DataFrame of the Sky coordinate of reference

       **table_check** : pandas.DataFrame(astropy.SkyCoord)
           Pandas DataFrame of the Sky coordinate to be checked

   :Returns:

       **sep_table** : pandas.DataFrame(float)
           DataFrame of the angle between the two table of Sky coordinate object













   ..
       !! processed by numpydoc !!

.. py:function:: test_angle_separation(file0, detector='antares', detector_to='antares')

   
   Test the angle separation of between a benchmark table and km3astro.coord transformation tool.
   for test purpose only.


   :Parameters:

       **file0** : str
           path to the benchmark table.

       **detector** : str [default = "antares"]
           Detector of the benchmark table, either "orca", "arca" or "antares"

       **detector_to** : str [default = "antares"]
           Detector of the new frame, either "orca", "arca" or "antares"














   ..
       !! processed by numpydoc !!