fiftyone.core.plots.matplotlib

module documentation

(source)

Matplotlib plots.

Class	`InteractiveCollection`	Interactive wrapper for a matplotlib collection.
Class	`InteractiveMatplotlibPlot`	Base class for interactive matplotlib plots.
Function	`lines`	Plots the given lines(s) data.
Function	`location_scatterplot`	Generates an interactive scatterplot of the given location coordinates with a map rendered in the background of the plot.
Function	`plot_confusion_matrix`	Plots a confusion matrix.
Function	`plot_pr_curve`	Plots a precision-recall (PR) curve.
Function	`plot_pr_curves`	Plots a set of per-class precision-recall (PR) curves.
Function	`plot_regressions`	Plots the given regression results.
Function	`plot_roc_curve`	Plots a receiver operating characteristic (ROC) curve.
Function	`scatterplot`	Generates an interactive scatterplot of the given points.
Variable	`logger`	Undocumented
Variable	`salem`	Undocumented
Function	`_ensure_salem`	Undocumented
Function	`_get_qualitative_colors`	Undocumented
Function	`_plot_lines`	Undocumented
Function	`_plot_map_background`	Undocumented
Function	`_plot_scatter`	Undocumented
Constant	`_DEFAULT_CONTINUOUS_COLORSCALE`	Undocumented
Constant	`_DEFAULT_LINE_COLOR`	Undocumented
Constant	`_DEFAULT_STYLE`	Undocumented

def lines(x=None, y=None, samples=None, ids=None, link_field=None, sizes=None, labels=None, colors=None, marker_size=None, title=None, xlabel=None, ylabel=None, ax=None, ax_equal=False, figsize=None, style=None, buttons=None, **kwargs): (source) ¶

Plots the given lines(s) data.

You can attach plots generated by this method to an App session via its fiftyone.core.session.Session.plots attribute, which will automatically sync the session's view with the currently selected points in the plot. To enable this functionality, you must pass samples to this method.

You can use the sizes parameter to scale the sizes of the points.

Parameters
x:`None`	the x data to plot. Can be any of the following: an array-like of values a `num_lines x n` array-like or list of length `num_lines` of array-likes of values for multiple line traces the name of a sample field or `embedded.field.name` of `samples` from which to extract values for a single line the name of a frame field or `frames.embedded.field.name` of `samples` from which to extract values for per-sample line traces a `fiftyone.core.expressions.ViewExpression` that resolves to a list (one line plot) or list of lists (multiple line plots) of numeric values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values`
y:`None`	the y data to plot. Can be any of the following: an array-like of values a `num_lines x n` array-like or list of length `num_lines` of array-likes of values for multiple line traces the name of a sample field or `embedded.field.name` of `samples` from which to extract values for a single line the name of a frame field or `frames.embedded.field.name` of `samples` from which to extract values for per-sample line traces a `fiftyone.core.expressions.ViewExpression` that resolves to a list (one line plot) or list of lists (multiple line plots) of numeric values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values`
samples:`None`	the `fiftyone.core.collections.SampleCollection` whose data is being visualized
ids:`None`	an array-like of IDs of same shape as `y`. If not provided but `samples` are provided, the appropriate IDs will be extracted from the samples
link_field:`None`	a field of `samples` whose data corresponds to `y`. Can be any of the following: `None`, if the line data correspond to samples (single trace) or frames (multiple traces) `"frames"`, if the line data correspond to frames (multiple traces). This option exists only for consistency with other plotting methods; in practice, it will be automatically inferred whenever multiple traces are being plotted the name of a `fiftyone.core.labels.Label` field, if the line data correspond to the labels in this field
sizes:`None`	data to use to scale the sizes of the points. Can be any of the following: an array-like of numeric values of same shape as `y` the name of a sample field (single trace) or frame field (multiple traces) from which to extract numeric values a `fiftyone.core.expressions.ViewExpression` defining sample-level (single trace) or frame-level (multiple traces) numeric values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values`
labels:`None`	a label or list of labels for the line traces
colors:`None`	a list of colors recognized by `matplotlib` to use for the line traces. See https://matplotlib.org/stable/tutorials/colors/colormaps.html for more information
marker_size:`None`	the marker size to use. If `sizes` are provided, this value is used as a reference to scale the sizes of all points
title:`None`	a title for the plot
xlabel:`None`	an x-axis label
ylabel:`None`	a y-axis label
ax:`None`	a matplotlib axis to plot in
ax_equal:`False`	whether to set `axis("equal")`
figsize:`None`	a `(width, height)` for the figure, in inches
style:`None`	a style to use for the plot
buttons:`None`	a list of `(label, icon_image, callback)` tuples defining buttons to add to the plot
**kwargs	optional keyword arguments for matplotlib's `plot()` and `scatter()`
Returns
one of the following an `InteractiveCollection`, when IDs are available a matplotlib figure, otherwise

def location_scatterplot(locations=None, samples=None, ids=None, labels=None, sizes=None, classes=None, map_type='satellite', show_scale_bar=False, api_key=None, marker_size=None, cmap=None, title=None, ax=None, ax_equal=False, figsize=None, style=None, buttons=None, **kwargs): (source) ¶

Generates an interactive scatterplot of the given location coordinates with a map rendered in the background of the plot.

Location data is specified via the locations parameter.

You can use the labels parameters to define a coloring for the points, and you can use the sizes parameter to scale the sizes of the points.

Parameters
locations:`None`	the location data to plot. Can be any of the following: None, in which case `samples` must have a single `fiftyone.core.labels.GeoLocation` field whose `point` attribute contains location data a `num_locations x 2` array-like of `(longitude, latitude)` coordinates the name of a `fiftyone.core.labels.GeoLocation` field of `samples` with `(longitude, latitude)` coordinates in its `point` attribute
samples:`None`	the `fiftyone.core.collections.SampleCollection` whose data is being visualized
ids:`None`	an array-like of IDs corresponding to the locations. If not provided but `samples` are provided, the appropriate IDs will be extracted from the samples
labels:`None`	data to use to color the points. Can be any of the following: the name of a sample field or `embedded.field.name` of `samples` from which to extract numeric or string values a `fiftyone.core.expressions.ViewExpression` defining numeric or string values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values` an array-like of numeric or string values
sizes:`None`	data to use to scale the sizes of the points. Can be any of the following: the name of a sample field or `embedded.field.name` of `samples` from which to extract numeric values a `fiftyone.core.expressions.ViewExpression` defining numeric values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values` an array-like of numeric values
classes:`None`	a list of classes whose points to plot. Only applicable when `labels` contains strings
map_type:"satellite"	the map type to render. Supported values are `("roadmap", "satellite", "hybrid", "terrain")`
show_scale_bar:`False`	whether to render a scale bar on the plot
api_key:`None`	a Google Maps API key to use
marker_size:`None`	the marker size to use. If `sizes` are provided, this value is used as a reference to scale the sizes of all points
cmap:`None`	a colormap recognized by `matplotlib`
title:`None`	a title for the plot
ax:`None`	a matplotlib axis to plot in
ax_equal:`False`	whether to set `axis("equal")`
figsize:`None`	a `(width, height)` for the figure, in inches
style:`None`	a style to use for the plot
buttons:`None`	a list of `(label, icon_image, callback)` tuples defining buttons to add to the plot
**kwargs	optional keyword arguments for matplotlib's `scatter()`
Returns
one of the following an `InteractiveCollection`, if IDs are available a matplotlib figure, otherwise

def plot_confusion_matrix(confusion_matrix, labels, show_values=True, show_colorbar=True, cmap=None, title=None, xticks_rotation=45.0, values_format=None, ax=None, figsize=None): (source) ¶

Plots a confusion matrix.

Parameters
confusion_matrix	a `num_true x num_preds` confusion matrix
labels	a `max(num_true, num_preds)` array-like of class labels
show_values:`True`	whether to show counts in the confusion matrix cells
show_colorbar:`True`	whether to show a colorbar
cmap:`None`	a colormap recognized by `matplotlib`
title:`None`	a title for the plot
xticks_rotation:45.0	a rotation for the x-tick labels. Can be numeric degrees, "vertical", "horizontal", or None
values_format:`None`	a format string like `".2g"` or `"d"` to use to format the cell counts
ax:`None`	a matplotlib axis to plot in
figsize:`None`	a `(width, height)` for the figure, in inches
Returns
a matplotlib figure

def plot_pr_curve(precision, recall, label=None, title=None, ax=None, figsize=None, style=None, **kwargs): (source) ¶

Plots a precision-recall (PR) curve.

Parameters
precision	an array-like of precision values
recall	an array-like of recall values
label:`None`	a label for the curve
title:`None`	a title for the plot
ax:`None`	a matplotlib axis to plot in
figsize:`None`	a `(width, height)` for the figure, in inches
style:`None`	a style to use for the plot
**kwargs	optional keyword arguments for matplotlib's `plot()`
Returns
a matplotlib figure

def plot_pr_curves(precisions, recall, classes, title=None, ax=None, figsize=None, style=None, **kwargs): (source) ¶

Plots a set of per-class precision-recall (PR) curves.

Parameters
precisions	a `num_classes x num_recalls` array-like of per-class precision values
recall	an array-like of recall values
classes	the list of classes
title:`None`	a title for the plot
ax:`None`	a matplotlib axis to plot in
figsize:`None`	a `(width, height)` for the figure, in inches
style:`None`	a style to use for the plot
**kwargs	optional keyword arguments for matplotlib's `plot()`
Returns
a matplotlib figure

def plot_regressions(ytrue, ypred, samples=None, ids=None, labels=None, sizes=None, classes=None, gt_field=None, pred_field=None, best_fit_label=None, marker_size=None, cmap=None, title=None, ax=None, figsize=None, style=None, **kwargs): (source) ¶

Plots the given regression results.

Parameters
ytrue	an array-like of ground truth values
ypred	an array-like of predicted values
samples:`None`	the `fiftyone.core.collections.SampleCollection` whose data is being visualized
ids:`None`	an array-like of sample or frame IDs corresponding to the regressions. If not provided but `samples` are provided, the appropriate IDs will be extracted from the samples
labels:`None`	data to use to color the points. Can be any of the following: the name of a sample field or `embedded.field.name` of `samples` from which to extract numeric or string values a `fiftyone.core.expressions.ViewExpression` defining numeric or string values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values` an array-like of numeric or string values a list of array-lies of numeric or string values, if `link_field` refers to frames
sizes:`None`	data to use to scale the sizes of the points. Can be any of the following: the name of a sample field or `embedded.field.name` of `samples` from which to extract numeric values a `fiftyone.core.expressions.ViewExpression` defining numeric values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values` an array-like of numeric values a list of array-likes of numeric or string values, if `link_field` refers to frames
classes:`None`	a list of classes whose points to plot. Only applicable when `labels` contains strings
gt_field:`None`	the name of the ground truth field
pred_field:`None`	the name of the predictions field
best_fit_label:`None`	a custom legend label for the best fit line
marker_size:`None`	the marker size to use. If `sizes` are provided, this value is used as a reference to scale the sizes of all points
cmap:`None`	a colormap recognized by `matplotlib`
title:`None`	a title for the plot
ax:`None`	a matplotlib axis to plot in
figsize:`None`	a `(width, height)` for the figure, in inches
style:`None`	a style to use for the plot
**kwargs	optional keyword arguments for matplotlib's `scatter()`
Returns
a matplotlib figure

def plot_roc_curve(fpr, tpr, roc_auc=None, title=None, ax=None, figsize=None, style=None, **kwargs): (source) ¶

Plots a receiver operating characteristic (ROC) curve.

Parameters
fpr	an array-like of false positive rates
tpr	an array-like of true positive rates
roc_auc:`None`	the area under the ROC curve
title:`None`	a title for the plot
ax:`None`	a matplotlib axis to plot in
figsize:`None`	a `(width, height)` for the figure, in inches
style:`None`	a style to use for the plot
**kwargs	optional keyword arguments for matplotlib's `plot()`
Returns
a matplotlib figure

def scatterplot(points, samples=None, ids=None, link_field=None, labels=None, sizes=None, classes=None, marker_size=None, cmap=None, title=None, ax=None, ax_equal=False, figsize=None, style=None, buttons=None, **kwargs): (source) ¶

Generates an interactive scatterplot of the given points.

This method supports 2D or 3D visualizations, but interactive point selection is only available in 2D.

You can use the labels parameters to define a coloring for the points, and you can use the sizes parameter to scale the sizes of the points.

Parameters
points	a `num_points x num_dims` array-like of points
samples:`None`	the `fiftyone.core.collections.SampleCollection` whose data is being visualized
ids:`None`	an array-like of IDs corresponding to the points. If not provided but `samples` are provided, the appropriate IDs will be extracted from the samples
link_field:`None`	a field of `samples` whose data corresponds to `points`. Can be any of the following: None, if the points correspond to samples `"frames"`, if the points correspond to frames the name of a `fiftyone.core.labels.Label` field, if the points correspond to the labels in this field
labels:`None`	data to use to color the points. Can be any of the following: the name of a sample field or `embedded.field.name` of `samples` from which to extract numeric or string values a `fiftyone.core.expressions.ViewExpression` defining numeric or string values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values` an array-like of numeric or string values a list of array-likes of numeric or string values, if `link_field` refers to frames and/or a label list field like `fiftyone.core.labels.Detections`
sizes:`None`	data to use to scale the sizes of the points. Can be any of the following: the name of a sample field or `embedded.field.name` of `samples` from which to extract numeric values a `fiftyone.core.expressions.ViewExpression` defining numeric values to compute from `samples` via `fiftyone.core.collections.SampleCollection.values` an array-like of numeric values a list of array-likes of numeric or string values, if `link_field` refers to frames and/or a label list field like `fiftyone.core.labels.Detections`
classes:`None`	a list of classes whose points to plot. Only applicable when `labels` contains strings
marker_size:`None`	the marker size to use. If `sizes` are provided, this value is used as a reference to scale the sizes of all points
cmap:`None`	a colormap recognized by `matplotlib`
title:`None`	a title for the plot
ax:`None`	a matplotlib axis to plot in
ax_equal:`False`	whether to set `axis("equal")`
figsize:`None`	a `(width, height)` for the figure, in inches
style:`None`	a style to use for the plot
buttons:`None`	a list of `(label, icon_image, callback)` tuples defining buttons to add to the plot
**kwargs	optional keyword arguments for matplotlib's `scatter()`
Returns
one of the following an `InteractiveCollection`, for 2D points and when IDs are available a matplotlib figure, otherwise

logger = (source) ¶

Undocumented

salem = (source) ¶

Undocumented

def _ensure_salem(): (source) ¶

Undocumented

def _get_qualitative_colors(num_classes, colors=None): (source) ¶

Undocumented

def _plot_lines(x, y, sizes=None, labels=None, colors=None, marker_size=None, xlabel=None, ylabel=None, ax=None, ax_equal=False, figsize=None, show_legend=False, **kwargs): (source) ¶

Undocumented

def _plot_map_background(ax, locations, api_key, map_type, show_scale_bar): (source) ¶

Undocumented

def _plot_scatter(points, labels=None, sizes=None, classes=None, categorical=False, marker_size=None, cmap=None, ax=None, ax_equal=False, figsize=None, **kwargs): (source) ¶

Undocumented

_DEFAULT_CONTINUOUS_COLORSCALE: str = (source) ¶

Undocumented

Value

'viridis'

_DEFAULT_LINE_COLOR: str = (source) ¶

Undocumented

Value

'#FF6D04'

_DEFAULT_STYLE: str = (source) ¶

Undocumented

Value

'default'