eit_results_list.error

eit_results_list.error(which='v_eit', abs_err=True, i_res=None, i_res_ref=0, t=None, i_t: ndarray | int | None = None, i_e: ndarray | int | None = None, i_f: ndarray | int | None = None, i_p: ndarray | int | None = None, **kwgs)[source]

Compute deviations from a reference result.

Parameters:

  • which (str, optional) – Signal family passed to get_res().

  • abs_err (bool, optional) – If True, return the absolute difference. Otherwise return the relative error normalized by the reference signal.

  • i_res (np.ndarray | int | None, optional) – Result indices to compare. By default all results except i_res_ref.

  • i_res_ref (int, optional) – Reference result index.

  • t (np.ndarray | float | None, optional) – Evaluation times used for interpolation.

  • i_t (np.ndarray | int | None, optional) – Time, electrode, frequency, and pattern indices.

  • i_e (np.ndarray | int | None, optional) – Time, electrode, frequency, and pattern indices.

  • i_f (np.ndarray | int | None, optional) – Time, electrode, frequency, and pattern indices.

  • i_p (np.ndarray | int | None, optional) – Time, electrode, frequency, and pattern indices.

  • **kwgs (dict) – Additional keyword arguments forwarded to get_res().

Returns:

Absolute or relative error with respect to the reference result.

Return type:

np.ndarray