2.1. cpforager.parameters.get_params

cpforager.parameters.get_params(colony)

Create a parameters dictionary.

Parameters:: colony (str) – codified name of the considered colony
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 should modify the parameters values according to their dataset and/or add if block with the colony code of their choice.

name	description	required
`colony`	name, longitude/latitude center and bounding box inside which the searbird’s nest is to be found	GPS
`local_tz`	local timezone of the seabird’s nest	GPS, TDR, AXY
`max_possible_speed`	speed threshold in km/h above which a longitude/latitude measure can be considered as an error and will be deleted	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	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
`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 among (rolling average 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