scine_autocas.plots.threshold_plot

The threshold diagram class.

This module implements a class to plot a threshold diagram.

Classes

ThresholdPlot()

A Class to plot the threshold diagram for s1 values.

class scine_autocas.plots.threshold_plot.ThresholdPlot

A Class to plot the threshold diagram for s1 values.

A threshold diagram provides a graphical way to check back the autocas plateau algorithm.

Attributes

plateau_elements

(int, default = 10) number of steps required to form a plateau

__slots__ = ['plateau_elements']

__init__()

Construct a treshholdplot object.

plateau_elements: int

defines the number of elements necessary to count as a plateau

set_number_of_platueau_elements(n_elements)

Set number of steps required for a plateau.

Parameters

n_elementsint

new number of n_elements

__doc__ = 'A Class to plot the threshold diagram for s1 values.\n\n    A threshold diagram provides a graphical way to check back the autocas\n    plateau algorithm.\n\n    Attributes\n    ----------\n    plateau_elements : int, default = 10\n        number of steps required to form a plateau\n    '

__module__ = 'scine_autocas.plots.threshold_plot'

plot(s1_entropy)

Plot the threshold diagram from the single orbital entropy.

Parameters

s1np.ndarray

single orbital entropy

Returns

pltmatplotlib.pyplot

the matplotlib object

rtype

Any ..