Define Layers

Source: R/Define.R

This function defines the Layer process data, which sets the range intervals of layers used in estimation models in StoX.

DefineLayer(
  processData,
  UseProcessData = FALSE,
  StoxData,
  DefinitionMethod = c("WaterColumn", "HighestResolution", "Resolution", "Table"),
  Resolution = double(),
  LayerTable = data.table::data.table(),
  LayerType = c("Acoustic", "Biotic")
)

Arguments

processData

The current data produced by a previous instance of the function.

UseProcessData

Logical: If TRUE use the existing function output in the process.

StoxData

Either StoxBioticData or StoxAcousticData data.

DefinitionMethod

Character: A string naming the method to use, one of "WaterColumn", to define one single for the entire water column; "HighestResolution", to use the maximum possible vertical resolution without intersecting hauls; "Resolution", which can be used to set a fixed layer thickness; and "Table" to provide the LayerTable.

Resolution

Numeric: A single numeric giving the thickness of the layers.

LayerTable

A table of Layer name, MinLayerDepth in meters and MaxLayerDepth in meters, defining the Layers.

LayerType

Character: A string naming the type of model, either "Acoustic" or "Biotic".

Value

A table of layer intervals.