sysplot.SysplotConfig#

class SysplotConfig(figure_size=(7.0, 5.0), figure_size_nmax=2, figure_dpi=150, savefig_dpi=300, figure_fmt='pdf', constrained_layout=True, font_size=11, use_latex=False, font_family='sans-serif', linewidth=1, highlight_linewidth=2, markersize=6, poles_zeros_markersize=10, tick_direction='in', xmargin=0.0, formatter_limits=(-9, 9), seaborn_context='paper', seaborn_style='whitegrid', arrowstyle='-|>', heaviside_default_value=1.0, savefig_folder='images', savefig_transparent=False, nyquist_mirror_alpha=0.5, nyquist_arrow_size=15, nyquist_arrow_position=0.33, filter_tolerance_alpha=0.4)[source]#

Bases: object

Global configuration container for sysplot visual defaults.

This dataclass stores the active plotting defaults used by apply_config(), including figure layout, typography, line styling, and seaborn theme options.

For details on relevant style systems, see: https://matplotlib.org/stable/users/explain/customizing.html and https://seaborn.pydata.org/tutorial/aesthetics.html

Examples using sysplot.SysplotConfig#

Apply Config Example

Apply Config Example

Get Figure Size

Get Figure Size

Save Current Figure

Save Current Figure
__init__(figure_size=(7.0, 5.0), figure_size_nmax=2, figure_dpi=150, savefig_dpi=300, figure_fmt='pdf', constrained_layout=True, font_size=11, use_latex=False, font_family='sans-serif', linewidth=1, highlight_linewidth=2, markersize=6, poles_zeros_markersize=10, tick_direction='in', xmargin=0.0, formatter_limits=(-9, 9), seaborn_context='paper', seaborn_style='whitegrid', arrowstyle='-|>', heaviside_default_value=1.0, savefig_folder='images', savefig_transparent=False, nyquist_mirror_alpha=0.5, nyquist_arrow_size=15, nyquist_arrow_position=0.33, filter_tolerance_alpha=0.4)#
Parameters:

  • figure_size (tuple[float, float])

  • figure_size_nmax (int)

  • figure_dpi (int)

  • savefig_dpi (int)

  • figure_fmt (str)

  • constrained_layout (bool)

  • font_size (int)

  • use_latex (bool)

  • font_family (str)

  • linewidth (float)

  • highlight_linewidth (float)

  • markersize (float)

  • poles_zeros_markersize (float)

  • tick_direction (Literal['in', 'out', 'inout'])

  • xmargin (float)

  • formatter_limits (tuple[int, int])

  • seaborn_context (Literal['paper', 'notebook', 'talk', 'poster'])

  • seaborn_style (Literal['white', 'whitegrid', 'darkgrid', 'ticks'])

  • arrowstyle (str)

  • heaviside_default_value (float)

  • savefig_folder (str)

  • savefig_transparent (bool)

  • nyquist_mirror_alpha (float)

  • nyquist_arrow_size (int)

  • nyquist_arrow_position (float)

  • filter_tolerance_alpha (float)

Return type:

None

Methods

__init__([figure_size, figure_size_nmax, ...])

validate()

Validate key numeric configuration values.

Attributes

figure_size

figure_size_nmax

figure_dpi

savefig_dpi

figure_fmt

constrained_layout

font_size

use_latex

font_family

linewidth

highlight_linewidth

markersize

poles_zeros_markersize

tick_direction

xmargin

formatter_limits

seaborn_context

seaborn_style

arrowstyle

heaviside_default_value

savefig_folder

savefig_transparent

nyquist_mirror_alpha

nyquist_arrow_size

nyquist_arrow_position

filter_tolerance_alpha

add_tick_linestyle

zorder_emphasized_grid

zorder_grid

figure_size: tuple[float, float]#
figure_size_nmax: int#
figure_dpi: int#
savefig_dpi: int#
figure_fmt: str#
constrained_layout: bool#
font_size: int#
use_latex: bool#
font_family: str#
linewidth: float#
highlight_linewidth: float#
markersize: float#
poles_zeros_markersize: float#
tick_direction: Literal['in', 'out', 'inout']#
xmargin: float#
formatter_limits: tuple[int, int]#
seaborn_context: Literal['paper', 'notebook', 'talk', 'poster']#
seaborn_style: Literal['white', 'whitegrid', 'darkgrid', 'ticks']#
arrowstyle: str#
heaviside_default_value: float#
savefig_folder: str#
savefig_transparent: bool#
nyquist_mirror_alpha: float#
nyquist_arrow_size: int#
nyquist_arrow_position: float#
filter_tolerance_alpha: float#
add_tick_linestyle = ':'#
zorder_grid = 1.0#
zorder_emphasized_grid = 1.0#
validate()[source]#

Validate key numeric configuration values.

Intended for internal and advanced usage when constructing custom SysplotConfig objects.

Examples using sysplot.SysplotConfig#

Apply Config Example

Apply Config Example

Get Figure Size

Get Figure Size

Save Current Figure

Save Current Figure
rtype:

None

Return type:

None

Parameters:

  • figure_size (tuple[float, float])

  • figure_size_nmax (int)

  • figure_dpi (int)

  • savefig_dpi (int)

  • figure_fmt (str)

  • constrained_layout (bool)

  • font_size (int)

  • use_latex (bool)

  • font_family (str)

  • linewidth (float)

  • highlight_linewidth (float)

  • markersize (float)

  • poles_zeros_markersize (float)

  • tick_direction (Literal['in', 'out', 'inout'])

  • xmargin (float)

  • formatter_limits (tuple[int, int])

  • seaborn_context (Literal['paper', 'notebook', 'talk', 'poster'])

  • seaborn_style (Literal['white', 'whitegrid', 'darkgrid', 'ticks'])

  • arrowstyle (str)

  • heaviside_default_value (float)

  • savefig_folder (str)

  • savefig_transparent (bool)

  • nyquist_mirror_alpha (float)

  • nyquist_arrow_size (int)

  • nyquist_arrow_position (float)

  • filter_tolerance_alpha (float)