Backend documentation

This page provides an auto-generated summary of orbitx’s Backend functionalities. Those functionalities are stored in the utils sub-module.

_date_utils.datetime_to_sec_since(date[, ...])	datetime_to_sec_since Converts a datetime to number of seconds since reference date
_date_utils.sec_since_change_ref(date, ...)	sec_since_change_ref Converts a date in seconds since reference date format to a seconds since a different date
_date_utils.sec_since_to_datetime(date[, ...])	sec_since_to_datetime Converts a date from seconds since reference date to datetime
_date_utils.datetime64_to_datetime(date64)
_date_utils.datetime_to_datetime64(date)
_date_utils.datetime64_to_sec_since(date64, ...)
_date_utils.sec_since_to_datetime64(...)
_tle.create_xarray(tle_line_1, tle_line_2, ...)	create_xarray Generate an xarray containing all the information from the TLE file
_tle.filter_xarray(tle_xarray)	Selecting TLEs that are relevant to the time span of the simulation.
_tle.get_argument_perigee(line2)	Finds the argument of the perigee in degrees from the second line of the TLE.
_tle.get_ballistic_coefficient(line1)	Finds the ballistic coefficient (first derivate of the mean motion) of the satellite from the first line of the TLE.
_tle.get_catalog_number(line1)	Finds the catalog number in the first line of the TLE.
_tle.get_classification(line1)	Finds the classification of the satellite in the first line of the TLE. The classification corresponds to character eight in the first line of the TLE. The possible values are - U: unclassified, - C: classified, - S: secret.
_tle.get_drag_term(line1)	Finds the drag term of the satellite from the first line of the TLE.
_tle.get_eccentricity(line2)	Finds the eccentricity from the second line of the TLE.
_tle.get_element_set_number(line1)	Finds the element set number of the TLE from the first line of the TLE.
_tle.get_inclination(line2)	Finds the inclination of the satellite from the second line of the TLE.
_tle.get_launch_number(line1)	Finds the launch number of this satellite in the launch year.
_tle.get_launch_piece(line1)	Finds the launch piece identifier of this satellite.
_tle.get_launch_year(line1)	Finds the launch year of the satellite from the first line of the TLE.
_tle.get_mean_anomaly(line2)	Finds the mean anomaly in degrees from the second line of the TLE.
_tle.get_mean_motion(line2)	Finds the mean motion in revolutions per day from the second line of the TLE.
_tle.get_revolution_number(line2)	Finds the revolution number from the second line of the TLE.
_tle.get_right_ascension(line2)	Finds the right ascension of the ascending node in the ECI reference frame measured from the vernal point from the second line of the TLE.
_tle.get_second_derivative(line1)	Finds the second derivative of the satellite mean motion from the first line of the TLE.
_tle.get_tle_date(tle_line_1)	Date corresponding to this TLE computed from Epoch Date and Julian Date Fraction
_tle.get_tle_path(satellite_name)	Returns path for TLE file for defined satellite
_tle.load_file(tle_filepath)	Getting the list of first lines and the list of second lines of all TLEs in the file.
_orbit.form_sample_space.form_sample_space(...)	Return a numpy array of numpy datetime64 of desired orbit simulation timestamps and a second numpy array of those times represented as floats (seconds since reference date).
_orbit.get_matching_indices.get_matching_indices(...)	Locate the index of the closest two line element (at a time equal to or smaller than the simulation time) and return the matching pointers/indices.
_orbit.interp_circ.interp_circ(x, y[, period])	interp_circ interpolation for periodic-valued data
_orbit.interpolate_orbit.interpolate_orbit(...)	interpolate_orbit Interpolate the orbit at desired time resolution
_orbit.orbit_dict_to_xarray.orbit_dict_to_xarray(...)	convert the temporary orbit dictionary to an xarray in the simulation pipeline
_orbit.propagate_orbit.propagate_orbit(...)	Propagate satellite orbit for given two-line-elements and associated time
_orbit.simulate_orbit.simulate_orbit(...[, ...])	Return latitude, longitude and time arrays for full simulated orbit
_matchups.find_matches.find_matches(orbit, ...)	Finds matchups between each pair of satellites
_matchups.get_delay.get_delay(...)	Calculate the delay in seconds between a collection of orbits and a new orbit at each time stamp
_matchups.get_dist.get_dist(existing_orbits, ...)	Calculate the distance in kilometers on the earth (specified in decimal degrees) between a collection of orbits and a new orbit at each time stamp
_matchups.get_land_ocean_mask.get_land_ocean_mask(...)	Adds a matchup_type variable to a matchups dataset corresponding to the land / ocean / coast mask for each matchup
_matchups.is_land.is_land(x, y)	Returns boolean land mask for x,y coordinates
_matchups.land_mask.land_mask(lat_c, lon_c)	Computes an estimate of land fraction for a scene with centre of (lon_c,lat_c) +/- swath width to deduce whether the correct mask is "LAND", "OCEAN", or "COAST"

orbitx.utils._constants.SATELLITE_DICT

Dictionary containing the short name (as keys) and full name (as values) of the satellites supported by this package. To add more satellites, obtain the TLE’s of the desired satellite (using celestrak), and add them as a file with name TLEset_<sat_short_name>.txt (replacing <sat_short_name> accordingly) in the data/tle folder. Then, add the "short_name": "full-name" pair to the dictionary above.

orbitx.utils._constants.EARTH_RADIUS

Earth radius in kilometers

orbitx.utils._constants.CM

Constant for conversion of inches into centimeters (used for plots)