2.3. cpforager.AXY

class cpforager.AXY(df, group, id, params)

Bases: object

A class to represent the AXY data of a central-place foraging seabird.

__init__(df, group, id, params)

Constructor of an AXY object.

Parameters:

  • df (pandas.DataFrame) – the dataframe containing datetime, ax, ay, az, longitude, latitude, pressure and temperature columns. Type of datetime column must be datetime64.

  • group (str) – the string representing the group to which the AXY data belongs (e.g. species, year, fieldwork, etc.) useful for statistics and filtering.

  • id (str) – the string representing the unique identifier of the central-place foraging seabird.

  • params (dict) – the parameters dictionary.

Variables:

  • df (pandas.DataFrame) – the dataframe containing the raw and processed AXY data.

  • group (str) – The string representing the group to which the AXY data belongs (e.g. species, year, fieldwork, etc.) useful for statistics and filtering.

  • id (str) – The string representing the unique identifier of the central-place foraging seabird.

  • params (dict) – The dictionary containing the parameters used for the AXY data processing.

  • n_df (int) – the number of measures in the AXY recording.

  • gps (cpforager.GPS) – the GPS data of AXY at GPS resolution.

  • df_gps (pandas.DataFrame) – the dataframe containing AXY data at GPS resolution.

  • tdr (cpforager.TDR) – the TDR data of AXY at TDR resolution.

  • df_tdr (pandas.DataFrame) – the dataframe containing AXY data at TDR resolution.

  • start_datetime (datetime.datetime) – the starting datetime of the AXY recording.

  • end_datetime (datetime.datetime) – the ending datetime of the AXY recording.

  • frequency (float) – the frequency of the AXY data in Hz.

  • total_duration (float) – the total duration of the AXY recording in days.

  • max_odba (float) – the maximum overall dynamical body acceleration.

  • median_odba (float) – the median overall dynamical body acceleration.

  • max_vedba (float) – the maximum vectorial dynamical body acceleration.

  • median_vedba (float) – the median vectorial dynamical body acceleration.

  • circ_mean_pitch (float) – the circular mean of pitch.

  • circ_mean_roll (float) – the circular mean of roll.

2.3.1. Methods

cpforager.AXY.display_data_summary([standalone])

Print in terminal the AXY data summary.

cpforager.AXY.folium_map(fig_dir, file_id, ...)

Produce the html map of the GPS data with the possibility to choose a color gradient.

cpforager.AXY.full_diag(fig_dir, file_id, ...)

Produce the full diagnostic of the AXY data.

cpforager.AXY.interpolate_lat_lon(...[, ...])

Interpolate longitude and latitude at a given datetime.

cpforager.AXY.maps_diag(fig_dir, file_id, ...)

Produce the maps of the GPS data.