orbitx.Matchups.find_matchups

orbitx.Matchups.find_matchups#

classmethod Matchups.find_matchups(satellites: List[str], start_date: datetime64, end_date: datetime64, propagation_sampling_interval: timedelta64, interpolation_sampling_interval: timedelta64, space_diff_threshold: float, time_diff_threshold: timedelta64, check_before: bool = False, check_after: bool = False, has_land_ocean_mask: bool = False, reference_date: datetime64 = np.datetime64('1970-01-01T00:00:00'), custom_satellites: List[Dict[str, str]] = [], dump_orbit: bool = False)[source]#

Main generator for Matchups object

Finds matchups between the satellites specified, between the start and end times specified.

Parameters:

  • satellites (List[str]) – List of satellites short names for which the matchups must be found. This variables can only be used for satellites that are natively supported by orbitx. For other satellites, use the custom_satellite argument.

  • start_date (np.datetime64) – Date from which matchups must be found

  • end_date (np.datetime64) – Date until which matchups must be found

  • propagation_sampling_interval (np.timedelta64) – The time resolution of the orbits simulation in seconds (the smaller, the more precise the simulation, but also the slower)

  • interpolation_sampling_interval (np.timedelta64) – The time resolution of the interpolation of the orbits (interpolating the simulated orbits)

  • space_diff_threshold (float) – The maximal distance between satellites centers for an event to be called a matchup

  • time_diff_threshold (np.timedelta64) – The maximal time interval between the passing of two satellites for an event to be called a matchup

  • check_before (Optional[bool], optional) – Whether matchups where one of the satellites passed before the start date should be considered (useful when running successive time spans in separate threads so bordering matchups are not lost). Defaults to False.

  • check_after (Optional[bool], optional) – Whether matchups where one of the satellites passed after the end date should be considered (useful when running successive time spans in separate threads so bordering matchups are not lost). Defaults to False.

  • has_land_ocean_mask (Optional[bool], optional) – Whether a variable informing whether the satellites are above ocean or land (or coast if not all satellites are about the same time of surface) should be added. Defaults to False.

  • reference_date (_type_, optional) – Time variables are provided as seconds from this reference date. Defaults to np.datetime64(“1970-01-01T00:00:00”).

  • custom_satellites (List[Dict[str, str]], optional) – Each dictionnary in the list should have the following keys: tle_filepath, satellite_shortname, satellite_name. tle_filepath`is the path of a Two Line Element file for the satellite of interest, `satellite_shortname`is the shortname of the satellite of interest (e.g., J2) and `satellite_name is the full name of the satellite of interest (e.g., Jason-2). Defaults to [].

  • dump_orbit (bool, optional) – Whether the orbits generated to find the matchups should be deleted (so the objects takes less space). Defaults to False.

Returns:

A Matchups object containing information about all matchup events identified with the specified parameters.

Return type:

Matchup