Main Content

updateMask

Updates visibility mask

Since R2025a

Description

updateMask(gs,Name=Value) updates the visibility mask of the ground station.

Note

When the AutoSimulate property of the satellite scenario is false, the updateMask function can be used while the SimulationStatus is NotStarted or InProgress.

example

Examples

collapse all

Create a satellite scenario object.

startTime = datetime(2020,5,1,11,36,0);
stopTime = startTime + days(1);
sampleTime = 60;   %seconds
sc = satelliteScenario(startTime,stopTime,sampleTime);

Add a groundstation and specify its parameters.

lat = 40;    % Latitude (degrees)
lon = -105.25; % Longitude (degrees)
maskaz = [0,180,360];    % Azimuth angles (degrees)
maskel = [0,9.3970];     % Elevation angles (degrees)
gs = groundStation(sc,lat,lon,MaskElevationAngle=maskel, MaskAzimuthEdges=maskaz)
gs = 
  GroundStation with properties:

                  Name:  Ground station 1
                    ID:  1
              Latitude:  40 degrees
             Longitude:  -105.25 degrees
              Altitude:  0 meters
    MaskElevationAngle:  [0 9.397]
      MaskAzimuthEdges:  [0 180 360]
        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]
        CoordinateAxes:  [1x1 matlabshared.satellitescenario.CoordinateAxes]
           MarkerColor:  [1 0.4118 0.1608]
            MarkerSize:  6
             ShowLabel:  true
        LabelFontColor:  [1 1 1]
         LabelFontSize:  15

Change the visibility mask using updateMask function.

updateMask(gs,MaskElevationAngle=[0,9.3970,8],MaskAzimuthEdges=[0,180,270,360])

Input Arguments

collapse all

Ground station, specified as a groundStation object.

Name-Value Arguments

collapse all

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.

Before R2021a, use commas to separate each name and value, and enclose Name in quotes.

Example: MaskElevationAngle=10 specifies a visibility mask elevation angle of 10 degrees.

Elevation angles for the visibility mask in degrees, specified as a scalar or an N-element row vector. This argument works with MaskAzimuthEdges to create a visibility mask. The length of the MaskElevationAngle row vector must be one element lesser than the MaskAzimuthEdges row vector. The value of all MaskElevationAngle angles must be from —90 to 90. N is m-1, where m is the number of elements in MaskAzimuthEdges.

Data Types: double

Azimuth angles for the visibility mask in degrees, specified a row vector. This argument works with MaskElevationAngle to create a visibility mask. The length of the MaskAzimuthEdges row vector must be one element more than the MaskElevationAngle row vector. The value of all MaskAzimuthEdges angles must be from 0 to 360 degrees. If you do not specify MaskAzimuthEdges, the function automatically generates this value for each ground station as a linearly spaced row vector.

Data Types: double

Version History

Introduced in R2025a