Skip to content

utils

apply_high_quality(vectorial=False)

Sets the matplotlib output format to high quality or vectorial plots.

Parameters:

Name Type Description Default
vectorial bool

If True, sets the format to 'svg'. Otherwise, sets it to 'retina'. Defaults to False.

 False
Source code in study_da/plot/utils/maplotlib_utils.py 
16
17
18
19
20
21
22
23
24
25
26
27
def apply_high_quality(vectorial: bool = False) -> None:
    """
    Sets the matplotlib output format to high quality or vectorial plots.

    Args:
        vectorial (bool, optional): If True, sets the format to 'svg'. Otherwise, sets it to
            'retina'. Defaults to False.
    """
    if vectorial:
        matplotlib_inline.backend_inline.set_matplotlib_formats("svg")
    else:
        matplotlib_inline.backend_inline.set_matplotlib_formats("retina")

apply_nicer_style(remove_right_upper_spines=True)

Applies a nicer style to plots, using the whitegrid seaborn theme.

Parameters:

Name Type Description Default
remove_right_upper_spines bool

If True, removes the right and upper spines from the plots. Defaults to True.

 True
Source code in study_da/plot/utils/maplotlib_utils.py 
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def apply_nicer_style(remove_right_upper_spines: bool = True) -> None:
    """
    Applies a nicer style to plots, using the whitegrid seaborn theme.

    Args:
        remove_right_upper_spines (bool, optional): If True, removes the right and upper spines
            from the plots. Defaults to True.
    """
    sns.set_theme(style="whitegrid")

    if remove_right_upper_spines:
        custom_params = {"axes.spines.right": False, "axes.spines.top": False}
        sns.set_theme(style="ticks", rc=custom_params)

    # sns.set(font='Adobe Devanagari')
    sns.set_context("paper", font_scale=1, rc={"lines.linewidth": 0.5, "grid.linewidth": 0.3})

apply_standard_quality()

Sets the matplotlib output format to standard quality ("png" argument).

Source code in study_da/plot/utils/maplotlib_utils.py 
30
31
32
33
34
def apply_standard_quality() -> None:
    """
    Sets the matplotlib output format to standard quality ("png" argument).
    """
    matplotlib_inline.backend_inline.set_matplotlib_formats("png")

use_default_fonts()

Configures matplotlib to use the default DejaVu Sans fonts.

Source code in study_da/plot/utils/maplotlib_utils.py 
52
53
54
55
56
57
58
59
def use_default_fonts() -> None:
    """
    Configures matplotlib to use the default DejaVu Sans fonts.
    """
    matplotlib.rcParams["mathtext.fontset"] = "dejavusans"
    matplotlib.rcParams["font.family"] = "DejaVu Sans"
    matplotlib.rcParams["mathtext.default"] = "it"
    matplotlib.rcParams["font.weight"] = "normal"

use_latex_fonts(italic=False)

Configures matplotlib to use LaTeX fonts.

Parameters:

Name Type Description Default
italic bool

If True, sets the default mathtext to italic. Otherwise, sets it to regular. Defaults to False.

 False
Source code in study_da/plot/utils/maplotlib_utils.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
def use_latex_fonts(italic: bool = False) -> None:
    """
    Configures matplotlib to use LaTeX fonts.

    Args:
        italic (bool, optional): If True, sets the default mathtext to italic. Otherwise, sets it
            to regular. Defaults to False.
    """
    matplotlib.rcParams["mathtext.fontset"] = "cm"
    matplotlib.rcParams["font.family"] = "STIXGeneral"
    if not italic:
        matplotlib.rcParams["mathtext.default"] = "regular"
        matplotlib.rcParams["font.weight"] = "light"