ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE

class TLE(*args, **kwargs)

Bases: pybind11_object

A Two-Line Element set (TLE).

A TLE is a data format encoding a list of orbital elements of an Earth-orbiting object for a given point in time

Reference:

https://en.wikipedia.org/wiki/Two-line_element_set

Overloaded function.

  1. __init__(self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE, first_line: ostk.core.type.String, second_line: ostk.core.type.String) -> None

    Constructor.

    Args:

    first_line (str): The first line of the TLE. second_line (str): The second line of the TLE.

  2. __init__(self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE, satellite_name: ostk.core.type.String, first_line: ostk.core.type.String, second_line: ostk.core.type.String) -> None

    Constructor.

    Args:

    satellite_name (str): The name of the satellite. first_line (str): The first line of the TLE. second_line (str): The second line of the TLE.

Methods

can_parse

Check if a TLE can be parsed from two strings.

construct

Overloaded function.

generate_checksum

Generate the checksum of a string.

get_aop

Get the argument of perigee.

get_b_star_drag_term

Get the B* drag term.

get_classification

Get the classification.

get_eccentricity

Get the eccentricity.

get_element_set_number

Get the element set number.

get_ephemeris_type

Get the ephemeris type.

get_epoch

Get the epoch.

get_first_line

Get the first line of the TLE.

get_first_line_checksum

Get the checksum of the first line.

get_inclination

Get the inclination.

get_international_designator

Get the international designator.

get_mean_anomaly

Get the mean anomaly.

get_mean_motion

Get the mean motion.

get_mean_motion_first_time_derivative_divided_by_two

Get the mean motion first time derivative divided by two.

get_mean_motion_second_time_derivative_divided_by_six

Get the mean motion second time derivative divided by six.

get_raan

Get the right ascension of the ascending node.

get_revolution_number_at_epoch

Get the revolution number at epoch.

get_satellite_name

Get the name of the satellite.

get_satellite_number

Get the satellite number.

get_second_line

Get the second line of the TLE.

get_second_line_checksum

Get the checksum of the second line.

is_defined

Check if the TLE object is defined.

load

Load a TLE from a file.

parse

Parse a TLE from a string.

set_epoch

Set the epoch.

set_revolution_number_at_epoch

Set the revolution number at epoch.

set_satellite_number

Set the satellite number.

undefined

Create an undefined TLE object.

static can_parse(
first_line: ostk.core.type.String,
second_line: ostk.core.type.String,
) bool

Check if a TLE can be parsed from two strings.

Parameters:
  • first_line (str) -- The first line of the TLE.

  • second_line (str) -- The second line of the TLE.

Returns:

True if the TLE can be parsed, False otherwise.

Return type:

bool

static construct(*args, **kwargs)

Overloaded function.

  1. construct(satellite_name: ostk.core.type.String, satellite_number: ostk.core.type.Integer, classification: ostk.core.type.String, international_designator: ostk.core.type.String, epoch: ostk.physics.time.Instant, mean_motion_first_time_derivative_divided_by_two: ostk.core.type.Real, mean_motion_second_time_derivative_divided_by_six: ostk.core.type.Real, b_star_drag_term: ostk.core.type.Real, ephemeris_type: ostk.core.type.Integer, element_set_number: ostk.core.type.Integer, inclination: ostk.physics.unit.Angle, raan: ostk.physics.unit.Angle, eccentricity: ostk.core.type.Real, aop: ostk.physics.unit.Angle, mean_anomaly: ostk.physics.unit.Angle, mean_motion: ostk.physics.unit.Derived, revolution_number_at_epoch: ostk.core.type.Integer) -> ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE

    Construct a TLE.

    Args:

    satellite_name (str): The name of the satellite. satellite_number (int): The satellite number. classification (str): The classification. international_designator (str): The international designator. epoch (Instant): The epoch. mean_motion_first_time_derivative_divided_by_two (float): The mean motion first time derivative divided by two. mean_motion_second_time_derivative_divided_by_six (float): The mean motion second time derivative divided by six. b_star_drag_term (float): The B* drag term. ephemeris_type (int): The ephemeris type. element_set_number (int): The element set number. inclination (Angle): The inclination. raan (Angle): The right ascension of the ascending node. eccentricity (float): The eccentricity. aop (Angle): The argument of perigee. mean_anomaly (Angle): The mean anomaly. mean_motion (float): The mean motion. revolution_number_at_epoch (int): The revolution number at epoch.

    Returns:

    TLE: The constructed TLE.

  2. construct(satellite_number: ostk.core.type.Integer, classification: ostk.core.type.String, international_designator: ostk.core.type.String, epoch: ostk.physics.time.Instant, mean_motion_first_time_derivative_divided_by_two: ostk.core.type.Real, mean_motion_second_time_derivative_divided_by_six: ostk.core.type.Real, b_star_drag_term: ostk.core.type.Real, ephemeris_type: ostk.core.type.Integer, element_set_number: ostk.core.type.Integer, inclination: ostk.physics.unit.Angle, raan: ostk.physics.unit.Angle, eccentricity: ostk.core.type.Real, aop: ostk.physics.unit.Angle, mean_anomaly: ostk.physics.unit.Angle, mean_motion: ostk.physics.unit.Derived, revolution_number_at_epoch: ostk.core.type.Integer) -> ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE

    Construct a TLE.

    Args:

    satellite_number (int): The satellite number. classification (str): The classification. international_designator (str): The international designator. epoch (Instant): The epoch. mean_motion_first_time_derivative_divided_by_two (float): The mean motion first time derivative divided by two. mean_motion_second_time_derivative_divided_by_six (float): The mean motion second time derivative divided by six. b_star_drag_term (float): The B* drag term. ephemeris_type (int): The ephemeris type. element_set_number (int): The element set number. inclination (Angle): The inclination. raan (Angle): The right ascension of the ascending node. eccentricity (float): The eccentricity. aop (Angle): The argument of perigee. mean_anomaly (Angle): The mean anomaly. mean_motion (float): The mean motion. revolution_number_at_epoch (int): The revolution number at epoch.

    Returns:

    TLE: The constructed TLE.

static generate_checksum(string: ostk.core.type.String) ostk.core.type.Integer

Generate the checksum of a string.

Parameters:

string (str) -- The string.

Returns:

The checksum.

Return type:

int

get_aop(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.physics.unit.Angle

Get the argument of perigee.

Returns:

The argument of perigee.

Return type:

Angle

get_b_star_drag_term(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.Real

Get the B* drag term.

Returns:

The B* drag term.

Return type:

float

get_classification(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.String

Get the classification.

Returns:

The classification.

Return type:

str

get_eccentricity(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.Real

Get the eccentricity.

Returns:

The eccentricity.

Return type:

float

get_element_set_number(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.Integer

Get the element set number.

Returns:

The element set number.

Return type:

int

get_ephemeris_type(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.Integer

Get the ephemeris type.

Returns:

The ephemeris type.

Return type:

int

get_epoch(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.physics.time.Instant

Get the epoch.

Returns:

The epoch.

Return type:

Instant

get_first_line(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.String

Get the first line of the TLE.

Returns:

The first line of the TLE.

Return type:

str

get_first_line_checksum(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.Integer

Get the checksum of the first line.

Returns:

The checksum of the first line.

Return type:

int

get_inclination(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.physics.unit.Angle

Get the inclination.

Returns:

The inclination.

Return type:

Angle

get_international_designator(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.String

Get the international designator.

Returns:

The international designator.

Return type:

str

get_mean_anomaly(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.physics.unit.Angle

Get the mean anomaly.

Returns:

The mean anomaly.

Return type:

Angle

get_mean_motion(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.physics.unit.Derived

Get the mean motion.

Returns:

The mean motion.

Return type:

float

get_mean_motion_first_time_derivative_divided_by_two(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.Real

Get the mean motion first time derivative divided by two.

Returns:

The mean motion first time derivative divided by two.

Return type:

float

get_mean_motion_second_time_derivative_divided_by_six(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.Real

Get the mean motion second time derivative divided by six.

Returns:

The mean motion second time derivative divided by six.

Return type:

float

get_raan(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.physics.unit.Angle

Get the right ascension of the ascending node.

Returns:

The right ascension of the ascending node.

Return type:

Angle

get_revolution_number_at_epoch(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.Integer

Get the revolution number at epoch.

Returns:

The revolution number at epoch.

Return type:

int

get_satellite_name(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.String

Get the name of the satellite.

Returns:

The name of the satellite.

Return type:

str

get_satellite_number(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.Integer

Get the satellite number.

Returns:

The satellite number.

Return type:

int

get_second_line(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.String

Get the second line of the TLE.

Returns:

The second line of the TLE.

Return type:

str

get_second_line_checksum(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
) ostk.core.type.Integer

Get the checksum of the second line.

Returns:

The checksum of the second line.

Return type:

int

is_defined(self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE) bool

Check if the TLE object is defined.

Returns:

True if the TLE object is defined, False otherwise.

Return type:

bool

static load(
file: ostk.core.filesystem.File,
) ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE

Load a TLE from a file.

Parameters:

file (str) -- The path to the file.

Returns:

The loaded TLE.

Return type:

TLE

static parse(
string: ostk.core.type.String,
) ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE

Parse a TLE from a string.

Parameters:

string (str) -- The string to parse.

Returns:

The parsed TLE.

Return type:

TLE

set_epoch(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
epoch: ostk.physics.time.Instant,
) None

Set the epoch.

Parameters:

epoch (Instant) -- The epoch.

set_revolution_number_at_epoch(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
revolution_number: ostk.core.type.Integer,
) None

Set the revolution number at epoch.

Parameters:

revolution_number (int) -- The revolution number at epoch.

set_satellite_number(
self: ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE,
satellite_number: ostk.core.type.Integer,
) None

Set the satellite number.

Parameters:

satellite_number (int) -- The satellite number.

static undefined() ostk.astrodynamics.trajectory.orbit.model.sgp4.TLE

Create an undefined TLE object.

Returns:

The undefined TLE object.

Return type:

TLE