writeWignerData: Write Wigner Transform Data of Click Detections to Disk

In PAMpal: Load and Process Passive Acoustic Data

Write Wigner Transform Data of Click Detections to Disk

Description

Create Wigner-Ville transform data of click clips from all detections and save them to disk. A CSV file will also be written that lists all UIDs contained in the output

Usage

writeWignerData(
  x,
  n = 256,
  t = 300,
  outDir = ".",
  mode = "nparray",
  progress = TRUE,
  ...
)

Arguments

x	AcousticStudy object containing data to make Wigner data for
n	number of frequency bins for Wigner transform (recommended power of 2)
t	number of samples to use for the click clip passed to the transform
outDir	directory to write data to
mode	specifies the kind of output that will be created, currently only supports creating NumPy arrays using the reticulate package, in future will support image creation
progress	logical flag to show progress bar
...	optional arguments to pass

Value

A list with two items: files - a vector of file names for the Wigner data that were successfully created, any that were not able to be written will be NA, and warnings, a list with items containing event IDs that triggered any warnings

Author(s)

Taiki Sakai [e-mail]

Examples

data(exStudy)
exStudy <- setSpecies(exStudy, method='pamguard')
## Not run: 
# not running because files are written to disk
wigFiles <- writeWignerData(exStudy, outDir = 'WigFolder')

## End(Not run)

PAMpal documentation built on Aug. 12, 2023, 1:06 a.m.