pycorrelator.tests package

pycorrelator.tests.test_catalog module

class pycorrelator.tests.test_catalog.TestCatalog_InvalidInput(methodName='runTest')

Bases: TestCase

test_invalid_type()

test_np_contains_inf()

test_np_shape_1d()

test_np_shape_2x3()

test_pd_column_missing_dec()

test_pd_column_missing_ra()

test_pd_contains_nan()

class pycorrelator.tests.test_catalog.TestCatalog_RandomCheckInputOutput(methodName='runTest')

Bases: TestCase

static get_input_output_pair(N)

test_random_np()

test_random_pd()

class pycorrelator.tests.test_catalog.TestCatalog_ValidInput(methodName='runTest')

Bases: TestCase

setUp()

Hook method for setting up the test fixture before exercising it.

tearDown()

Hook method for deconstructing the test fixture after testing it.

test_np()

test_pd()

test_pd_column_name_lower()

test_pd_column_name_mixed()

test_pd_column_name_upper()

pycorrelator.tests.test_chunk module

class pycorrelator.tests.test_chunk.TestChunkGeneratorByGrid_coor2id_boundary(methodName='runTest')

Bases: TestCase

test_middle_chunks_boundaries()

test_objects_outside_tolerance_boundary()

test_polar_chunks_boundaries()

class pycorrelator.tests.test_chunk.TestChunkGeneratorByGrid_coor2id_central(methodName='runTest')

Bases: TestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_boundaries()

test_middle_chunks_north()

test_middle_chunks_south()

test_polar_regions()

class pycorrelator.tests.test_chunk.TestChunkIntegratingFoF(methodName='runTest')

Bases: TestCase

group_by_quadtree_scipy(objects_df: DataFrame, tolerance, chunk_gen)

setUp()

Hook method for setting up the test fixture before exercising it.

test_different_chunk()

pycorrelator.tests.test_fof module

class pycorrelator.tests.test_fof.TestCelestialGrouping(methodName='runTest')

Bases: TestCase

test_qt_grid_boundary()

test_qt_high_density()

test_qt_long_chain()

Test result: Found round-off error in the code. The problem is fixed by setting a relative tolerance of 1e-8 in the np.isclose() function.

test_qt_random_tree()

test_qt_random_walk()

class pycorrelator.tests.test_fof.TestCelestialGrouping_Random(methodName='runTest')

Bases: TestCase

test_comparing_chunk_setting()

class pycorrelator.tests.test_fof.TestCelestialGrouping_RandomGrid(methodName='runTest')

Bases: TestCase

Unit test for a celestial objects grouping method.

The purpose of this unit test is to ensure that a celestial objects grouping method works correctly. A grid on the celestial sphere is created with a size of 10 deg. Half of the grid points are randomly selected, and for each selected point, several points are created within a 1 deg circle around it using the point_offset() function. These points, with the central point, become a ‘group’. The tested function is then called, and its output is checked against the expected groups. If there’s a discrepancy, the problematic group is printed.

setUp()

Hook method for setting up the test fixture before exercising it.

test_group_by_quadtree()

pycorrelator.tests.test_fof.check_group_match(expected_groups: list[list[tuple[float, float]]], output_groups)

Check if two groups match.

Parameters:

• expected_groups (list[list[tuple[float, float]]]) – List of groups that are expected to be grouped correctly.

• output_groups (list[list[tuple[float, float]]]) – List of groups that are output by the tested function.

Returns:

problematic_groups – List of groups that the tested function failed to group correctly. If the tested function works correctly, an empty list is returned.

Return type:

list[list[tuple[float, float]]]

pycorrelator.tests.test_fof.create_groups_from_grid(grid: list[tuple[float, float]], tolerance=1, seed=None, fraction=0.5, ring_radius=(0, 1)) → tuple[list[list[tuple[float, float]]], ndarray[Any, dtype[_ScalarType_co]]]

Randomly pick half of the grid points and create groups around them. For each selected grid point, use the point_offset() function to create several points within a tolerance (default 1 degree) circle around the central point. Returns a list of groups, where each group is a list of (RA, Dec) coordinates.

pycorrelator.tests.test_fof.generate_celestial_grid(**kwargs) → list[tuple[float, float]]

Generate a grid on the celestial sphere with specified step sizes and bounds.

Keyword Arguments:

• ra_step (float) – Step size for Right Ascension (default: 10).

• dec_step (float) – Step size for Declination (default: 10).

• ra_offset (float) – Offset for RA (default: 0).

• dec_offset (float) – Offset for DEC (default: 0).

• ra_bounds (tuple) – A tuple containing the lower and upper bounds for RA (default: (0, 360)).

• dec_bounds (tuple | float) – A tuple containing the lower and upper bounds for DEC (default: (-60, 60)). Can also be an absolute value which will be interpreted as (value, -value).

Returns:

List of (RA, Dec) coordinates for the grid points.

Return type:

list[tuple[float, float]]

pycorrelator.tests.test_fof.print_format_group(groups)

Format a list of celestial groups into the desired format and print them.

pycorrelator.tests.test_result_xmatch module

class pycorrelator.tests.test_result_xmatch.TestXMatchResult_Methods(methodName='runTest')

Bases: TestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_get_dataframe1()

test_get_dataframe1_min_match()

test_get_dataframe1_retain_all_columns_False()

test_get_dataframe1_retain_all_columns_True()

test_get_dataframe1_retain_columns()

test_get_dataframe2()

test_get_multiindex_dataframe()

test_get_result_dict()

test_get_serial_dataframe()

test_get_serial_dataframe_min_match()

test_get_serial_dataframe_retain_all_columns()

test_get_serial_dataframe_retain_columns()

test_get_serial_dataframe_reverse()

pycorrelator.tests.test_toolbox_spherical module

class pycorrelator.tests.test_toolbox_spherical.TestAngularDistance(methodName='runTest')

Bases: TestCase

test_distance_near_wraparound_points()

test_distance_north_south_poles()

test_distance_random_point_north_pole()

test_distance_random_point_south_pole()

test_distance_wraparound_points()

class pycorrelator.tests.test_toolbox_spherical.TestPointOffset(methodName='runTest')

Bases: TestCase

setUp()

Hook method for setting up the test fixture before exercising it.

test_point_offsets()

class pycorrelator.tests.test_toolbox_spherical.TestPointOffsetExtremeCases(methodName='runTest')

Bases: TestCase

check_distance(point1, point2, expected_distance)

setUp()

Hook method for setting up the test fixture before exercising it.

test_north_pole_offsets()

test_opposite_point_offsets()

test_south_pole_offsets()

test_tiny_distance_offsets()

test_wraparound_direction_offsets()

class pycorrelator.tests.test_toolbox_spherical.TestRotateRADEC(methodName='runTest')

Bases: TestCase

test_full_rotation()

test_multiple_rotations()

test_no_rotation()

test_perpendicular_rotation()

test_rotation_about_itself()

test_rotation_about_pole()

test_small_angle_rotation()

test_south_pole_rotation()

pycorrelator.tests.test_xmatch module

Module contents