Plotting (CADETProcess.plotting)

Plotting (CADETProcess.plotting)#

This module provides functionality for plotting in CADET-Process.

General Style#

set_figure_style([style])

Define the sytle of a plot.

SecondaryAxis(components, y_label, y_lim, ...)

Parameters for secondary axis.

Layout(style, title, x_label, x_ticks, ...)

General figure layout.

set_layout(ax, layout[, show_legend, ...])

Configure the layout of a matplotlib Axes object.

Setup Figure#

setup_figure([n_rows, n_cols, style, squeeze])

Set up a matplotlib figure with specified dimensions and style.

create_and_save_figure(func)

Wrap plot functions to provide some general utility.

Annotations#

Annotation(text, xy, xytext)

Parameters for text annotations.

add_annotations(ax, annotations)

Add list of annotations to axis ax.

Ticks#

Tick()

Parameters for Axes ticks.

set_yticks(ax, y_ticks)

Set the y-ticks on a matplotlib Axes object.

set_xticks(ax, x_ticks)

Set the x-ticks on a matplotlib Axes object with rotation.

Fill Regions#

FillRegion(color_index, start, end, y_max, text)

Parameters for fill region.

add_fill_regions(ax, fill_regions[, x_lim])

Add FillRegion to axes.

Text#

add_text(ax, text[, position, tb_props])

Add text to a matplotlib Axes object.

Hlines#

HLines(y, x_min, x_max)

Parameters for plotting horizontal lines.

add_hlines(ax, hlines)

Add hlines to matplotlib Axes.