hnn_core.dipole.average_dipoles

hnn_core.dipole.average_dipoles(dpls)

Compute dipole averages over a list of Dipole objects.

Parameters

dpls: list of Dipole objects

Contains list of dipole objects, each with a data member containing ‘L2’, ‘L5’ and ‘agg’ components

Returns

dpl: instance of Dipole

A new dipole object with each component of dpl.data representing the average over the same components in the input list