plot_gaussian_ellipses

menpo.visualize.plot_gaussian_ellipses(covariances, means, n_std=2, render_colour_bar=True, colour_bar_label='Normalized Standard Deviation', colour_map='jet', figure_id=None, new_figure=False, image_view=True, line_colour='r', line_style='-', line_width=1.0, render_markers=True, marker_edge_colour='k', marker_face_colour='k', marker_edge_width=1.0, marker_size=5, marker_style='o', render_axes=False, axes_font_name='sans-serif', axes_font_size=10, axes_font_style='normal', axes_font_weight='normal', crop_proportion=0.1, figure_size=(10, 8))[source]

Method that renders the Gaussian ellipses that correspond to a set of covariance matrices and mean vectors. Naturally, this only works for 2-dimensional random variables.

Parameters:
  • covariances (list of (2, 2) ndarray) – The covariance matrices that correspond to each ellipse.
  • means (list of (2, ) ndarray) – The mean vectors that correspond to each ellipse.
  • n_std (float, optional) – This defines the size of the ellipses in terms of number of standard deviations.
  • render_colour_bar (bool, optional) – If True, then the ellipses will be coloured based on their normalized standard deviations and a colour bar will also appear on the side. If False, then all the ellipses will have the same colour.
  • colour_bar_label (str, optional) – The title of the colour bar. It only applies if render_colour_bar is True.
  • colour_map (str, optional) – A valid Matplotlib colour map. For more info, please refer to matplotlib.cm.
  • figure_id (object, optional) – The id of the figure to be used.
  • new_figure (bool, optional) – If True, a new figure is created.
  • image_view (bool, optional) – If True the ellipses will be rendered in the image coordinates system.
  • line_colour (See Below, optional) –

    The colour of the lines of the ellipses. Example options:

    {r, g, b, c, m, k, w}
    or
    (3, ) ndarray
    
  • line_style ({-, --, -., :}, optional) – The style of the lines of the ellipses.
  • line_width (float, optional) – The width of the lines of the ellipses.
  • render_markers (bool, optional) – If True, the centers of the ellipses will be rendered.
  • marker_style (See Below, optional) –

    The style of the centers of the ellipses. Example options

    {., ,, o, v, ^, <, >, +, x, D, d, s, p, *, h, H, 1, 2, 3, 4, 8}
    
  • marker_size (int, optional) – The size of the centers of the ellipses in points.
  • marker_face_colour (See Below, optional) –

    The face (filling) colour of the centers of the ellipses. Example options

    {r, g, b, c, m, k, w}
    or
    (3, ) ndarray
    
  • marker_edge_colour (See Below, optional) –

    The edge colour of the centers of the ellipses. Example options

    {r, g, b, c, m, k, w}
    or
    (3, ) ndarray
    
  • marker_edge_width (float, optional) – The edge width of the centers of the ellipses.
  • render_axes (bool, optional) – If True, the axes will be rendered.
  • axes_font_name (See Below, optional) –

    The font of the axes. Example options

    {serif, sans-serif, cursive, fantasy, monospace}
    
  • axes_font_size (int, optional) – The font size of the axes.
  • axes_font_style ({normal, italic, oblique}, optional) – The font style of the axes.
  • axes_font_weight (See Below, optional) –

    The font weight of the axes. Example options

    {ultralight, light, normal, regular, book, medium, roman,
    semibold,demibold, demi, bold, heavy, extra bold, black}
    
  • crop_proportion (float, optional) – The proportion to be left around the centers’ pointcloud.
  • figure_size ((float, float) tuple or None optional) – The size of the figure in inches.