chaosmagpy.coordinate_utils.transform_points

chaosmagpy.coordinate_utils.transform_points(theta, phi, time=None, *, reference=None, inverse=None, dipole=None)[source]

Transform spherical geographic coordinates into rotated spherical coordinates.

Parameters:
thetafloat or ndarray, shape (…)

Geocentric colatitude in degrees.

phifloat or ndarray, shape (…)

Longitude in degrees.

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 to spherical geographic coordinates (default is False).

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:
thetandarray, shape (…)

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

phindarray, shape (…)

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

See also

geo_to_base