pysecs.SECS.predict_J#

SECS.predict_J(pred_loc: ndarray, return_var: bool = False) → ndarray | tuple[ndarray, ndarray]#

Calculate the predicted currents.

After a set of observations has been fit to this system we can predict the magnetic fields or currents at any other location. This function uses those fit amplitudes to predict at the requested locations.

Parameters:

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

  • return_var (boolean) – Whether to also return the variance of the predictions. Default: False

Returns:

The predicted values calculated from the current amplitudes that were fit to this system. If return_var is True, a tuple of (predictions, variances) with identical shapes is returned.

Return type:

ndarray (ntimes, npred, 3 [lat, lon, r])