Function reference • sonicscrewdriver

All functions

Annotation-class: A S4 class for annotations

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_seqss_nearestStart(): Nearest start time

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

audio_filesize(): Calculated size of raw audio files

audioblast(): Get data or analyses from audioBlast

audioblastDownload(): Download audio files from audioBlast

audiomothConfig(): Read AudioMoth configuration file

audiomothWave(): Read AudioMoth metadata from a wave file

autoBandPass(): Automatic Band Pass Filter

bandpass(): Simple bandpass filter

beatComplexity(): Beat spectrum complexity

beatSpectrum(): Computes a beat spectrum

birdNetAnalyse(): Analyse sound files using BirdNET-Analyzer

birdNetInstall(): Install the BirdNET environment

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 bits 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

dayPhases(): Phases 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

dolbear(): Dolbear's law

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

filterWave(): Apply a WaveFilter object to a Wave object

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

gs_transcribe(): Google Speech API Transcribe

humanBytes(): Converts bytes in human readable form

humanTime(): Converts time to human readable form

jitter(): Calculate the jitter in a Wave object

labelPadding(): Pad labels with interval

labelReduction(): Combines labels which overlap into single continuous regions

map2RGB(): Map three vectors to RGB

naturalFrequency(): Calculate the natural frequency

normalise(): Normalise a Wave object

ntd(): Natural Time Domain

parseFilename(): Parse a filename

pd_dietrich2004(): Pulse detection using Dietrich (2004)

pd_simple(): Simplified pulse detection using Dietrich (2004)

`+`(<PseudoWave>,<numeric>): PseudoWave scalar addition

`+`(<numeric>,<PseudoWave>): Numeric addition by PseudoWave

pseudoWave(): Create a PseudoWave object

pulse(): Generate a single pulse

pulseDetection(): Pulse detection

pulseIntervals(): Pulse intervals

radarPower(): The radar equation

radarRange(): Radar range

radialPolygon(): Plot a radial polygon

rainfallDetection(): Rainfall detection

readAudacityLabels(): Read an Audacity label file

readAudio(): Read an audio file

readBirdNet(): Read output files from BirdNet Analyser

readRespeaker6(): Read a file from Seeed Studio Respeaker 6 mic array

referenceIntensity(): Reference intensity

referencePressure(): Reference pressure

region(): Specify a region with a file to analyse

resonantFrequency(): Calculate the resonant frequency

sDuration(): Sample duration

sheepFrequencyStats: Sheep frequencyStats

shimmer(): Calculate the shimmer in a Wave object

`/`(<PseudoWave>,<numeric>): PseudoWave scalar division

soundSpeed(): Calculate the speed of sound in a medium

specStats(): Calculate and plot statistics on a frequency spectrum

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

tagWave(): Tag a Wave or WaveMC object

`*`(<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

windowing(): Windowing Function for Wave Objects

writeAudacityLabels(): Write an Audacity label 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