km3astro.testing_tools

km3astro.testing_tools for tests/test_benchmark.py

Module Contents

Functions

test_Skycoord_separation(SC_true, SC_check)	Calculate the angle separation between two SkyCoord object
test_benchmark_conversion(table_true, table_check)	Calculate the angle separation between two pandas DataFrame of SkyCoord object
test_angle_separation(file0[, detector, detector_to])	Test the angle separation of between a benchmark table and km3astro.coord transformation tool.

km3astro.testing_tools.test_Skycoord_separation(SC_true, SC_check)

Calculate the angle separation between two SkyCoord object

Parameters:

SC_trueastropy.SkyCoord

Sky coordinate of reference

SC_checkastropy.SkyCoord

Sky coordinate to be checked

Returns:

sep_degfloat

The angle between the two Sky coordinate object

km3astro.testing_tools.test_benchmark_conversion(table_true, table_check)

Calculate the angle separation between two pandas DataFrame of SkyCoord object

Parameters:

table_truepandas.DataFrame(astropy.SkyCoord)

Pandas DataFrame of the Sky coordinate of reference

table_checkpandas.DataFrame(astropy.SkyCoord)

Pandas DataFrame of the Sky coordinate to be checked

Returns:

sep_tablepandas.DataFrame(float)

DataFrame of the angle between the two table of Sky coordinate object

km3astro.testing_tools.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:

file0str

path to the benchmark table.

detectorstr [default = “antares”]

Detector of the benchmark table, either “orca”, “arca” or “antares”

detector_tostr [default = “antares”]

Detector of the new frame, either “orca”, “arca” or “antares”