1.1. cpforager.GPS

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

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

__init__(df, group, id, params)

Constructor of a GPS object.

Parameters:

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

  • group (str) – the string representing the group to which the GPS 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 GPS data.

  • group (str) – The string representing the group to which the GPS 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 GPS data processing.

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

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

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

  • resolution (float) – the time resolution of the GPS data in seconds estimated as the median value of the step times.

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

  • total_length (float) – the total length of the GPS recording in kilometers.

  • dmax (float) – the maximum distance to the nest reached by the central place-foraging seabird.

  • n_trips (int) – the number of foraging trips realised by the seabird.

  • nest_position ([float, float]) – the longitude and latitude of the estimated nest position.

  • trip_statistics (pandas.DataFrame) – the dataframe containing the trip statistics where one row corresponds to one foraging trip.

Methods

__init__(df, group, id, params)

Constructor of a GPS object.

display_data_summary([standalone])

Print in terminal the GPS data summary.

folium_map(fig_dir, file_id, plot_params)

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

full_diag(fig_dir, file_id, plot_params)

Produce the full diagnostic of the GPS data.

interpolate_lat_lon(interp_datetime[, add_proxy])

Interpolate longitude and latitude at a given datetime.

maps_diag(fig_dir, file_id, plot_params)

Produce the maps of the GPS data.