PAMpal1.4.4 package

Load and Process Passive Acoustic Data

AcousticEvent-class

AcousticEvent Class

AcousticStudy-class

AcousticStudy Class

addAnnotation

Add Annotation Data to an AcousticStudy Object

addBinaries

Add Binaries to a PAMpalSettings Object

addCalibration

Add a Calibration File to a PAMpalSettings Object

addDatabase

Add a Database to a PAMpalSettings Object

addFPOD

Add FPOD Detector to an AcousticStudy

addFunction

Add a Function to a PAMpalSettings Object

addGps

Add GPS Locations to an AcousticStudy

addHydrophoneDepth

Add Hydrophone Depth Data to an AcousticStudy

addMeasures

Add Measures

addNote

addNote

addRecordings

Add Recordings to an AcousticStudy Object

addSettings

Add Settingss to a PAMpalSettings Object

addWaveHeight

Add Wave Height Data to an AcousticStudy

bindStudies

Combine AcousticStudy Objects

calculateAverageSpectra

Calculate Average Spectra of Clicks

calculateEchoDepth

Calculate Depth from Echoes

calculateICI

Calculate Inter-Click Interval

calculateModuleData

Run Custom Calculations on Pamguard Module Data

checkStudy

Check an AcousticStudy Object for Issues

export_banter

Export Data for a BANTER Model

filter

Filter an AcousticStudy or AcousticEvent Object

filterEchoDepths

Filter Candidate Echo Depths

getBinaryData

Get Raw Binary Data for Detections

getClipData

Get Wav Clips of Data

getDetectorData

Extract and Combine Detector Data

getWarnings

Get Warning Messages

is.AcousticEvent

Check if an Object is an AcousticEvent

is.AcousticStudy

Check if an Object is an AcousticStudy

is.PAMpalSettings

Check if an Object is a PAMpalSettings

loadPamguardXML

Load Pamguard XML Settings

markAnnotated

Mark Detections as Annotated

matchEnvData

Match Environmental Data to an AcousticStudy Object

matchTimeData

Match time-based data to PAMpal objects

PAMpal.accessors

AcousticEvent and AcousticStudy accessors

PAMpalSettings-class

PAMpalSettings Class

PAMpalSettings

Constructor for PAMpalSettings Object

plotDataExplorer

Explore Data in an Interactive Shiny Plot

plotGram

Plot Spectrogram or Cepstrogram

plotWaveform

Plot Graphical Representations of Waveforms

processPgDetections

Load and Process Detections from Pamguard

removeBinaries

Remove Binaries from a PAMpalSettings Object

removeCalibration

Remove a Calibration Function from a PAMpalSettings Object

removeDatabase

Remove a Database from a PAMpalSettings Object

removeFunction

Remove a Function from a PAMpalSettings Object

removeNote

removeNote

removeSettings

Remove Settings from a PAMpalSettings Object

roccaWhistleCalcs

Calculate a Set of Measurements for Whistles

runDepthReview

Run Echo Depth Review App

runIciReview

Run ICI Review App

sampleDetector

Subsample Detectors in AcousticStudy

setSpecies

Set the Species Classification of Events

standardCepstrumCalcs

Calculate a Set of Measurements from a Cepstrum Contour

standardClickCalcs

Calculate a Set of Measurements for Clicks

summariseDiveDepth

Summarise Dive Depth

updateFiles

Update Location of Files in an AcousticStudy

updatePamObject

Update PAMpal S4 Object

writeEventClips

Create Wav Clips of Data

writeWignerData

Write Wigner Transform Data of Click Detections to Disk

Tools for loading and processing passive acoustic data. Read in data that has been processed in 'Pamguard' (<https://www.pamguard.org/>), apply a suite processing functions, and export data for reports or external modeling tools. Parameter calculations implement methods by Oswald et al (2007) <doi:10.1121/1.2743157>, Griffiths et al (2020) <doi:10.1121/10.0001229> and Baumann-Pickering et al (2010) <doi:10.1121/1.3479549>.

  • Maintainer: Taiki Sakai
  • License: GNU General Public License
  • Last published: 2025-03-04