1.7. cpforager.AXY_Collection

class cpforager.AXY_Collection(axy_collection)

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

__init__(axy_collection)

Constructor of an AXY_Collection object.

Parameters:

axy_collection (list[cpforager.AXY]) – the list of AXY.

Variables:

  • axy_collection (list[cpforager.AXY]) – the list of AXY.

  • n_axy (int) – the total number of AXY included in the list.

  • n_trips (int) – the number of trips summed over every AXY included in the list.

  • trip_statistics_all (pandas.DataFrame) – the trip statistics dataframe merged over every AXY included in the list.

  • n_dives (int) – the number of dives summed over every AXY included in the list.

  • dive_statistics_all (pandas.DataFrame) – the dive statistics dataframe merged over every AXY included in the list.

Note

To avoid memory overload, we do not build an overall dataframe that would result from all AXY data concatenation.

Methods

__init__(axy_collection)

Constructor of an AXY_Collection object.

display_data_summary([standalone])

Print in terminal the AXY_Collection data summary.

folium_map(fig_dir, file_id, plot_params)

Produce the html map with every AXY data colored randomly.

indiv_depth_all(fig_dir, file_id, plot_params)

Produce the individual depth plot of every AXY in collection.

indiv_map_all(fig_dir, file_id, plot_params)

Produce the individual map of every AXY in collection.

maps_diag(fig_dir, file_id, plot_params)

Produce the maps with every AXY data.

plot_dive_stats_summary(fig_dir, file_id, ...)

Produce the dive statistics summary of every AXY data.

plot_trip_stats_summary(fig_dir, file_id, ...)

Produce the trip statistics summary of every AXY data.