forked from matplotlib/matplotlib
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathimage.pyi
More file actions
215 lines (200 loc) · 6.9 KB
/
image.pyi
File metadata and controls
215 lines (200 loc) · 6.9 KB
1
2
3
4
5
6
7
8
9
10
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
from collections.abc import Callable, Sequence
import os
import pathlib
from typing import Any, BinaryIO, Literal
import numpy as np
from numpy.typing import ArrayLike, NDArray
import PIL.Image
from matplotlib.axes import Axes
from matplotlib import colorizer
from matplotlib.backend_bases import RendererBase, MouseEvent
from matplotlib.colorizer import Colorizer
from matplotlib.colors import Colormap, Normalize
from matplotlib.figure import Figure
from matplotlib.transforms import Affine2D, BboxBase, Bbox, Transform
#
# These names are re-exported from matplotlib._image.
#
BESSEL: int
BICUBIC: int
BILINEAR: int
BLACKMAN: int
CATROM: int
GAUSSIAN: int
HAMMING: int
HANNING: int
HERMITE: int
KAISER: int
LANCZOS: int
MITCHELL: int
NEAREST: int
QUADRIC: int
SINC: int
SPLINE16: int
SPLINE36: int
def resample(
input_array: NDArray[np.float32] | NDArray[np.float64] | NDArray[np.int8],
output_array: NDArray[np.float32] | NDArray[np.float64] | NDArray[np.int8],
transform: Transform,
interpolation: int = ...,
resample: bool = ...,
alpha: float = ...,
norm: bool = ...,
radius: float = ...,
) -> None: ...
#
# END names re-exported from matplotlib._image.
#
interpolations_names: set[str]
def composite_images(
images: Sequence[_ImageBase], renderer: RendererBase, magnification: float = ...
) -> tuple[np.ndarray, float, float]: ...
class _ImageBase(colorizer.ColorizingArtist):
zorder: float
origin: Literal["upper", "lower"]
axes: Axes
def __init__(
self,
ax: Axes,
cmap: str | Colormap | None = ...,
norm: str | Normalize | None = ...,
colorizer: Colorizer | None = ...,
interpolation: str | None = ...,
origin: Literal["upper", "lower"] | None = ...,
filternorm: bool = ...,
filterrad: float = ...,
resample: bool | None = ...,
*,
interpolation_stage: Literal["data", "rgba", "auto"] | None = ...,
**kwargs
) -> None: ...
def get_size(self) -> tuple[int, int]: ...
def set_alpha(self, alpha: float | ArrayLike | None) -> None: ...
def changed(self) -> None: ...
def make_image(
self, renderer: RendererBase, magnification: float = ..., unsampled: bool = ...
) -> tuple[np.ndarray, float, float, Affine2D]: ...
def draw(self, renderer: RendererBase) -> None: ...
def write_png(self, fname: str | pathlib.Path | BinaryIO) -> None: ...
def set_data(self, A: ArrayLike | None) -> None: ...
def set_array(self, A: ArrayLike | None) -> None: ...
def get_shape(self) -> tuple[int, int, int]: ...
def get_interpolation(self) -> str: ...
def set_interpolation(self, s: str | None) -> None: ...
def get_interpolation_stage(self) -> Literal["data", "rgba", "auto"]: ...
def set_interpolation_stage(self, s: Literal["data", "rgba", "auto"]) -> None: ...
def can_composite(self) -> bool: ...
def set_resample(self, v: bool | None) -> None: ...
def get_resample(self) -> bool: ...
def set_filternorm(self, filternorm: bool) -> None: ...
def get_filternorm(self) -> bool: ...
def set_filterrad(self, filterrad: float) -> None: ...
def get_filterrad(self) -> float: ...
class AxesImage(_ImageBase):
def __init__(
self,
ax: Axes,
*,
cmap: str | Colormap | None = ...,
norm: str | Normalize | None = ...,
colorizer: Colorizer | None = ...,
interpolation: str | None = ...,
origin: Literal["upper", "lower"] | None = ...,
extent: tuple[float, float, float, float] | None = ...,
filternorm: bool = ...,
filterrad: float = ...,
resample: bool = ...,
interpolation_stage: Literal["data", "rgba", "auto"] | None = ...,
**kwargs
) -> None: ...
def get_window_extent(self, renderer: RendererBase | None = ...) -> Bbox: ...
def make_image(
self, renderer: RendererBase, magnification: float = ..., unsampled: bool = ...
) -> tuple[np.ndarray, float, float, Affine2D]: ...
def set_extent(
self, extent: tuple[float, float, float, float], **kwargs
) -> None: ...
def get_extent(self) -> tuple[float, float, float, float]: ...
def get_cursor_data(self, event: MouseEvent) -> None | float: ...
class NonUniformImage(AxesImage):
mouseover: bool
def __init__(
self, ax: Axes, *, interpolation: Literal["nearest", "bilinear"] = ..., **kwargs
) -> None: ...
def set_data(self, x: ArrayLike, y: ArrayLike, A: ArrayLike) -> None: ... # type: ignore[override]
# more limited interpolation available here than base class
def set_interpolation(self, s: Literal["nearest", "bilinear"]) -> None: ... # type: ignore[override]
class PcolorImage(AxesImage):
def __init__(
self,
ax: Axes,
x: ArrayLike | None = ...,
y: ArrayLike | None = ...,
A: ArrayLike | None = ...,
*,
cmap: str | Colormap | None = ...,
norm: str | Normalize | None = ...,
colorizer: Colorizer | None = ...,
**kwargs
) -> None: ...
def set_data(self, x: ArrayLike, y: ArrayLike, A: ArrayLike) -> None: ... # type: ignore[override]
class FigureImage(_ImageBase):
zorder: float
figure: Figure
ox: float
oy: float
magnification: float
def __init__(
self,
fig: Figure,
*,
cmap: str | Colormap | None = ...,
norm: str | Normalize | None = ...,
colorizer: Colorizer | None = ...,
offsetx: int = ...,
offsety: int = ...,
origin: Literal["upper", "lower"] | None = ...,
**kwargs
) -> None: ...
def get_extent(self) -> tuple[float, float, float, float]: ...
class BboxImage(_ImageBase):
bbox: BboxBase
def __init__(
self,
bbox: BboxBase | Callable[[RendererBase | None], Bbox],
*,
cmap: str | Colormap | None = ...,
norm: str | Normalize | None = ...,
colorizer: Colorizer | None = ...,
interpolation: str | None = ...,
origin: Literal["upper", "lower"] | None = ...,
filternorm: bool = ...,
filterrad: float = ...,
resample: bool = ...,
**kwargs
) -> None: ...
def get_window_extent(self, renderer: RendererBase | None = ...) -> Bbox: ...
def imread(
fname: str | pathlib.Path | BinaryIO, format: str | None = ...
) -> np.ndarray: ...
def imsave(
fname: str | os.PathLike | BinaryIO,
arr: ArrayLike,
vmin: float | None = ...,
vmax: float | None = ...,
cmap: str | Colormap | None = ...,
format: str | None = ...,
origin: Literal["upper", "lower"] | None = ...,
dpi: float = ...,
*,
metadata: dict[str, str] | None = ...,
pil_kwargs: dict[str, Any] | None = ...
) -> None: ...
def pil_to_array(pilImage: PIL.Image.Image) -> np.ndarray: ...
def thumbnail(
infile: str | BinaryIO,
thumbfile: str | BinaryIO,
scale: float = ...,
interpolation: str = ...,
preview: bool = ...,
) -> Figure: ...