Platform
Description
A Platform object defines a platform in a satellite scenario. A platform can be a moving site, aircraft, or a ship.
Creation
You can create Platform
objects using the platform
function of
the satelliteScenario
object.
Properties
Name
— Platform name
string scalar | string vector | character vector | cell array of character vectors
You can set this property only when calling the platform
function.
After you call platform
function, this property is read-only.
Platform 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.
String scalar or character vector when you add only one platform.
String scalar or character vector when you add multiple platforms and all platforms have the same name.
String vector or cell array of character vectors when you add multiple platforms and each platform has a unique name. The number of elements in the string vector or cell array of character vectors must equal the number of platforms.
Data Types: string
ID
— Platform ID assigned by simulator
real positive scalar
This property is set internally by the simulator and is read-only.
Platform ID assigned by the simulator, specified as a positive scalar.
ConicalSensors
— Conical sensors
row vector of conical sensors
You can set this property only when calling
the conicalSensor
. After you
call the conicalSensor
function, this property is read-only.
Conical sensors attached to the Platform, specified as a row vector of conical sensors.
Transmitters
— Transmitters attached to Platform
row vector of Transmitter
objects
You can set this property only when calling transmitter
function. After you call the
transmitter
function, this property is read-only.
Transmitters attached to the Platform, specified as a row vector of Transmitter
objects.
Accesses
— Access analysis objects
row vector of Access
objects
You can set this property only when calling access
.
After you call access
, this property is
read-only.
Access analysis objects, specified as a row vector of
Access
objects.
GroundTrack
— Ground track of Platform
row vector of GroundTrack
objects
You can set this property only when calling the groundTrack
function. After you call the groundTrack
function, this property is read-only.
Ground track of the Platform, specified as a row vector of GroundTrack
objects.
CoordinateAxes
— Coordinate axes triad graphic object
CoordinateAxes
object (default)
You can set this property only when calling coordinateAxes
.
After you call coordinateAxes
,
this property is read-only.
Coordinate axes triad graphic object, specified as CoordinateAxes
object.
Path
— Path graphic
Path
object
Path visualization for a platform, specified as a Path
object. Only these object properties are relevant for this function.
LineColor
— Color of path
[0.494 0.184 0.556]
(default) | RGB triplet | hexadecimal color code | 'r'
| 'g'
| 'b'
Color of the path, 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 from0
toF
. 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 Name | Short Name | RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|---|---|
"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 applicable | Not applicable | Not applicable | No color |
Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB® uses in many types of plots.
RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|
[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'
LineWidth
— Visual width of path
1
(default) | scalar in the range (0, 10)
Visual width of the path 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.
VisibilityMode
— Visibility mode of path graphic
'inherit'
(default) | 'manual'
Visibility mode of the path graphic in the satellite scenario viewer, specified as one of these values.
'inherit'
— Visibility of the path graphic matches that of the parent platform.'manual'
— Visibility of the path graphic is not inherited and is independent of the parent platform.
Note
Path graphic is always invisible in 2-D viewers.
Data Types: char
| string
MarkerColor
— Color of marker
[0.494 0.184 0.556]
(default) |
RGB triplet
|
string scalar of color name
|
character vector of color name
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 string scalar or character vector that starts with a hash symbol (
#
) followed by three or six hexadecimal digits, which can range from0
toF
. 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 Name | Short Name | RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|---|---|
"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"
|
|
Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.
RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|
[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"
|
|
MarkerSize
— Size of marker
10
(default) | positive scalar less than 30
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.
ShowLabel
— State of Platform label visibility
true
or
1
(default) | false
or 0
State of Platform 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
LabelFontColor
— Font color of Platform label
[1,0,0]
(default) | RGB triplet
| string scalar of color name
| character vector of color name
Font color of the Platformlabel, 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 string scalar or character vector that starts with a hash symbol (
#
) followed by three or six hexadecimal digits, which can range from0
toF
. 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 Name | Short Name | RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|---|---|
"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"
|
|
Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.
RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|
[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"
|
|
LabelFontSize
— Font size of Platform label
15
(default) | positive scalar in the range [6 30]
Font size of the Platform label, specified as a comma-separated pair consisting of
'LabelFontSize'
and a positive scalar in the range [6
30].
Visual3DModel
— Name of 3-D model file
zero-length string (default)
Name of the visual 3-D model file that you want to render in the viewer, specified as a string with .GLTF, .GLB, or .STL extension. For GLB and GLTF models, gITF uses a right-hand coordinate system. gITF defines +Y as up, and +Z as forward, and -X as right. A gITF asset faces +Z. For more information, see https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html#coordinate-system-and-units. The mesh of the GLB is in meters.
Note
You can set this property NarrowBodyAirliner.glb
to add a 3-D
model of an aircraft to satellite scenario viewer.
Data Types: string
Visual3DModelScale
— Linear scaling of 3-D model
1
(default) | nonnegative integer
Linear scaling of the visual 3-D model rendered in the viewer, specified as a nonnegative integer. The scaling assumes that the GLB model is in meters.
Data Types: double
Object Functions
access | Add access analysis objects to satellite scenario |
aer | Calculate azimuth angle, elevation angle, and range of another satellite or ground station in NED frame |
dopplershift | Calculate Doppler shift at target asset in satellite scenario |
latency | Calculate propagation delay from one asset to another asset |
conicalSensor | Add conical sensor to satellite scenario |
gimbal | Add gimbal to satellite, platform, or ground station |
groundTrack | Add ground track object to satellite or platform in scenario |
coordinateAxes | Visualize coordinate axes triad of satellite scenario assets |
receiver | Add receiver to satellite scenario |
transmitter | Add transmitter to satellite scenario |
states | Obtain position and velocity of satellite or platform |
path | Visualize platform path in satellite scenario |
show | Show object in satellite scenario viewer |
hide | Hide satellite scenario entity from viewer |
Examples
Visualize Platform Using geoTrajectory
Create a scenario using satelliteScenario
.
sc = satelliteScenario(); viewer = satelliteScenarioViewer(sc);
Consider an aircraft taking off from Delhi International Airport, flying over Bangalore, and then landing in Dubai. The total flying time is three hours. Create a trajectory using geoTrajectory
.
trajectory = geoTrajectory([28.5567,77.1006,10600;13.1989,77.7068,30600;25.2566,55.3641,5600],[0,3600,3*3600],AutoPitch=true,AutoBank=true);
Add a platform to the satellite scenario based on the trajectory.
pltf = platform(sc,trajectory)
pltf = Platform with properties: Name: Platform 1 ID: 1 ConicalSensors: [1x0 matlabshared.satellitescenario.ConicalSensor] Gimbals: [1x0 matlabshared.satellitescenario.Gimbal] Transmitters: [1x0 satcom.satellitescenario.Transmitter] Receivers: [1x0 satcom.satellitescenario.Receiver] Accesses: [1x0 matlabshared.satellitescenario.Access] Eclipse: [1x0 Aero.satellitescenario.Eclipse] GroundTrack: [1x1 matlabshared.satellitescenario.GroundTrack] Path: [1x1 matlabshared.satellitescenario.Path] CoordinateAxes: [1x1 matlabshared.satellitescenario.CoordinateAxes] MarkerColor: [0.7176 0.2745 1] MarkerSize: 6 ShowLabel: true LabelFontColor: [1 1 1] LabelFontSize: 15 Visual3DModel: Visual3DModelScale: 1
hide(pltf.Path); show(pltf.GroundTrack);
Play viewer.
play(sc);
References
[1] Hoots, Felix R., and Ronald L. Roehrich. Models for propagation of NORAD element sets. Aerospace Defense Command Peterson AFB CO Office of Astrodynamics, 1980.
Version History
Introduced in R2024a
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)