List of functions and classes (API)

List of functions and classes (API)#

Import functions/classes to make the public API.

MagneticMomentBz(location)

Estimate the magnetic dipole moment vector from Bz measurements.

plot_bounding_boxes(bounding_boxes[, ax, ...])

Plot bounding boxes on a matplotlib Axes.

read_qdm_harvard(path)

Load QDM microscopy data in the Harvard group format.

random_directions(inclination, declination, ...)

Create random directions around a preferred direction.

dipole_bz(coordinates, dipole_coordinates, ...)

Compute the vertical component of the magnetic field (Bz) produced by a magnetic dipole.

dipole_bz_grid(region, spacing, ...)

Generate a grid of the vertical component of the magnetic field of a dipole.

gradient(data)

Compute first-order spatial derivatives and total gradient amplitude.

total_gradient_amplitude_grid(data)

Compute the total gradient amplitude (TGA) of a given data array.

detect_anomalies(data, size_range[, ...])

Detect anomalies using blob detection.