2.2. cpforager.TDR

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

Bases: object

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

__init__(df, group, id, params)

Constructor of a TDR object.

Parameters:

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

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

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

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

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

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

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

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

  • n_dives (int) – the number of dives realised by the seabird.

  • median_pressure (float) – the median pressure in hPa.

  • median_depth (float) – the median depth in meters.

  • max_depth (float) – the maximum depth in meters.

  • mean_temperature (float) – the mean temperature in °C.

  • dive_statistics (pandas.DataFrame) – the dataframe containing the dive statistics where one row corresponds to one dive.

Warning

Due to the wide variety of TDR data, zero-offset correction of pressure is expected in the input dataframe.

2.2.1. Methods

cpforager.TDR.display_data_summary([standalone])

Print in terminal the TDR data summary.

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

Produce the full diagnostic of the TDR data.