plot
Plot
#
Facade class for plot.
create_callback_frequency_plot(callbacks)
#
Get callback frequency plot.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
callbacks |
Collection[CallbackBase]
|
Target callbacks. This also accepts multiple CallbackBase inputs by unpacking. |
required |
Returns:
| Type | Description |
|---|---|
PlotBase
|
create_callback_latency_plot(callbacks)
#
Get callback latency plot.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
callbacks |
Collection[CallbackBase]
|
Target callbacks. This also accepts multiple CallbackBase inputs by unpacking. |
required |
Returns:
| Type | Description |
|---|---|
PlotBase
|
create_callback_period_plot(callbacks)
#
Get callback period plot.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
callbacks |
Collection[CallbackBase]
|
Target callbacks. This also accepts multiple CallbackBase inputs by unpacking. |
required |
Returns:
| Type | Description |
|---|---|
PlotBase
|
create_callback_scheduling_plot(target_objects, lstrip_s=0, rstrip_s=0)
#
Get CallbackSchedulingPlot instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
lstrip_s |
float, optional
|
Start time of cropping range, by default 0. |
0
|
rstrip_s |
float
|
End point of cropping range, by default 0. |
0
|
Returns:
| Type | Description |
|---|---|
CallbackSchedulingPlot
|
create_frequency_timeseries_plot(target_objects)
#
Get frequency timeseries plot instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
target_object |
TimeSeriesTypes
|
TimeSeriesPlotTypes = Union[ CallbackBase, Communication, Union[Publisher, Subscription] ] Instances that are the sources of the plotting. This also accepts multiple inputs by unpacking. |
required |
Returns:
| Type | Description |
|---|---|
PlotBase
|
create_latency_timeseries_plot(target_objects)
#
Get latency timeseries plot instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
target_object |
TimeSeriesTypes
|
TimeSeriesPlotTypes = Union[ CallbackBase, Communication, Union[Publisher, Subscription] ] Instances that are the sources of the plotting. This also accepts multiple inputs by unpacking. |
required |
Returns:
| Type | Description |
|---|---|
PlotBase
|
create_period_timeseries_plot(target_objects)
#
Get period timeseries plot instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
target_object |
TimeSeriesTypes
|
TimeSeriesPlotTypes = Union[ CallbackBase, Communication, Union[Publisher, Subscription] ] Instances that are the sources of the plotting. This also accepts multiple inputs by unpacking. |
required |
Returns:
| Type | Description |
|---|---|
PlotBase
|
create_response_time_histogram_plot(paths, case='best-to-worst', binsize_ns=10000000)
#
Get ResponseTimePlot instance.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path |
Collection[Path]
|
Target path. This also accepts multiple path inputs by unpacking. |
required |
case |
str, optional
|
response time calculation method, by default best-to-worst. supported case: [best-to-worst/best/worst]. |
'best-to-worst'
|
binsize_ns |
int, optional
|
binsize [ns], by default 1000000. |
10000000
|
Returns:
| Type | Description |
|---|---|
ResponseTimePlot
|
PlotBase
#
Plot base class.
save(export_path, title='', xaxis_type=None, ywheel_zoom=None, full_legends=None)
#
Export a graph using the bokeh library.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
export_path |
str
|
The graph will be saved as a file. |
required |
title |
str
|
Title of the graph, by default ''. |
''
|
xaxis_type |
str
|
Type of x-axis of the graph to be plotted. "system_time", "index", or "sim_time" can be specified. |
None
|
ywheel_zoom |
bool
|
If True, the drawn graph can be expanded in the y-axis direction by the mouse wheel. |
None
|
full_legends |
bool
|
If True, all legends are drawn even if the number of legends exceeds the threshold. |
None
|
Raises:
| Type | Description |
|---|---|
UnsupportedTypeError
|
Argument xaxis_type is not "system_time", "index", or "sim_time". |
show(xaxis_type=None, ywheel_zoom=None, full_legends=None, export_path=None)
#
Draw a graph using the bokeh library.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
xaxis_type |
str
|
Type of x-axis of the graph to be plotted. "system_time", "index", or "sim_time" can be specified. |
None
|
ywheel_zoom |
bool
|
If True, the drawn graph can be expanded in the y-axis direction by the mouse wheel. |
None
|
full_legends |
bool
|
If True, all legends are drawn even if the number of legends exceeds the threshold. |
None
|
export_path |
str, optional
|
The graph will be saved as a file. This option is deprecated, please use save method. |
None
|
Returns:
| Type | Description |
|---|---|
bokeh.plotting.Figure
|
Raises:
| Type | Description |
|---|---|
UnsupportedTypeError
|
Argument xaxis_type is not "system_time", "index", or "sim_time". |