Display

Back to Scenes

Classes:

LayoutDirection An enumeration.

Functions:

display(*imgs, **kwargs) Display 2D and 3D ndarrays as images with matplotlib.
save_image(filename, *imgs, **kwargs) Save 2D and 3D ndarrays as images with matplotlib.
class LayoutDirection[source]

An enumeration.

display(*imgs, **kwargs)[source]

Display 2D and 3D ndarrays as images with matplotlib.

The ndarrays must either be 2D, or 3D with 1 or 3 bands. If they are 3D masked arrays, the mask will be used as an alpha channel.

Unlike matplotlib’s imshow, arrays can be any dtype; internally, each is normalized to the range [0..1].

Parameters:
  • *imgs (1 or more ndarrays) – When multiple images are given, each is displayed on its own row by default.
  • bands_axis (int, default 0) – Axis which contains bands in each array.
  • title (str, or sequence of str; optional) – Title for each image. If a sequence, must be the same length as imgs.
  • size (int, default 10) – Length, in inches, to display the longer side of each image.
  • robust (bool, default True) – Use the 2nd and 98th percentiles to compute color limits. Otherwise, the minimum and maximum values in each array are used.
  • interpolation (str, default "bilinear") –

    Interpolation method for matplotlib to use when scaling images for display.

    Bilinear is the default, since it produces smoother results when scaling down continuously-valued data (i.e. images). For displaying discrete data, however, choose ‘nearest’ to prevent values not existing in the input from appearing in the output.

    Acceptable values are ‘none’, ‘nearest’, ‘bilinear’, ‘bicubic’, ‘spline16’, ‘spline36’, ‘hanning’, ‘hamming’, ‘hermite’, ‘kaiser’, ‘quadric’, ‘catrom’, ‘gaussian’, ‘bessel’, ‘mitchell’, ‘sinc’, ‘lanczos’

  • colormap (str, default None) –

    The name of a Colormap registered with matplotlib. Some commonly used built-in options are ‘plasma’, ‘magma’, ‘viridis’, ‘inferno’. See https://matplotlib.org/users/colormaps.html for more options.

    To use a Colormap, the input images must have a single band. The Colormap will be ignored for images with more than one band.

  • figsize (tuple(int), default (size, (size / ncols) * nrows)) – Width, height in inches.
  • nrows (int, default is the number of images) – Number of rows if there are multiple images.
  • ncols (int, default 1) – Number of columns if there are multiple images.
  • layout_direction (str, default "left-to-right") – If ncols is greated than 1, it determines whether the layout is left-to-right for the images, or top-to-bottom.
Raises:

ImportError – If matplotlib is not installed.
save_image(filename, *imgs, **kwargs)[source]

Save 2D and 3D ndarrays as images with matplotlib.

For an explanation of the rest of the arguments, please look under display(). For an explanation of valid extension types, please look under matplotlib :func:’savefig’.

Parameters:filename (str) – The name and extension of the image to be saved.