pysecs.SECS

class pysecs.SECS(sec_df_loc: ndarray | None = None, sec_cf_loc: ndarray | None = None)

Spherical Elementary Current System (SECS).

The algorithm is implemented directly in spherical coordinates from the equations of the 1999 Amm & Viljanen paper [1]. The magnetic field of the curl-free system is implemented from Equation 2.15 of the Vanhamäki & Juusola review chapter [2].

Parameters:

• sec_df_loc (ndarray (nsec, 3 [lat, lon, r])) – The latitude, longiutde, and radius of the divergence free (df) SEC locations.

• sec_cf_loc (ndarray (nsec, 3 [lat, lon, r])) – The latitude, longiutde, and radius of the curl free (cf) SEC locations.

References

[1]

Amm, O., and A. Viljanen. “Ionospheric disturbance magnetic field continuation from the ground to the ionosphere using spherical elementary current systems.” Earth, Planets and Space 51.6 (1999): 431-440. doi:10.1186/BF03352247

[2]

Vanhamäki, H., and L. Juusola. “Introduction to Spherical Elementary Current Systems.” Ionospheric Multi-Spacecraft Analysis Tools, ISSI Scientific Report Series 17 (2020): 5-33. doi:10.1007/978-3-030-26732-2_2

__init__(sec_df_loc: ndarray | None = None, sec_cf_loc: ndarray | None = None) → None

Methods

__init__([sec_df_loc, sec_cf_loc])
fit(obs_loc, obs_B[, obs_std, epsilon, ...])	Fits the SECS to the given observations.
fit_unit_currents()	Set all SECs to a unit current amplitude.
from_observations(obs_loc, r_shell[, ...])	Build a SECS with an automatically generated grid.
predict(pred_loc[, J, return_var])	Calculate the predicted magnetic field or currents.
predict_B(pred_loc[, return_var])	Calculate the predicted magnetic fields.
predict_J(pred_loc[, return_var])	Calculate the predicted currents.

Attributes

has_cf	Whether this system has any curl free currents.
has_df	Whether this system has any divergence free currents.
nsec	The number of elementary currents in this system.