3.9. cpforager.processing.add_dist_to_nest

cpforager.processing.add_dist_to_nest(df, params)

Add to the dataframe an additional dist_to_nest column that gives the orthodromic distance to the estimated nest position in kilometers.

Parameters:

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

• params (dict) – parameters dictionary.

Returns:

the dataframe with an additional dist_to_nest column that gives the orthodromic distance to the estimated nest position in kilometers.

Return type:

pandas.DataFrame

Note

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