chaosmagpy.coordinate_utils.basevectors_gsm

chaosmagpy.coordinate_utils.basevectors_gsm(time, dipole=None)

Compute the unit base vectors of the GSM coordinate system.

Parameters:

timefloat or ndarray, shape (…)

Time given as modified Julian date, i.e. with respect to the date 0h00 January 1, 2000 (mjd2000).

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:

gsm_1, gsm_2, gsm_3ndarray, shape (…, 3)

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