API

API#

$partial$SGP4 API

plot.plot_orbit(states[, r_earth, ...])

This function takes a tensor of states, and plots the orbit, together with the Earth.

plot.plot_tles(tles[, file_name, figsize, ...])

This function takes a list of tles as input and plots the histograms of some of their elements.

tle.compute_checksum(line)

This function takes a TLE line in the form of a string and computes the checksum.

tle.read_satellite_catalog_number(string)

This function takes a string corresponding to part of a TLE line, and returns the corresponding satellite catalog number.

tle.write_satellite_catalog_number(...)

This function takes a satellite catalog number and returns the corresponding 5-character field to be written in a TLE line.

tle.add_derived_quantities(data, year, ...)

This function takes a dictionary of elements (in which at least the mean motion is already stored), and adds the quantities that are derived from the epoch (i.e. the Julian dates used by SGP4), together with the semi-major axis and the operation mode.

tle.copy_data(data)

This function returns a copy of a dictionary of elements, cloning the tensors it contains (so that the copy does not share memory, nor the autograd graph, with the original one).

tle.load_from_lines(lines[, opsmode])

This function takes a TLE as a list of strings and returns both itself and its dictionary representation.

tle.load_from_data(data[, opsmode])

This function takes a TLE as a dictionary and returns both itself and its representation as a list of strings.

tle.load(file_name)

This function takes a file name that contains TLE (either with names or without), and returns a list of TLE objects.

tle.TLE(data)

This class constructs a TLE object from either a list of strings (that make up the TLE) or from a dictionary.

tle.TLE.copy()

This function returns a copy of the TLE object.

tle.TLE.to_omm()

This function returns the OMM (i.e. CCSDS Orbit Mean-Elements Message) representation of the TLE object.

tle.TLE.perigee_alt([R_eq])

This function returns the perigee altitude of a given TLE.

tle.TLE.apogee_alt([R_eq])

This function returns the apogee altitude of a given TLE.

tle.TLE.set_time(date_mjd)

This function sets the epoch of the TLE to the given date.

tle.TLE.update(tle_data)

This function updates the TLE object with the given data.

omm.from_omm_epoch_to_datetime(epoch)

This function takes the epoch of an OMM (i.e. a CCSDS ASCII time code, for instance '2024-02-29T12:00:00.000000' or, in its day of the year form, '2024-060T12:00:00.000000') and returns the corresponding datetime object.

omm.from_datetime_to_omm_epoch(date_datetime)

This function takes a datetime object and returns the corresponding OMM epoch.

omm.from_object_id_to_international_designator(...)

This function takes the object identifier of an OMM (e.g. '1998-067A') and returns the corresponding international designator, in the form used by the TLE format (e.g. '98067A').

omm.from_international_designator_to_object_id(...)

This function takes an international designator, in the form used by the TLE format (e.g. '98067A'), and returns the corresponding OMM object identifier (e.g. '1998-067A').

omm.parse_json(text)

This function parses OMM data in JSON format (i.e. either a single message or a list of messages, as returned by the Space-Track API), and returns the corresponding list of dictionaries of OMM fields.

omm.parse_xml(text)

This function parses OMM data in XML format, and returns the corresponding list of dictionaries of OMM fields.

omm.parse_kvn(text)

This function parses OMM data in KVN (i.e. keyword-value notation) format, and returns the corresponding list of dictionaries of OMM fields.

omm.parse_csv(text)

This function parses OMM data in CSV format (i.e. one header line with the OMM keywords, followed by one line per object), and returns the corresponding list of dictionaries of OMM fields.

omm.loads(text[, file_format])

This function parses OMM data and returns the corresponding list of dictionaries of OMM fields.

omm.dumps(omms[, file_format])

This function takes an OMM object (or a TLE object, or a list of them, or the corresponding dictionaries of OMM fields), and returns the corresponding text in the requested format.

omm.detect_format(text)

This function takes OMM data and returns the format it is written in.

omm.to_omm_fields(data)

This function takes the dictionary of elements used by dsgp4.tle.TLE and dsgp4.omm.OMM, and returns the corresponding dictionary of OMM fields.

omm.load_from_omm(fields[, opsmode])

This function takes an OMM as a dictionary of OMM fields, and returns both itself and its representation as a dictionary of elements (i.e. the same dictionary used by dsgp4.tle.TLE).

omm.load_from_data(data[, opsmode])

This function takes a set of elements as a dictionary (i.e. the same dictionary used by dsgp4.tle.TLE), and returns both its representation as a dictionary of OMM fields and the dictionary itself.

omm.load(file_name[, file_format])

This function takes a file name that contains OMM data (in JSON, XML, KVN or CSV format), and returns a list of OMM objects.

omm.OMM(data)

This class constructs an OMM (i.e. Orbit Mean-Elements Message) object from a string containing a single message (in JSON, XML, KVN or CSV format), from a dictionary of OMM fields, or from a dictionary of elements (i.e. the same dictionary accepted by dsgp4.tle.TLE).

omm.OMM.to_tle()

This function returns the TLE representation of the OMM object.

util.get_gravity_constants(gravity_constant_name)

util.propagate_batch(tles, tsinces[, ...])

This function takes a list of TLEs and a tensor of times (which must be of same length), and returns the corresponding states.

util.propagate(tle, tsinces[, initialized])

This function takes a tensor of inputs and a TLE, and returns the corresponding state.

util.initialize_tle(tles[, ...])

This function takes a single dsgp4.tle.TLE object or a list of dsgp4.tle.TLE objects and initializes the SGP4 propagator.

util.from_year_day_to_date(y, d)

Converts a year and day of the year to a date.

util.gstime(jdut1)

This function computes the Greenwich Sidereal Time (GST) at the given Julian Date (UT1).

util.clone_w_grad(y)

This function takes a tensor and returns a copy of it with gradients.

util.jday(year, mon, day, hr, minute, sec)

Converts a date and time to a Julian Date.

util.invjday(jd)

Converts a Julian Date to a date and time.

util.days2mdhms(year, fractional_day)

Converts a number of days to months, days, hours, minutes, and seconds.

util.from_string_to_datetime(string)

Converts a string to a datetime object.

util.from_mjd_to_epoch_days_after_1_jan(mjd_date)

Converts a Modified Julian Date to the number of days after 1 Jan 2000.

util.from_mjd_to_datetime(mjd_date)

Converts a Modified Julian Date to a datetime object.

util.from_jd_to_datetime(jd_date)

Converts a Julian Date to a datetime object.

util.get_non_empty_lines(lines)

This function returns the non-empty lines of a list of lines.

util.from_datetime_to_fractional_day(...)

Converts a datetime object to a fractional day.

util.from_datetime_to_mjd(datetime_obj)

Converts a datetime object to a Modified Julian Date.

util.from_datetime_to_jd(datetime_obj)

Converts a datetime object to a Julian Date.

util.from_cartesian_to_keplerian(r_vec, ...)

This function converts the provided state from Cartesian to Keplerian elements.

sgp4(satellite, tsince)

This function represents the SGP4 propagator.

sgp4_batched(satellite_batch, tsince)

This function represents the batch SGP4 propagator.

sgp4init.sgp4init(whichconst, opsmode, satn, ...)

This function initializes the sgp4 propagator.

sgp4init_batch.sgp4init_batch(whichconst, ...)

This function initializes the sgp4 propagator.

sgp4init_batch.initl_batch(xke, j2, ecco, ...)

initl(xke, j2, ecco, epoch, inclo, no, opsmode)

newton_method(tle0, time_mjd[, max_iter, ...])

This function implements the Newton-Raphson method to find the TLE elements that match a given target state.

sgp4init(whichconst, opsmode, satn, epoch, ...)

This function initializes the sgp4 propagator.

sgp4init_batch(whichconst, opsmode, satn, ...)

This function initializes the sgp4 propagator.

dsgp4 ML-dSGP4 Module