chaosmagpy.coordinate_utils.transform_vectors

chaosmagpy.coordinate_utils.transform_vectors(theta, phi, B_theta, B_phi, time=None, reference=None, inverse=None, dipole=None)[source]

Transform vectors resolved into components in USE (Up-South-East) at given spherical geographic coordinates (GEO) to components in USE into components with respect to a rotated geocentric coordinate system.

Parameters
thetafloat or ndarray, shape (…)

Geographic colatitude in degrees (GEO).

phifloat or ndarray, shape (…)

Geographic longitude in degrees (GEO).

B_thetafloat or ndarray, shape (…)

Colatitude vector components (GEO).

B_phifloat or ndarray, shape (…)

Azimuthal vector components (GEO).

timefloat or ndarray, shape (…)

Time given as modified Julian date, i.e. with respect to the date 0h00 January 1, 2000 (mjd2000). Ignored for reference='mag'.

reference{‘gsm’, ‘sm’, ‘mag’}

Target coordinate system.

inversebool

Use inverse transformation instead, i.e. transform from rotated coordinates to geographic (default is False).

dipolendarray, shape (3,), optional

Dipole spherical harmonics \(g_1^0\), \(g_1^1\) and \(h_1^1\). Defaults to basicConfig['params.dipole'].

Returns
thetandarray, shape (…)

Colatitude in degrees \([0^\circ, 180^\circ]\) of the rotated geocentric coordinate system.

phindarray, shape (…)

Longitude in degrees \((-180^\circ, 180^\circ]\) of the rotated geocentric coordinate system.

B_thetafloat or ndarray, shape (…)

Colatitude vector components with respect to the rotated geocentric coordinate system.

B_phifloat or ndarray, shape (…)

Azimuthal vector components with respect to the rotated geocentric coordinate system.