combine_events_lists()#

curvit.combine_events_lists(events_lists_paths=None, threshold=8, num_nearest_neighbors=8, min_matches=4, pixel_tolerance=2, minimum_detections=3, maximum_detections=100, shift_algorithm='multiple_star', min_exptime=30, framecount_per_sec=28.7185)#

Align and combine the events lists from different orbits.

Parameters:

  • events_lists_paths (list) – The list of events list FITS file paths.

  • threshold (float, optional) – The threshold parameter associated with the source detection method. The default value is 8.

  • num_nearest_neighbors (int, optional) – The number of nearest neighbors of a given star (including itself) to construct the triangle invariants for matching. The default value is 8. Only relevant for 'multiple_star' method.

  • min_matches (int, optional) – The minimum number of triangle matches to be found. A value of 1 refers to 1 triangle, corresponding to 3 pairs of coordinates. The default value is 4. Only relevant for 'multiple_star' method.

  • pixel_tolerance (int, optional) – The maximum residual error for matches. The default value is 2. Only relevant for 'multiple_star' method.

  • minimum_detections (int, optional) – The minimum number of sources to be detected. The threshold will be modified to meet the criteria.

  • maximum_detections (int, optional) – The maximum number of sources to be detected. The threshold will be modified to meet the criteria.

  • shift_algorithm ({'single_star', 'multiple_star'}, optional) –

    The parameter to choose between available aligning methods.

    • 'single_star': To use a single star for aligning orbits.

      Single_star option is useful only when there is only one star in the field and no rotation between frames. The minimum number of source detection is 2.

    • 'multiple_star': To use multiple stars for aligning orbits.

      This is the recommended and default method.

  • min_exptime (float, optional) – Orbits having exposure time below this limit will be ignored. the default value is 30 seconds.

  • framecount_per_sec (float, optional) – The framerate of the observation.

Warning

While combining events lists, do not mix data from RAS_VIS and RAS_NUV. In most cases, RAS_VIS data should be preferred.

Note

Please cite the Astroalign article if you are using this function.

Example

>>> import curvit
>>> from glob import glob
>>> file_path_list = glob('*/*/*/RAS_VIS/*/F*/*F1*ce*')
>>> curvit.combine_events_lists(file_path_list)