scipy.ndimage.imread¶

scipy.ndimage.imread(fname, flatten=False, mode=None)[source]¶

Read an image from a file as an array.

Parameters:

Parameters:	fname : str Image file name, e.g. `test.jpg`, or a file object. flatten : bool, optional If true, convert the output to grey-scale. Default is False. mode : str, optional mode to convert image to, e.g. `RGB`.
Returns:	img_array : ndarray The different colour bands/channels are stored in the third dimension, such that a grey-image is MxN, an RGB-image MxNx3 and an RGBA-image MxNx4.
Raises:	ImportError If the Python Imaging Library (PIL) can not be imported.

fname : str

Image file name, e.g. test.jpg, or a file object.

flatten : bool, optional

If true, convert the output to grey-scale. Default is False.

mode : str, optional

mode to convert image to, e.g. RGB.

Returns:

img_array : ndarray

The different colour bands/channels are stored in the third dimension, such that a grey-image is MxN, an RGB-image MxNx3 and an RGBA-image MxNx4.

Raises:

ImportError

If the Python Imaging Library (PIL) can not be imported.