aopp_deconv_tool.plot_helper

package documentation

Classes and routines that assist with plotting, specifically plotting the progress of algorithms.

Module base Defines the public facing interface for plot classes, used to interface with hooks in aopp_deconv_tool.algorithm.deconv classes
Module plotters Contains classes that assist with plotting histograms.

From __init__.py:

Class DiffClass Undocumented
Class LimAroundExtrema Undocumented
Class LimFixed Undocumented
Class LimRememberExtremes Undocumented
Class LimRememberExtremesNonNegative Undocumented
Class LimRememberNExtremes Undocumented
Class LimSymAroundCurrent Undocumented
Class LimSymAroundValue Undocumented
Function create_figure_with_subplots Creates a figure and fills it with subplots
Function ensure_fig_and_ax Undocumented
Function fig_add_patch Undocumented
Function fig_draw_bbox_of_artist Undocumented
Function figure_n_subplots Create a figure with n subplots arranged in a rectangle that has the lowest aspect ratio
Function flip_x_axis Undocumented
Function flip_y_axis Undocumented
Function get_legend_hls Undocumented
Function lim Undocumented
Function lim_non_negative Undocumented
Function lowest_aspect_ratio_rectangle_of_at_least_area Undocumented
Function output Outputs the passed figure to a file fname, interactively show it, and close it afterwards
Function remove_axes_ticks_and_labels Undocumented
Function remove_axis_all Undocumented
Function set_legend Undocumented
def create_figure_with_subplots(nr, nc, nax=None, size=6, squeeze=False, figure=None, flatten=True, fig_kwargs={}, sp_kwargs={}):

Creates a figure and fills it with subplots

# ARGUMENTS #
nr
<int> Number of rows
nc
<int> Number of columns
nax
<int> Number of axes to create
size [2]
<float> Size of figure to create x and y dimension, will be multipled by number of columns and rows
fig_kwargs [dict]
Figure keyword arguments. 'figsize' will overwrite passed values for 'size' if present.
sp_kwargs [dict]
Subplot keyword arguments. 'squeeze' will overwrite passed values if present.
# RETURNS #
f
Matplotlib figure created
a [nax]
List of axes contained in f
def ensure_fig_and_ax(fig=None, ax=None, fig_kwargs=None, subplot_spec=(1, 1)):

Undocumented

def fig_add_patch(figure, *patches):

Undocumented

def fig_draw_bbox_of_artist(figure, *artists, color='red', linewidth=1, **kwargs):

Undocumented

def figure_n_subplots(n, figure=None, fig_kwargs={}, sp_kwargs={}):

Create a figure with n subplots arranged in a rectangle that has the lowest aspect ratio

def flip_x_axis(ax):

Undocumented

def flip_y_axis(ax):

Undocumented

def get_legend_hls(*args):

Undocumented

def lim(data):

Undocumented

def lim_non_negative(data):

Undocumented

def lowest_aspect_ratio_rectangle_of_at_least_area(x):

Undocumented

def output(show: bool | float = False, fname: str | Path | None = None, figure: mpl.figure.Figure | str | int | None = None, **kwargs):

Outputs the passed figure to a file fname, interactively show it, and close it afterwards

def remove_axes_ticks_and_labels(ax, state=False):

Undocumented

def remove_axis_all(ax, state=False):

Undocumented

def set_legend(*args, a_or_f=None, **kwargs):

Undocumented