Skip to content

Logging

image(image, title=None, scale=1.0, greyscale=False, tools=True, logo=False, title_style=None, display=False)

Plot an image.

Parameters:

Name Type Description Default
image ndarray

Image to display.

required
title str

The title for this image.

None
greyscale str

Display the image in greyscale.

False
tools str | set[str] | bool

Show one or more specific tools or hide the toolbox altogether.

True
logo bool

Show or hide the logo.

False
title_style dict | None

Title style.

None
display bool

Show the image instead of returning a Bokeh figure.

False

Returns:

Type Description
figure

A Bokeh figure.

make_figure(height=600, width=800, title=None, tools=True, logo=False, title_style=None)

Create a Bokeh figure.

Args:

height: Figure height.
width: Figure width.
title: The title for this figure.
tools: Show one or more specific tools or hide the toolbox altogether.
logo: Show or hide the logo.
title_style: Title style.

Returns:

Type Description
figure

A Bokeh figure.

scatter(ys, xs=None, height=600, width=800, title=None, xtitle=None, ytitle=None, tools=True, logo=False, title_style=None, display=False)

Create a scatter plot.

Parameters:

Name Type Description Default
ys ndarray

Data to plot (Y axis).

required
xs ndarray

Data to plot (X axis).

None
height int

Figure height.

600
width int

Figure width.

800
title str

The title for this image.

None
xtitle str

The title for the x axis.

None
ytitle str

The title for the y axis.

None
tools str | set[str] | bool

Show one or more specific tools or hide the toolbox altogether.

True
logo bool

Show or hide the logo.

False
title_style dict | None

Title style.

None
display bool

Show the image instead of returning a Bokeh figure.

False

Returns:

Type Description
figure

A Bokeh figure.

show_composite(entries, title=None, title_style=None)

Display a previously plotted entry.

Parameters:

Name Type Description Default
entries figure | list[figure]

Entries to display.

required
title str | None

Title to use for the whole plot.

None
title_style dict | None

Title style passed to the bokeh Div element.

None