pysecs.KalmanSECS.predict#

KalmanSECS.predict(pred_loc: ndarray, J: bool = False, return_var: bool = False) → ndarray | tuple[ndarray, ndarray]#

Predict magnetic fields or currents from the estimated amplitudes.

Parameters:

  • pred_loc (ndarray (npred, 3 [lat, lon, r])) – Locations where the predictions are desired.

  • J (bool) – Whether to predict currents (True) or magnetic fields (False). Default: False

  • return_var (bool) – Whether to also return prediction variances propagated from the full amplitude covariance of the filter/smoother. Default: False

Returns:

Predicted values; a (predictions, variances) tuple if return_var is True.

Return type:

ndarray (ntimes, npred, 3)