lstein.lstein.LSteinCanvas.plot

LSteinCanvas.plot(theta: ndarray, X: List[ndarray], Y: List[ndarray], seriestype: List[str] | Literal['line', 'scatter'] = 'line', panel_kwargs: List[Dict] | Dict = None, series_kwargs: List[Dict] | Dict = None)[source]

adds all series defined in theta, X, Y to respective panels for plotting

  • convenience function to plot a set of series

  • will add all of the passed series to respective panels

Parameters
  • theta

    • np.ndarray

    • theta values associated for to each series in zip(X,Y)

    • 2.5th dimension

  • X

    • List[np.ndarray]

    • set of x-values of each series

    • has to have same length as theta

    • can contain arrays of different lengths

      • have to have same length as corresponding entries in Y

    • each series will be plotted in it’s own panel associated with theta

  • Y

    • List[np.ndarray]

    • set of y-values of each series

    • has to have same length as theta

    • can contain arrays of different lengths

      • have to have same length as corresponding entries in y

    • each series will be plotted in it’s own panel associated with theta

  • seriestpye

    • Literal[“line”,”scatter”], List[str], optional

    • which style to use for plotting the series

      “line” – line plot “scatter” – scatter plot

    • if List[str]

      • has to have same length as X

      • applied to each series individually

    • if Literal[]

      • applied to all series in X

    • the default is “line”

  • panel_kwargs

    • List[Dict], Dict optional

    • kwargs to pass to self.add_panel()

    • if List[Dict]

      • has to have same length as theta

      • the panel created for each theta will use the respective specifications

    • if Dict

      • specifications will be applied to all created panels

    • the default is None

      • will be set to dict() for all panels

  • plot_kwargs

    • List[Dict], Dict, optional

    • kwargs to pass to LSteinPanel.plot()

    • if List[Dict]

      • has to have same length as theta

      • the series plotted for each theta will use the respective specifications

    • if Dict

      • specifications will be applied to all plotted series

    • the default is None

      • will be set to dict() for all panels

Raises

Returns