Subsea Altitude

R2026b

Compute altitude of vehicle relative to local seafloor surface

Since R2026b

expand all in page
  • Subsea Altitude block

Libraries:
Aerospace Blockset Maritime Applications Library / Environment

Description

Add-On Required: This feature requires the Aerospace Blockset Maritime Applications Library add-on.

The Subsea Altitude block computes the altitude of a vehicle relative to a local seafloor surface.

Ports

Input

expand all

Terrain elevation at which the block computes the distance from the seafloor, specified as a N-by-M matrix of real finite values in the units specified in Units. N and M must be greater than 1

Data Types: double

Object position in the Flat Earth reference frame for which to compute seabed altitude, specified as a 3-by-1 vector of real finite values in the units specified in Units.

Dependencies

To enable this port, set the Reference system parameter to Flat Earth.

Data Types: double

Latitude and longitude, specified as a 2-by-1 vector of values where -90 less than or equal to latitude less than or equal to 90, and -180 less than or equal to longitude less than or equal to 180.

Dependencies

To enable this port, set Reference system to WGS84.

Data Types: double

Ellipsoidal height, specified as a finite real scalar in the units specified in Units.

Dependencies

To enable this port, set Reference system to WGS84.

Data Types: double

Geoid undulation, specified as a real finite scalar.

Dependencies

To enable this port:

Data Types: double

Output

expand all

Altitude above terrain, returned as a scalar in the units specified in Units.

Data Types: double

Parameters

expand all

To edit block parameters interactively, use the Property Inspector. From the Simulink® Toolstrip, on the Simulation tab, in the Prepare gallery, select Property Inspector.

Parameter and port units, specified as Metric (MKS) (m) or English (ft).

Programmatic Use

To set the block parameter value programmatically, use the set_param function.

To get the block parameter value programmatically, use the get_param function.

Parameter: units
Values: Metric (MKS) (default) | English

Example: set_param(gcb,"units","Metric (MKS)")

Earth model to interpret position inputs and compute seabed altitude, specified as Flat Earth or WGS84.

Programmatic Use

To set the block parameter value programmatically, use the set_param function.

To get the block parameter value programmatically, use the get_param function.

Parameter: referenceSystem
Values: Flat Earth (default) | WGS84

Example: set_param(gcb,"referenceSystem","Flat Earth")

Height reference surface, specified as Mean sea level, WGS84 ellipsoid, or Geoid.

Dependencies

To enable this parameter, set Reference system WGS84.

Programmatic Use

To set the block parameter value programmatically, use the set_param function.

To get the block parameter value programmatically, use the get_param function.

Parameter: verticalDatum
Values: Mean sea level (default) | WGS84 ellipsoid | Geoid

Example: set_param(gcb,"verticalDatum","Mean sea level")

Origin location to anchor the terrain and interpret position inputs in the selected reference system, specified as Center, Top-left, or Bottom-left.

Programmatic Use

To set the block parameter value programmatically, use the set_param function.

To get the block parameter value programmatically, use the get_param function.

Parameter: originLocation
Values: Center (default) | Top-left | Bottom-left

Example: set_param(gcb,"originLocation","Center")

Spatial detail of the seabed terrain, determined by the number of heightmap grid points over the terrain physical extent, specified as a real scalar with these units.

  • When Reference system is WGS84, the units are specified in arc-seconds.

  • When Reference system is Flat Earth, the units are specified in Units.

Programmatic Use

To set the block parameter value programmatically, use the set_param function.

To get the block parameter value programmatically, use the get_param function.

Parameter: resolution
Values: 1 (default) | real scalar
Data Types: double

Example: set_param(gcb,"resolution","1")

Origin location at which the block places the terrain and from which position inputs are measured in the selected reference system, specified as a 2-element vector.

Dependencies

  • When Reference system is set to Flat Earth, this parameter name is Origin [x, y].

  • When Reference system is set to WGS84, this parameter name is Origin [lat, lon], where lat is [-90, 90] and lon is [-180, 180], in degrees.

Programmatic Use

To set the block parameter value programmatically, use the set_param function.

To get the block parameter value programmatically, use the get_param function.

Parameter: origin
Values: [0 0] (default) | 2-element vector
Data Types: double

Example: set_param(gcb,"origin","[0 0]")

Programmatic Use: Add Block

To add the block programmatically, use the add_block function with one of these library block paths as the source.

"maritime_support_library/Environment/Subsea Altitude"

Example: add_block("maritime_support_library/Environment/Subsea Altitude","myModel/myBlock",MakeNameUnique="on")

For information about programmatic access to individual block parameters, see the Programmatic Use section of parameter descriptions on this page.

Version History

Introduced in R2026b

See Also

Topics