orbitx.TLE.from_sat_shortname

orbitx.TLE.from_sat_shortname#

classmethod TLE.from_sat_shortname(satellite_shortname: str, start_date: datetime64, end_date: datetime64, reference_date: datetime64 = np.datetime64('1970-01-01T00:00:00'))[source]#

Generates a TLE object from the satellite shortname

If the shortname provided is not supported by OrbitX a ValueError is raised and the user is invited to use a TLE file of their own.

Supported shortnames are the following:

"CS2": "CryoSat-2",
"J2": "JASON-2",
"J3": "JASON-3",
"LS8": "Landsat-8",
"LS9": "Landsat-9",
"N20": "NOAA-20",
"S2A": "Sentinel-2A",
"S2B": "Sentinel-2B",
"S3A": "Sentinel-3A",
"S3B": "Sentinel-3B",
"S6": "Sentinel-6",
"SA": "Saral-AltiKa"
Parameters:

  • satellite_shortname (str) – The shortname of the satellite.

  • start_date (np.datetime64) – The date from which the orbit needs to be simulated

  • end_date (np.datetime64) – The date until which the orbit needs to be simulated

  • reference_date (np.datetime64, optional) – The reference date used to represent dates as “seconds since”. Defaults to np.datetime64(“1970-01-01T00:00:00”).

Raises:

ValueError – When the shortname provided is not supported by OrbitX

Returns:

A TLE Object

Return type:

TLE