Receiver Efficiency Index¶
The receiver efficiency index is number between 0 and 1
indicating the amount of relative activity at each receiver compared to
the entire set of receivers, regardless of positioning. The function
takes a set detections and a deployment history of the receivers to
create a context for the detections. Both the amount of unique tags and
number of species are taken into consideration in the calculation.
The receiver efficiency index implement is implemented based on the paper Acoustic telemetry array evolution: From species- and project-specific designs to large-scale, multispecies, cooperative networks. Each receiver’s index is calculated on the formula of:
REI = \(\frac{T_r}{T_a} \times \frac{S_r}{S_a} \times \frac{DD_r}{DD_a} \times \frac{D_a}{D_r}\)
- REI = Receiver Efficiency Index
- \(T_r\) = The number of tags detected on the receievr
- \(T_a\) = The number of tags detected across all receivers
- \(S_r\) = The number of species detected on the receiver
- \(S_a\) = The number of species detected across all receivers
- \(DD_a\) = The number of unique days with detections across all receivers
- \(DD_r\) = The number of unique days with detections on the receiver
- \(D_a\) = The number of days the array was active
- \(D_r\) = The number of days the receiver was active
Each REI is then normalized against the sum of all considered stations.
The result is a number between 0 and 1 indicating the relative
amount of activity at each receiver.
Warning
Detection input files must include datecollected, fieldnumber, station, and scientificname as columns and deployment input files must include station_name, deploy_date, last_download, and recovery_date as columns.
REI() takes two arguments. The first is a dataframe of detections
the detection timstamp, the station identifier, the species, and the tag
identifier. The next is a dataframe of deployments for each station. The
station name should match the stations in the detections. The
deployments need to include a deployment date and recovery date or last
download date. Details on the columns metnioned see the preparing data
section.
Warning
This function assumes that no deployments for single station overlap. If deployments do overlap, the overlapping days will be counted twice.
from resonate.receiver_efficiency import REI
detections = pd.read_csv('/path/to/detections.csv')
deployments = pd.read_csv('/path/to/deployments.csv')
station_REIs = REI(detections = detections, deployments = deployments)
Residence Index Functions¶
-
receiver_efficiency.REI(detections, deployments)¶ Calculates a returns a list of each station and the REI (defined here):
Parameters: - detections – a pandas DataFrame of detections
- deployments – a pandas DataFrame of station deployment histories
Returns: a pandas DataFrame of station, REI, latitude, and longitude