pysecs.SECS¶
-
class
pysecs.SECS(sec_df_loc=None, sec_cf_loc=None)¶ Spherical Elementary Current System (SECS).
The algorithm is implemented directly in spherical coordinates from the equations of the 1999 Amm & Viljanen paper 1.
- Parameters
sec_df_loc (ndarray (nsec x 3 [lat, lon, r])) – The latitude, longiutde, and radius of the divergence free (df) SEC locations.
sec_cf_loc (ndarray (nsec x 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
-
__init__(sec_df_loc=None, sec_cf_loc=None)¶ Initialize self. See help(type(self)) for accurate signature.
Methods
__init__([sec_df_loc, sec_cf_loc])Initialize self.
fit(obs_loc, obs_B[, obs_std, epsilon])Fits the SECS to the given observations.
Sets all SECs to a unit current amplitude.
predict(pred_loc[, J])Calculate the predicted magnetic field or currents.
predict_B(pred_loc)Calculate the predicted magnetic fields.
predict_J(pred_loc)Calculate the predicted currents.
Attributes
Whether this system has any curl free currents.
Whether this system has any divergence free currents.
The number of elementary currents in this system.