acoustic_evenness: Acoustic Evenness Index

Description Usage Arguments Value Note References Examples

View source: R/acoustic_evenness.R

Description

Acoustic Evenness Index from Villanueva-Rivera et al. 2011 (band evenness using the Gini index). The AEI is calculated by dividing the spectrogram into bins (default 10) and taking the proportion of the signals in each bin above a threshold (default -50 dBFS). The AEI is the result of the Gini index applied to these bins.

Usage

1
acoustic_evenness(soundfile, max_freq = 10000, db_threshold = -50, freq_step = 1000)

Arguments

soundfile

an object of class Wave loaded with the function readWave of the tuneR package.

max_freq

maximum frequency to use when calculating the value, in Hertz.

db_threshold

threshold to use in the calculation.

freq_step

size of frequency bands.

Value

Returns a list with five objects per channel

aei_left

AEI for the left channel

aei_right

AEI for the right channel

Note

For audio files with one channel, the results are showed as the left channel, the right channel returns NA.

References

Villanueva-Rivera, L. J., B. C. Pijanowski, J. Doucette, and B. Pekin. 2011. A primer of acoustic analysis for landscape ecologists. Landscape Ecology 26: 1233-1246. doi: 10.1007/s10980-011-9636-9.

Examples

1
2
3
4
5
6
	data(tropicalsound)
	result <- acoustic_evenness(tropicalsound)
	print(result$aei_left)
	
	summary(result)
	

soundecology documentation built on May 2, 2019, 3:21 a.m.