DefineAcousticPSU: Acoustic PSU

In StoXProject/RstoxBase: Base StoX Functions

Acoustic PSU

Description

Defines the AcousticPSU process data, linking strata, acoustic PSUs and EDSUs.

Usage

DefineAcousticPSU(
  processData,
  UseProcessData = FALSE,
  StratumPolygon,
  StoxAcousticData,
  DefinitionMethod = c("Manual", "EDSUToPSU", "DeleteAllPSUs", "PreDefined",
    "ResourceFile"),
  FileName = character(),
  AcousticPSU
)

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.
StratumPolygon	The StratumPolygon process data.
StoxAcousticData	StoxAcousticData (defined in RstoxData).
DefinitionMethod	Character: A string naming the method to use, one of "Manual" for manual tagging of EDUSs to PSUs; "EDSUToPSU", which sets each EDSU as a PSU; "DeleteAllPSUs" to delete all PSUs; "PreDefined" to read from a previous process; and "ResourceFile" to read from a project.xml file from StoX <= 2.7. Note that in the latter case it is assumed that the contents of the project.xml file is actually used in the StoX <= 2.7 project, i.e. that UseProcessData = TRUE in DefineAcousticPSU().
FileName	The path to a resource file from which to read PSUs, in the case that DefinitionMethod is "ResourceFile". Currently, only a project.xml file from StoX 2.7 can be read. Must include file extension.
AcousticPSU	The AcousticPSU process data.

Value

An object of StoX data type AcousticPSU.

See Also

Biotic PSUs are generated using DefineBioticPSU. For the vertical resolution (Layer) see DefineBioticLayer and DefineAcousticLayer.

StoXProject/RstoxBase documentation built on Nov. 6, 2024, noon