orbitx.Matchups

class orbitx.Matchups(data: DataTree)

Class to find matchup events between multiple satellites

__init__(data: DataTree)

Methods

__init__(data)
animate([trail_length, step, interval, ...])	Animate satellite orbits with progressive matchup discovery.
find_matchups(satellites, start_date, ...[, ...])	Main generator for Matchups object
from_netcdf(input_path)	Loads a Matchup object from a netCDF4 file
from_orbit(orbit, start_date, end_date, ...)	Generator for Matchups object if orbits were already generated.
plot([projection, show_events])	Plot the matchup dataset generated from orbitx.interface.return_matchups
to_netcdf(output_path)	Exports a matchup object to a netcdf file

Attributes

check_after	Whether matchups where one of the space - time positions considered is after the considered time should be considered
check_before	Whether matchups where one of the space - time positions considered is before the considered time space should be considered
creation_date	When this object was created
end_date	Date until which the orbits are computed
events	Individual crossover events derived from the matchup points.
has_land_ocean_mask	Whether the matchup object contain information about the land / ocean / coast mask
matchups	The xarray dataset underpinning this object
orbit	Orbit object from which matchups were found
reference_date	The date used as reference for time representation in "seconds since"
satellite_name	Long name (e.g. Sentinel-6) of the satellites considered in this matchup.
satellite_shortname	Short name (e.g. S6) of the satellites considered in this matchup.
space_diff_threshold	The maximum spatial distance (in kilometers between projected position on Earth surface) between two satellites for a pair of space - time positions to be considered a matchup
start_date	Date from which the orbits are computed
time_diff_threshold	The maximum time delay between two satellites for a pair of space - time positions to be considered a matchup
version	The OrbitX version used to create this object