loadBackgroundNoise: Load and Format Background Noise Data

View source: R/loadBackgroundNoise.R

loadBackgroundNoiseR Documentation

Load and Format Background Noise Data

Description

Reads and formats background noise data from Pamguard binary files or if not present in the original file will try to read the accompanying .pgnf noise file if it exists

Usage

loadBackgroundNoise(x)

plotBackgroundNoise(x)

combineBackgroundNoise(x, forPlot = FALSE)

Arguments

x

character pointing to a Pamguard binary file, or a PamBinary object created by loadPamguardBinaryFile. For plotting or combining, either of these or the output from loadBackgroundNoise

forPlot

logical flag when combining noise data. If used for plotting purposes this will insert NA columns into background data so that images show up with time gaps as expected. Leave as FALSE unless you are sure you want this.

Value

A list with times storing the POSIXct time of each background measurement, and background a matrix of background values. For binary data based on spectrogram measurements, there will also be freq the frequency in Hertz for each column of background measurement

Author(s)

Taiki Sakai taiki.sakai@noaa.gov

Examples


# load the example click binary data, leaving date as numeric
gplFile <- system.file('extdata', 'GPL.pgdf', package='PamBinaries')
gplNoise <- loadBackgroundNoise(gplFile)
print(gplNoise)
plotBackgroundNoise(gplNoise)


PamBinaries documentation built on Feb. 16, 2023, 7:38 p.m.