dreye.ReceptorEstimator.hull_plot#
- ReceptorEstimator.hull_plot(B=None, axes=None, labels=None, sources_labels=None, colors=None, ncols=None, fig_kws=None, relative=True, sources_vectors=True, hull_kws=None, vectors_kws=None, **kwargs)[source]#
Plot the hull of the system on all possible pairs of filter combinations (2D-plot).
- Parameters:
- Bndarray of shape (n_samples, n_filters)
Relative total capture points. If None, the registered B is used. Defaults to None.
- axesndarray of matplotlib.axes.Axes, optional
The matplotlib axes that should contain the plots. If None, these will be created including a new figure. By default None.
- labelsndarray of shape (n_filters), optional
Labels for the filters. By default None.
- sources_labelsndarray of shape (n_sources), optional
Labels for the sources. By default None.
- colorsndarray of shape (n_sources), optional
Color for each source, by default None.
- ncolsint, optional
Number of columns in the plots, by default None
- fig_kwsdict, optional
Keyword arguments passed to create the figure, by default None.
- relativebool, optional
Whether to use relative capture values, by default True
- sources_vectorsbool, optional
Whether to plot the sources colored arrows, by default True.
- hull_kwsdict, optional
Keyword arguments passed to matplotlib.axes.Axes.plot(), by default None.
- vectors_kwsdict, optional
Keyword arguments passed to matplotlib.axes.Axes.arrow(), by default None.
- kwargskey, value mappings
Other keyword arguments are passed down to matplotlib.axes.Axes.scatter() for the B points.
- Returns:
- figmatplotlib.figure.Figure
The matplotlib figure containing the plots.
- axesndarray of matplotlib.axes.Axes, optional
The matplotlib axes containing the plots.