Skip to contents

All functions

Annotation-class
A S4 class for annotations
AnnotationList2DataFrame()
Convert a list of Annotation objects to a data.frame
PseudoWave-class
An S4 class to represent a PseudoWave object that is converted to a Wave object when operated on.
`-`(<PseudoWave>,<numeric>)
PseudoWave scalar subtraction
STP
STP: Standard Temperature and Pressure
TaggedWave-class
A S4 class for tagged waves
TaggedWaveMC-class
A S4 class for tagged multi-channel waves
TimeRegion-class
An S4 class to represent a TimeRegion within a Wave object.
WaveFilter-class
WaveFilter object for audio filters
ab_diel_traits()
Convert text times of day in audioblast traits to numeric values
ab_range()
Make a range to filter audioBlast on
addProcess()
Add a process to a Tagged Wave or WaveMC object
addSpectra()
Add two spectra from seewave
allChannels()
Apply a function to all channels of a Wave or WaveMC object
annotation()
Create a new Annotation object
`audioMetadata<-`()
Attach metadata to a Wave object
audio_filesize()
Calculated size of raw audio files
audioblast()
Get data or analyses from audioBlast
audioblastDownload()
Download audio files from audioBlast
audioblastFilters()
List the filters of an audioBlast module
audioblastRecord()
Get one record from audioBlast
audiomothCompress()
Write a Wave as an AudioMoth triggered (T.WAV) file
audiomothConfig()
Read AudioMoth configuration file
audiomothExpand()
Expand an AudioMoth triggered (T.WAV) file
audiomothWave()
Read AudioMoth metadata from a wave file
autoBandPass()
Automatic Band Pass Filter
bandpass()
Simple bandpass filter
bearing()
Estimate the direction a sound arrived from
beatComplexity()
Beat spectrum complexity
beatSpectrum()
Computes a beat spectrum
bext()
Read Broadcast Wave metadata
birdNetAnalyse()
Analyse sound files using BirdNET-Analyzer
calculateMetadata()
Calculate what can be measured of a wave and the file it was read from
channels_se()
Channels for sound ecology
circularise()
Circularise a dataset
concat()
Concatenate two or more Wave-like objects.
convert2Celsius()
Convert temperature to Celsius
convert2Fahrenheit()
Convert temperature to Fahrenheit
convert2Kelvin()
Convert temperature to Kelvin
convert2Pascals()
Convert pressure to Pascals
convert2bytes()
Convert file sizes to bytes
convert2degrees()
Convert angle to degrees
convert2dyne_cm2()
Convert pressure to dyne per square centimetre
convert2radians()
Convert angle to radians
convert2seconds()
Convert time to seconds
corWaveMC()
Correlate channels in a WaveMC object
cutws()
Cut wave by samples
data2Wave()
Convert data into a Wave object
dayPhase()
Phase of day
daysPhases()
Phases of days
defaultCluster()
Create Default Cluster for Windowing
dielFraction()
Calculate the fraction of a day given by a value
dielHistogram()
Diel Histogram
dielLabels()
Generate labels for a diel plot
dielPlot()
Create a diel plot
dielPositions()
Generate positions of labels for a diel plot
dielRings()
Plot rings on a diel plot
disp()
Read the display name of a wave file
dolbear()
Dolbear's law
.annotation_check_overlap()
Check if two annotations overlap or are continuous
.merge_annotations()
Combine annotations helper function
.spectrogram_maad_dB()
Helper function to convert a Wave-like object to a dB scikit-maad spectrogram
.spectrogram_maad_power()
Helper function to convert a Wave-like object to scikit-maad spectrogram
.spectrum_maad()
Helper function to convert a Wave-like object to scikit-maad spectrum
dutyCycle()
Calculate the duty cycle of a wave
emptyDiel()
Create an empty diel plot
emptyYearly()
Create an empty yearly plot
entropyStats()
Various measurements of frequency values for a Wave object
fcis()
False-colour index spectrogram
fcisClip()
Percentile clipping for false-colour index spectrograms
fcisIndexNames()
Per-frequency-bin acoustic indices
fileSizeUnits()
Units used for file sizes
filterWave()
Apply a WaveFilter object to a Wave object
flattenOutput()
Flatten the output of a process into rows
frequencySound()
Get the frequency from wavelength and speed of sound
frequencyStats()
Various measurements of frequency values for a Wave object
generateNoise()
Add noise to a Wave like object
generateTimeMask()
Generate time masked Wave-like objects
generateTimeShift()
Generated time-shifted versions of a Wave-like object
getMaad()
Import scikit-maad
gs_transcribe()
Google Speech API Transcribe
`guano<-`()
Attach GUANO metadata to a Wave object
guano()
Read GUANO metadata
guanoCreate()
Create GUANO metadata
guanoParse()
Parse a block of GUANO metadata
guanoWrite()
Write GUANO metadata to a WAV file
humanBytes()
Converts bytes in human readable form
humanTime()
Converts time to human readable form
id3()
Read ID3 metadata
ixml()
Read the iXML metadata of a wave file
jitter()
Calculate the jitter in a Wave object
labelPadding()
Pad labels with interval
labelReduction()
Combines labels which overlap into single continuous regions
maad_acoustic_complexity_index()
Compute the acoustic complexity index using scikit-maad
maad_frequency_entropy()
Compute the frequency entropy using scikit-maad
maad_number_of_peaks()
Compute the number of peaks using scikit-maad
maad_spectral_activity()
Compute the spectral activity using scikit-maad
maad_spectral_entropy()
Compute the frequency entropy using scikit-maad
maad_spectrogram()
Compute a spectrogram of a sound wave using scikit-maad
maad_spectrum()
Compute a spectrum of a sound wave using scikit-maad
maad_temporal_activity()
Compute the acoustic activity index using scikit-maad
maad_temporal_entropy()
Compute the temporal entropy using scikit-maad
maad_temporal_events()
Compute the acoustic event index using scikit-maad
maad_temporal_median()
Compute the temporal envelope median using scikit-maad
map2RGB()
Map three vectors to RGB
merge_annotations()
Combine annotations
naturalFrequency()
Calculate the natural frequency
normalise()
Normalise a Wave object
ntd()
Natural Time Domain
`-`(<numeric>,<PseudoWave>)
Numeric subtraction by PseudoWave
olym()
Read what an Olympus recorder wrote about a recording
parseFilename()
Parse a filename
pd_dietrich2004()
Pulse detection using Dietrich (2004)
pd_simple()
Simplified pulse detection using Dietrich (2004)
pipeline() task()
Write an analysis as a pipeline of steps
pipelineResults()
Read the results of a pipeline from a store
plot(<fcis>)
Plot a false-colour index spectrogram
`+`(<PseudoWave>,<numeric>)
PseudoWave scalar addition
`+`(<numeric>,<PseudoWave>)
Numeric addition by PseudoWave
print(<wavChunks>)
Print the chunks of a wave file
pseudoWave()
Create a PseudoWave object
pulse()
Generate a single pulse
pulseDetection()
Pulse detection
pulseIntervals()
Pulse intervals
pythonInstall()
Install sonicscrewdriver Python environment
radarPower()
The radar equation
radarRange()
Radar range
radialPolygon()
Plot a radial polygon
rainfallDetection()
Rainfall detection
readAOEF()
Read an AOEF file
readAudacityLabels()
Read an Audacity label file
readAudio()
Read an audio file
readBirdNet()
Read output files from BirdNet Analyser
readMetadata()
Read every kind of metadata a file carries
readRespeaker6()
Read a file from Seeed Studio Respeaker 6 mic array
recordingSet()
A set of recordings
referenceIntensity()
Reference intensity
referencePressure()
Reference pressure
region()
Specify a region with a file to analyse
resonantFrequency()
Calculate the resonant frequency
runPipeline()
Run a pipeline over a set of recordings
sDuration()
Sample duration
sheepFrequencyStats
Sheep frequencyStats
shimmer()
Calculate the shimmer in a Wave object
`/`(<PseudoWave>,<numeric>)
PseudoWave scalar division
`/`(<numeric>,<PseudoWave>)
Numeric division by PseudoWave
sort_annotations()
Sort annotations
soundSpeed()
Calculate the speed of sound in a medium
specStats()
Calculate and plot statistics on a frequency spectrum
spectrogram_maad-class
An S4 class to represent a spectrogram from scikit-maad.
ste()
Short term energy
`[`(<Wave>,<TimeRegion>)
Allow subsetting a Wave object with a TimeRegion
subtractSpectra()
Subtract two spectra from seewave
sweptsine()
Generate a sine sweep
tSamples()
Samples per time period
tagApply()
Apply a function to a tagged wave and record the process
tagWave()
Tag a Wave or WaveMC object
tdoa()
Time differences of arrival between channels
`*`(<PseudoWave>,<numeric>)
PseudoWave scalar manipulation
`*`(<numeric>,<PseudoWave>)
Numeric multiplication by PseudoWave
typicalVolume()
Typical volumes
tzRot()
Converts a timezone offset into a rotation
untagWave()
Untag a TaggedWave or TaggedWaveMC object
upsample()
Upsample a wave
validateIsWave()
Check an object is a Wave object
vorbisComment()
Read Vorbis comments
wamd()
Read Wildlife Acoustics metadata
wavChunks()
List the RIFF chunks a wave file holds
wavCues()
Read the cue points and labels of a wave file
wavInfo()
Read the INFO metadata of a wave file
wavelength()
Get the wavelength from frequency and speed of sound
windowing()
Windowing Function for Wave Objects
writeAOEF()
Write an AOEF file
writeAnnotationWave()
Save a time region defined by an Annotation object as a Wave file
writeAudacityLabels()
Write an Audacity label file
writeAudio()
Write an audio file
xmp()
Read the XMP metadata of a wave file
yearlyFraction()
Calculate the fraction of a year given by a value
yearlyLabels()
Generate labels for a yearly plot
yearlyPlot()
Create a yearly plot
yearlyPositions()
Generate positions of labels for a yearly plot
zeroSpectrum()
Zero spectrum
zerocross()
Identify zero crossings in a Wave object