visualtraceplotter

pyvale.visualtraceplotter.plot_time_traces(sensor_array: SensorArrayPoint, component: str | None = None, trace_opts: TraceOptsSensor | None = None, plot_opts: PlotOptsGeneral | None = None) → tuple[Any, Any][source]

Plots time traces for the truth and virtual experiments of the sensors in the given sensor array.

Parameters:

  • sensor_array (SensorArrayPoint) -- _description

  • component (str | None) -- String key for the field component to plot, by default None. If None then the first component in the measurement array is plotted

  • trace_opts (TraceOptsSensor | None, optional) -- Dataclass containing specific options for controlling the plot appearance, by default None. If None the default options are used.

  • plot_opts (PlotOptsGeneral | None, optional) -- Dataclass containing general options for formatting plots and visualisations, by default None. If None the default options are used.

Returns:

tuple[Any,Any] -- A tuple containing a handle to the matplotlib figure and axis objects: (fig,ax).