3.1. cpforager.processing.estimate_nest_position

cpforager.processing.estimate_nest_position(df, params, verbose=False)

Estimate the nest position from longitude and latitude data.

Parameters:

  • df (pandas.DataFrame) – dataframe with longitude and latitude columns.

  • params (dict) – parameters dictionary.

  • verbose (bool) – display information if True.

Returns:

the estimated nest position.

Return type:

[float, float]

If not known beforehand, the nest position is estimated as the median position among positions inside the colony rectangle with a small enough speed. If not possible, the nest position is estimated at the center of the colony.

Note

The required fields in the parameters dictionary are colony, nesting_speed and nest_position.