embcol.logging.FigureHandler

class embcol.logging.FigureHandler(widget=None, max_n_points=1000, min_interval=1e-09)

Bases: Handler

Handler sending optimization progress messages to a figure.

Parameters:

• widget (plotly.graph_objects.FigureWidget, optional) – Figure widget where optimization progress is drawn. If nothing is given, a widget is created with default settings.

• max_n_points (int, optional) – Maximum number of points drawn on a figure.

• min_interval (float, optional) – Minimum time interval between figure updates. The value is in units of seconds.

Attributes

max_n_points	Maximum number of points drawn on a figure.
min_interval	Minimum time interval between figure updates.
widget	Figure widget where optimization progress is drawn..

Inherited attributes

name

Methods

close()	Stop updating a figure.
display_figure()	Display a figure.
emit(record)	Emit data to a figure.
flush()	Ensure that a figure is updated.

Inherited methods

acquire()	Acquire the I/O thread lock.
addFilter(filter)	Add the specified filter to this handler.
createLock()	Acquire a thread lock for serializing access to the underlying I/O.
filter(record)	Determine if a record is loggable by consulting all the filters.
format(record)	Format the specified record.
get_name()
handle(record)	Conditionally emit the specified logging record.
handleError(record)	Handle errors which occur during an emit() call.
release()	Release the I/O thread lock.
removeFilter(filter)	Remove the specified filter from this handler.
setFormatter(fmt)	Set the formatter for this handler.
setLevel(level)	Set the logging level of this handler.
set_name(name)