Image.Zeros#

classmethod Image.Zeros(*, size: int | Sequence[int] | None = None, colororder: str | None = None, dtype: Dtype | None = None, like=None) → Self[source]#

Create image with zero value pixels

Parameters:

  • size (int or 2-tuple, optional) – image size, width x height, defaults to like.size if like is given

  • colororder (str) – color plane names, defaults to None

  • dtype (str or NumPy dtype, optional) – NumPy datatype, defaults to ‘uint8’

  • like (Image or None, optional) – template image supplying default size and colororder when those are not given explicitly

Returns:

image of zero values

Return type:

Image

Create a greyscale image of zero-valued pixels. If only one dimension is given the image is square.

Example:

>>> from machinevisiontoolbox import Image
>>> Image.Zeros(size=20)
Image(size=(20, 20), dtype=uint8)
>>> Image.Zeros(size=(10, 20))
Image(size=(10, 20), dtype=uint8)
>>> Image.Zeros(size=(10,20))
Image(size=(10, 20), dtype=uint8)
>>> Image.Zeros(size=(10,20,3), colororder='RGB')
Image(size=(10, 20), dtype=uint8, nplanes=3, colororder=R:G:B)
>>> Image.Zeros(size=20, dtype='float', colororder="RGB") # create color image, all black
Image(size=(20, 20), dtype=float32, nplanes=3, colororder=R:G:B)
Seealso:

Constant