`plotter.images`¶

class `Image(Drawable)`¶

Class for creating an image to be drawn on a canvas.

Attributes:

Name	Type	Description
`data`	np.ndarray	The 2D or 3D numpy array containing the image data. If 3D, the third dimension must contain 3 (RGB) or 4 (RGBA) values.

Raises:

Type	Description
ValueError	If the data is not a 2D or 3D array.
ValueError	If the third dimension of a 3D array is not 3 or 4.
ValueError	If the data is not real.

Defined attributes:

draw(self, canvas: Canvas, plot_n: int=0, label: str | None=None, **kwargs) -> None

Draws the image on the canvas.

Args:

Name	Type	Description
`canvas`	Canvas	The canvas object to draw the image on.
`plot_n`	int, optional	The index of the subplot to draw on. Defaults to 0.
`label`	str, optional	The label for the colorbar. Defaults to `None`.

Keyword Arguments:

Name	Type	Description
`colormap`	str	The Matplotlib colormap to use. Defaults to "plasma".
`log`	bool or tuple[bool, float]	Controls the scale of the colormap. - `bool`: `True` for logarithmic scale. - `tuple`: `(True, float)` for a 'symlog' scale with a linear range of `float`. This parameter is ignored if the data is RGB(A). Defaults to `False`.
`v_range`	tuple[float, float]	The minimum and maximum intensity values. Ignored if the data is RGB(A). Defaults to `(None, None)`.
`aspect`	str	The aspect ratio of the axes. `equal` for squared pixels, `auto` for a squared image. Defaults to "equal".
`origin`	str	The placement of the [0,0] element of the data. `upper` for the top-left, `lower` for the bottom-left. Defaults to "upper".
`limits`	list[float]	The limits of the x and y axes in the format `\[left, right, bottom, top\]`. Defaults to `None`.
`colorbar`	dict	To style the colorbar. Defaults to `None`. - `"pos"` (str): where to put the colorbar (right, left, top, bottom) - `"size"` (str): % of size of axes - `"pad"` (float): padding between colorbar and image

_add_colorbar(self, canvas: Canvas, plot_n: int) -> None

Adds the colorbar to an image.

Args:

Name	Type	Description
``	-	See `draw`.