afids_utils.metrics

Methods for computing various metrics pertaining to AFIDs

afids_utils.metrics.mean_afid_sets(afid_sets)

Calculate the average spatial coordinates for corresponding AFIDs within a list of AfidSet objects.

Parameters:

afid_sets (list[AfidSet]) – List of AfidSet to compute mean from

Returns:

Object containing mean spatial components for each AFID

Return type:

AfidSet

Raises:

ValueError – If input list does not consist of all AfidSet objects or if there are different coordinate systems in provided list of AfidSet objects

afids_utils.metrics.mean_distances(afid_sets, template_afid_set, component='distance')

Calculate the average distance for a given spatial component between a collection of AfidSet objects and a common / template AfidSet.

Parameters:

• afid_sets (list[AfidSet]) – List of AfidSet objects to compute distances with

• template_afid_set (AfidSet) – Template / common AfidSet to compute distances against

• component (str) – Spatial component to compute - if “distance” will compute Euclidean distance (default: “distance”)

Returns:

List of average distances along each spatial component and Euclidean distance

Return type:

list[float]