chaosmagpy.coordinate_utils.basevectors_mag

chaosmagpy.coordinate_utils.basevectors_mag(dipole=None)[source]

Compute the unit base vectors of the centered dipole coordinate system (also referred to as MAG).

Parameters:
dipolendarray, shape (…, 3), or tuple of ndarrays, optional

Dipole coefficients. Accepted input is a single array with the dipole coefficients \(g_1^0\), \(g_1^1\) and \(h_1^1\) in the trailing dimension; or a tuple of two arrays, where the first array is the co-latitude of the geomagentic north pole and the second is its longitude; or a tuple of three arrays, one array for each dipole coefficient in the natural order. Defaults to the SH coefficients in basicConfig['params.dipole'].

Returns:
mag_1, mag_2, mag_3ndarray, shape (3,)

MAG unit base vectors resolved into the cartesian components of GEO.