Scan1DResult

class Scan1DResult(offsets, values, parameter_sets, center, direction, program_type)

Bases: object

Attributes Summary

center
direction
offsets
parameter_sets
program_type
values

Methods Summary

plot(*[, ax, show])

Plot the sampled 1D landscape and return (fig, ax).

Attributes Documentation

center: ndarray[tuple[Any, ...], dtype[float64]]

direction: ndarray[tuple[Any, ...], dtype[float64]]

offsets: ndarray[tuple[Any, ...], dtype[float64]]

parameter_sets: ndarray[tuple[Any, ...], dtype[float64]]

program_type: str

values: ndarray[tuple[Any, ...], dtype[float64]]

Methods Documentation

plot(*, ax=None, show=False, **plot_kwargs)

Plot the sampled 1D landscape and return (fig, ax).

Parameters:

• ax – Optional matplotlib axes to draw into. When omitted, a new figure and axes are created.

• show (bool) – Whether to call matplotlib.pyplot.show() after drawing. Defaults to False so the method works cleanly in scripts and tests.

• **plot_kwargs – Additional keyword arguments forwarded to ax.plot.

Returns:

(fig, ax) for the rendered plot.

Return type:

tuple