3.1. cpforager.parameters.get_params

cpforager.parameters.get_params(config_file_paths)

Create a parameters dictionary loaded from a list of .yml paths.

Parameters:

config_file_paths (list[str]) – a list of the .yml configuration file paths.

Returns:

a dictionary of parameters.

Return type:

dict

The parameters dictionary is required to construct GPS, TDR and AXY classes. The user-defined colony code allows to define a dictionary of parameters according to a specific dataset. Find below the exhaustive table of parameters within the dictionary.

Important

Users only have to write the .yml files with parameter values consistent with their dataset and their need.

Warning

Even if all your parameters are written in a unique .yml file, you must express it as a single-element list e.g. params = get_params(["my_unique_config_path.yml"]).

Note

The website at https://mapscaping.com/bounding-box-calculator/ is a user-friendly tool that can help define the colony bounding box.

name	description	required
colony	dictionary with infos about the searbird’s colony	GPS
colony["name"]	name of the searbird’s colony	GPS
colony["center"]	longitude/latitude center of the searbird’s colony	GPS
colony["box_longitude"]	longitude bounding box inside which the searbird’s nest is to be found	GPS
colony["box_latitude"]	latitude bounding box inside which the searbird’s nest is to be found	GPS
local_tz	local timezone of the seabird’s nest	GPS, AXY, TDR
max_possible_speed	speed threshold in km/h above which a longitude/latitude measure can be considered an error	GPS
dist_threshold	distance from the nest threshold in km above which the seabird is considered in a foraging trip	GPS
speed_threshold	speed threshold in km/h above which the seabird is still considered in a foraging trip despite being below the distance threshold	GPS
nesting_speed	local timezone of the seabird’s nest	GPS
nest_position	longitude and latitude of the seabird’s nest if known beforehand	GPS
trip_min_duration	duration in seconds above which a trip is valid	GPS
trip_max_duration	duration in seconds below which a trip is valid	GPS
trip_min_length	length in km above which a trip is valid	GPS
trip_max_length	length in km below which a trip is valid	GPS
trip_min_steps	length in km below which a trip is valid	GPS
zoc_time_windows	widths of successive rolling time windows used for zero-offset correction	TDR
zoc_quantiles	quantiles to keep during the successive rolling time windows used for zero-offset correction	TDR
diving_depth_threshold	depth threshold above which a seabird is considered to be diving	TDR
dive_min_duration	minimum duration in seconds of a dive	TDR
odba_p_norm	p-norm used for the computation of overall dyanmical body acceleration	AXY
filter_type	choose type of filter for accelerations measures (rolling_avg or high_pass)	AXY
acc_time_window	duration in seconds of the rolling window used for filtering dynamic acceleration	AXY
cutoff_f	cutoff frequency in Hz for the Butterworth high-pass filter	AXY
order	order of the Butterworth high-pass filter	AXY