Main Content

Satellite

Satellite object belonging to satellite scenario

    Description

    Satellite defines a satellite object belonging to a satellite scenario.

    Creation

    You can create Satellite objects using the satellite method of satelliteScenario.

    Properties

    expand all

    Orbit object parameters for a satellite, specified as an orbit object. Only these object properties are relevant for this function.

    Color of the orbit, 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 character vector or a string scalar 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. Thus, 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'

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

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

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

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

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

    'black''k'[0 0 0]'#000000'

    'white''w'[1 1 1]'#FFFFFF'

    'none'Not applicableNot applicableNot applicableNo color

    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'

    [0.8500 0.3250 0.0980]'#D95319'

    [0.9290 0.6940 0.1250]'#EDB120'

    [0.4940 0.1840 0.5560]'#7E2F8E'

    [0.4660 0.6740 0.1880]'#77AC30'

    [0.3010 0.7450 0.9330]'#4DBEEE'

    [0.6350 0.0780 0.1840]'#A2142F'

    Example: 'blue'

    Example: [0 0 1]

    Example: '#0000FF'

    Visual width of 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.

    Visibility mode of orbit graphic, specified as one of these values:

    • 'inherit' — Visibility of the graphic matches that of the parent

    • 'manual' — Visibility of the graphic is not inherited and is independent of that of the parent

    Data Types: char | string

    You can set this property only when calling Satellite. After you call Satellite, this property is read-only.

    Access analysis objects, specified as a row vector of Access objects.

    Color of the marker, specified as a comma-separated pair consisting of 'MarkerColor' and either an RGB triplet or a string or character vector of a color 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 character vector or a string scalar 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. Thus, 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'

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

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

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

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

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

    'black''k'[0 0 0]'#000000'

    'white''w'[1 1 1]'#FFFFFF'

    'none'Not applicableNot applicableNot applicableNo color

    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'

    [0.8500 0.3250 0.0980]'#D95319'

    [0.9290 0.6940 0.1250]'#EDB120'

    [0.4940 0.1840 0.5560]'#7E2F8E'

    [0.4660 0.6740 0.1880]'#77AC30'

    [0.3010 0.7450 0.9330]'#4DBEEE'

    [0.6350 0.0780 0.1840]'#A2142F'

    Size of the marker, specified as a comma-separated pair consisting of 'MarkerSize' and a real positive scalar less than 30. The unit is in pixels.

    State of Satellite label visibility, specified as a comma-separated pair consisting of 'ShowLabel' and numerical or logical value of 1 (true) or 0 (false).

    Data Types: logical

    Font size of the Satellite label, specified as a comma-separated pair consisting of 'LabelFontSize' and a positive scalar less than 30.

    Font color of the Satellitelabel, specified as a comma-separated pair consisting of 'LabelFontColor' and either an RGB triplet or a string or character vector of a color 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 character vector or a string scalar 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. Thus, 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'

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

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

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

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

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

    'black''k'[0 0 0]'#000000'

    'white''w'[1 1 1]'#FFFFFF'

    'none'Not applicableNot applicableNot applicableNo color

    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'

    [0.8500 0.3250 0.0980]'#D95319'

    [0.9290 0.6940 0.1250]'#EDB120'

    [0.4940 0.1840 0.5560]'#7E2F8E'

    [0.4660 0.6740 0.1880]'#77AC30'

    [0.3010 0.7450 0.9330]'#4DBEEE'

    [0.6350 0.0780 0.1840]'#A2142F'

    You can set this property only when calling Satellite. After you call Satellite, this property is read-only.

    Satellite name, specified as a comma-separated pair consisting of 'Name' and a string scalar, string vector, character vector or a cell array of character vectors.

    • If only one Satellite is added, specify Name as a string scalar or a character vector.

    • If multiple Satellites are added, specify Name as a string vector or a cell array of character vectors. The number of elements in the string vector or cell array must be equal to the number of satellites being added.

    In the default value, idx is the count of the Satellite added by the Satellite object function. If another Satellite of the same name exists, a suffix _idx2 is added, where idx2 is an integer that is incremented by 1 starting from 1 until the name duplication is resolved.

    Data Types: char | string

    This property is set internally by the simulator and is read-only.

    Satellite ID assigned by the simulator, specified as a positive scalar.

    You can set this property only when calling conicalSensor. After you call conicalSensor, this property is read-only.

    Conical sensors attached to the Satellite, specified as a row vector of conical sensors.

    You can set this property only when calling gimbal. After you call gimbal, this property is read-only.

    Gimbals attached to the Satellite, specified as the comma-separated pair consisting of 'Gimbals' and a row vector of Gimbal objects.

    You can set this property when calling satellite only. After you call satellite, this property is read-only.

    Name of the orbit propagator used for propagating satellite position and velocity, specified as the comma-separated pair consisting of 'OrbitPropagator' and either "two-body-keplerian", "sgp4", "sdp4", or "ephemeris".

    Dependencies

    OrbitPropagator is not available for ephemeris data inputs (timetable or timeseries). In these cases, satellite ignores this name-value pair.

    Data Types: string | char

    Object Functions

    accessAdd access analysis objects to satellite scenario
    statesPosition and velocity of satellite
    conicalSensorAdd conical sensor to satellite scenario
    pointAtTarget at which entity must be pointed
    gimbalAdd gimbal to satellite or ground station
    showShow object in satellite scenario viewer
    aerCalculate azimuth angle, elevation angle, and range in NED frame from another satellite or ground station
    hideHides satellite scenario entity from viewer
    groundTrackAdd ground track object to satellite in scenario
    orbitalElementsOrbital elements of satellites in scenario
    Introduced in R2021a