DefineAcousticLayer: Define acoustic layer

In StoXProject/RstoxTempDoc: Temporary package for documenting the RstoxFramework package

Description

The DefineAcousticLayer function is used to specify the vertical range of one or more calculation Layers.

Usage

DefineAcousticLayer()

Arguments

parameterName

Parameter descrption.

Details

The DefineAcousticLayer function is used to specify the vertical range of one or more Layers. Layer resolution is equal to the vertical calculation cell resolution used for density estimation in other functions.

Acoustic input data to the function is of type StoXAcousticData (LINK) and has a vertical extent defined by pelagic and or bottom Channels. The thickness of each type of Channel in the input data are fixed for an EDSU, and each channel range is specified by the variable MinRange and MaxRange in the StoXAcousticData.

Through parameter ChannelReference, the user must determine whether to use pelagic or bottom referenced Channels to define Layers. Each Layer can be given a user specified name or a default name through the parameter Layer. From a dropdown list, a Layer is defined as a collection of continuous Channels. The dropdown list will at any given time only contain available remaining Channels and thus prevent overlap of Layer definitions. Output variables MinRange and MaxRange are updated to represent the vertical ranges of the defined Layers.

The DefineAcousticLayer function produces process data of type AcousticLayer (LINK) as a table with the variables Layer, ChannelReference, MinRange and MaxRange.

Value

A data.table is returned with awesome stuff.

See Also

roxygenize is used to generate the documentation.

Examples

x <- 1

StoXProject/RstoxTempDoc documentation built on Dec. 31, 2019, 1:50 p.m.