Skip to content

eyepy.core.plotting

plot_scalebar(scale, scale_unit, scale_length=None, pos=(100, 100), flip_x=False, flip_y=False, color='white', linewidth=1.5, ax=None, **kwargs)

Plot a scalebar for an image.

Parameters:

Name Type Description Default
scale tuple[float, float]

tuple of floats (x, y) with the scale in units per pixel. If the scale_unit is "px" the scale is ignored.

 required
scale_unit str

unit of the scalebar ("px" or "µm", or "mm")

 required
scale_length Optional[Union[int, float]]

length of the scalebar in units

 None
pos tuple[int, int]

position of the scalebar in pixels

 (100, 100)
flip_x bool

flip the scalebar in x direction

 False
flip_y bool

flip the scalebar in y direction

 False
color str

color of the scalebar

 'white'
linewidth float

linewidth of the scalebar

 1.5
ax Optional[Axes]

matplotlib axis to plot on

 None
**kwargs dict

additional keyword arguments passed to ax.plot

 {}

Returns: None

Source code in src/eyepy/core/plotting.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
def plot_scalebar(scale: tuple[float, float],
                  scale_unit: str,
                  scale_length: Optional[Union[int, float]] = None,
                  pos: tuple[int, int] = (100, 100),
                  flip_x: bool = False,
                  flip_y: bool = False,
                  color: str = 'white',
                  linewidth: float = 1.5,
                  ax: Optional[plt.Axes] = None,
                  **kwargs: dict) -> None:
    """Plot a scalebar for an image.

    Args:
        scale: tuple of floats (x, y) with the scale in units per pixel. If the `scale_unit` is "px" the scale is ignored.
        scale_unit: unit of the scalebar ("px" or "µm", or "mm")
        scale_length: length of the scalebar in units
        pos: position of the scalebar in pixels
        flip_x: flip the scalebar in x direction
        flip_y: flip the scalebar in y direction
        color: color of the scalebar
        linewidth: linewidth of the scalebar
        ax: matplotlib axis to plot on
        **kwargs: additional keyword arguments passed to ax.plot
    Returns:
        None
    """
    ax = plt.gca() if ax is None else ax

    x, y = pos

    if scale_unit == 'px':
        scale = (1.0, 1.0)

    if scale_length is None:
        if scale_unit == 'px':
            scale_length = 100
        elif scale_unit == 'µm':
            scale_length = 500
        elif scale_unit == 'mm':
            scale_length = 0.5
        else:
            logger.info(
                f'Unknown scale unit: {scale_unit}. Scalebar not plotted.')
            return

    x_start = x
    x_end = x + (scale_length / scale[0])

    y_start = y
    y_end = y - (scale_length / scale[1])

    text_x = x + 8
    text_y = y - 8

    if flip_x:
        x_start = x - (scale_length / scale[0])
        x_end = x
        text_x = x - 50

    if flip_y:
        y_start = y + (scale_length / scale[1])
        y_end = y
        text_y = y + 17

    # Plot horizontal line
    ax.plot([x_start, x_end], [y, y],
            color=color,
            linewidth=linewidth,
            **kwargs)
    # Plot vertical line
    ax.plot([x, x], [y_start, y_end],
            color=color,
            linewidth=linewidth,
            **kwargs)

    ax.text(text_x,
            text_y,
            f'{scale_length}{scale_unit}',
            fontsize=7,
            weight='bold',
            color=color)

plot_watermark(ax)

Add a watermark in the lower right corner of a matplotlib axes object.

Parameters:

Name Type Description Default
ax Axes

Axes object

 required

Returns: None

Source code in src/eyepy/core/plotting.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def plot_watermark(ax: plt.Axes) -> None:
    """Add a watermark in the lower right corner of a matplotlib axes object.

    Args:
        ax: Axes object
    Returns:
        None
    """
    ax.text(0.98,
            0.02,
            'Visualized with eyepy',
            fontsize=6,
            color='white',
            ha='right',
            va='bottom',
            alpha=0.4,
            transform=plt.gca().transAxes,
            bbox=dict(boxstyle='Round',
                      facecolor='gray',
                      alpha=0.2,
                      linewidth=0))