grss.prop.prop_utils.mean_cov_to_ellipse

grss.prop.prop_utils.mean_cov_to_ellipse#

grss.prop.prop_utils.mean_cov_to_ellipse(mean, cov, n_std, bplane_type, print_ellipse_params, units)#

Convert a mean and corresponding covariance to an ellipse.

Parameters:
  • mean (np.ndarray) – mean of the data

  • cov (np.ndarray) – covariance of the data

  • n_std (float) – Number of standard deviations to plot

  • bplane_type (str) – type of B-plane

  • print_ellipse_params (bool) – True to print the ellipse parameters, False to not print

  • units (str) – units of the plot

Returns:

ellipse – ellipse points

Return type:

np.ndarray