addFPOD: Add FPOD Detector to an AcousticStudy

View source: R/addFPOD.R

addFPODR Documentation

Add FPOD Detector to an AcousticStudy

Description

Adds data from FPOD detector CSV files to an AcousticStudy object as new detectors of type "fpod"

Usage

addFPOD(x, fpod, detectorName = "FPOD")

Arguments

x

an AcousticStudy object

fpod

path(s) to CSV files containing FPOD detector output

detectorName

name for the detector, the default 'FPOD' should be fine unless you want to differentiate between multiple FPOD detectors

Details

FPOD detections are added to events based on their times. All detections between the start and end times events. NOTE: most PAMpal functions were designed with only PAMGuard data in mind, there is a chance that adding FPOD detections will cause other advanced functionality to not work.

Behavior is slightly different depending on how the original AcousticStudy was created. For those processed with mode='db', the start and end times for each event are just determined by the times of detections within the event.

For those processed with mode='recording' or mode='time', the start and end times for each event are determined by the start/end times of the recording files or the grouping file provided initially. This means that it is possible that there are events which initially had zero PAMGuard detections that now have FPOD detections. In these cases a new AcousticEvent will be created that only has FPOD detections, these events may not work with a variety of other ]codePAMpal functions.

Value

the same object as x with FPOD detector data added

Author(s)

Taiki Sakai taiki.sakai@noaa.gov


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