Main Content

orbit

Visualize orbit in satellite scenario

Since R2024a

collapse all in page

    Syntax

    orbit(sat)
    orbit(___,Name=Value)

    Description

    o = orbit(sat) adds an orbit visualization for each satellite in the vector sat based on the current position of each satellite and returns a vector of orbit objects associated with the input satellites.

    The orbit is projected into the future and past by the number of seconds specified in LeadTime and TrailTime property of the Orbit object of the satellite. The resolution is the spacing between samples that make up the orbit visualization and is determined by the scenario sample time. If no Satellite Scenario Viewer is open, a new viewer is launched, and the orbit is displayed. If a viewer is already open, the orbit is added to that viewer. The orbit is always hidden in 2D viewers.

    orbit(___,Name=Value) adds orbit visualization for each satellite in the vector sat specified by name-value arguments.

    Input Arguments

    collapse all

    Satellite, specified as a row vector of Satellite objects.

    Name-Value Arguments

    Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

    Example: LeadTime=1000 sets the orbit lead time to 1000.

    Satellite Scenario Viewer, specified as a scalar satelliteScenarioViewer object.1

    Duration of future orbit to be visualized in the satellite scenario viewer, specified as a nonnegative scalar, in seconds.

    • When OrbitPropagator is set to 'ephemeris', the default value of LeadTime is the duration of the satellite scenario StartTime to StopTime.

    • When the orbit is parabolic or hyperbolic and OrbitPropagator is set to 'numerical', the default value of LeadTime is the duration of the satellite scenario StartTime to the time when the satellite reaches 145 times the equatorial radius of the Earth.

    • In all other cases, the default value of LeadTime is one orbital period.

    Duration of the orbit history to be visualized in Viewer, specified as 'TrailTime' and a nonnegative scalar in seconds.

    • When OrbitPropagator is set to 'ephemeris', the default value of TrailTime is the duration of the satellite scenario StartTime to StopTime.

    • When the orbit is parabolic or hyperbolic and OrbitPropagator is set to 'numerical', the default value of TrailTime is the duration of the satellite scenario StartTime to the time when the satellite reaches 145 times the equatorial radius of the Earth.

    • In all other cases, the default value of LeadTime is one orbital period.

    Visual width of the orbit, in pixels, specified as a scalar in the range (0 10].

    The line width cannot be thinner than the width of a pixel. If you set the line width to a value that is less than the width of a pixel on your system, the line displays as one pixel wide.

    Color of orbit line, specified as an RGB triplet, hexadecimal color code, a color name, or a short name.

    For a custom color, specify an RGB triplet or a hexadecimal color code.

    • An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range [0,1], for example, [0.4 0.6 0.7].

    • A hexadecimal color code is a string scalar or character vector that starts with a hash symbol (#) followed by three or six hexadecimal digits, which can range from 0 to F. The values are not case sensitive. Therefore, the color codes "#FF8800", "#ff8800", "#F80", and "#f80" are equivalent.

    Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

    Color NameShort NameRGB TripletHexadecimal Color CodeAppearance
    "red" "r" [1 0 0] "#FF0000"

    Sample of the color red

    "green" "g" [0 1 0] "#00FF00"

    Sample of the color green

    "blue" "b" [0 0 1] "#0000FF"

    Sample of the color blue

    "cyan" "c" [0 1 1] "#00FFFF"

    Sample of the color cyan

    "magenta" "m" [1 0 1] "#FF00FF"

    Sample of the color magenta

    "yellow" "y" [1 1 0] "#FFFF00"

    Sample of the color yellow

    "black" "k" [0 0 0] "#000000"

    Sample of the color black

    "white" "w" [1 1 1] "#FFFFFF"

    Sample of the color white

    Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB® uses in many types of plots.

    RGB TripletHexadecimal Color CodeAppearance
    [0 0.4470 0.7410] "#0072BD"

    Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue

    [0.8500 0.3250 0.0980] "#D95319"

    Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange

    [0.9290 0.6940 0.1250] "#EDB120"

    Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow

    [0.4940 0.1840 0.5560] "#7E2F8E"

    Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple

    [0.4660 0.6740 0.1880] "#77AC30"

    Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green

    [0.3010 0.7450 0.9330] "#4DBEEE"

    Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue

    [0.6350 0.0780 0.1840] "#A2142F"

    Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

    Example: 'blue'

    Example: [0 0 1]

    Example: '#0000FF'

    Version History

    Introduced in R2024a

    See Also

    Objects

    Functions

    Topics

    1 Alignment of boundaries and region labels are a presentation of the feature provided by the data vendors and do not imply endorsement by MathWorks®.