magali.MagneticMomentBz

magali.MagneticMomentBz#

class magali.MagneticMomentBz(location)[source]#

Estimate magnetic dipole moment vector from Bz measurements.

Uses the Bz component of the magnetic field to fit a point dipole model, returning the dipole moment vector that best fits the data in a least-squares sense.

Parameters:

location (tuple of floats) – Coordinates (x, y, z) of the dipole location, in µm.

Variables:

  • dipole_moment (1d-array) – Estimated dipole moment vector (mx, my, mz).

  • jacobian (2d-array) – Jacobian matrix evaluated at the data coordinates.

fit(coordinates, data)[source]#

Fit the dipole model to the Bz component of the magnetic field.

Notes

The input/output magnetic field is assumed to be Bz in nT, and all coordinates should be provided in µm. Conversion to SI units is handled internally.

Methods#

List of methods

MagneticMomentBz.fit(coordinates, data)

Fit the magnetic dipole model to Bz data.

Methods documentation

MagneticMomentBz.fit(coordinates, data)[source]#

Fit the magnetic dipole model to Bz data.

Parameters:

  • coordinates (tuple of arrays) – Coordinates (x, y, z) of the observations.

  • data (array) – Observed Bz component of the magnetic field (in nT).

Returns:

self – This estimator instance, updated with the estimated dipole_moment_ vector.

Contents