_ImageSchema

class pyspark.ml.image._ImageSchema

Internal class for pyspark.ml.image.ImageSchema attribute. Meant to be private and not to be instantized. Use pyspark.ml.image.ImageSchema attribute to access the APIs of this class.

Methods

toImage(array[, origin])	Converts an array with metadata to a two-dimensional image.
toNDArray(image)	Converts an image to an array with metadata.

Attributes

columnSchema	Returns the schema for the image column.
imageFields	Returns field names of image columns.
imageSchema	Returns the image schema.
ocvTypes	Returns the OpenCV type mapping supported.
undefinedImageType	Returns the name of undefined image type for the invalid image.

Methods Documentation

toImage(array, origin='')

Converts an array with metadata to a two-dimensional image.

Parameters

arraynumpy.ndarray

The array to convert to image.

originstr

Path to the image, optional.

Returns

Row

that is a two dimensional image.

New in version 2.3.0: ..

toNDArray(image)

Converts an image to an array with metadata.

Parameters

imageRow

image: A row that contains the image to be converted. It should have the attributes specified in ImageSchema.imageSchema.

Returns

numpy.ndarray

that is an image.

New in version 2.3.0: ..

Attributes Documentation

columnSchema

Returns the schema for the image column.

Returns

StructType

a schema for image column, struct<origin:string, height:int, width:int, nChannels:int, mode:int, data:binary>.

New in version 2.4.0: ..

imageFields

Returns field names of image columns.

Returns

list

a list of field names.

New in version 2.3.0: ..

imageSchema

Returns the image schema.

Returns

StructType

with a single column of images named “image” (nullable) and having the same type returned by columnSchema().

New in version 2.3.0: ..

ocvTypes

Returns the OpenCV type mapping supported.

Returns

dict

a dictionary containing the OpenCV type mapping supported.

New in version 2.3.0: ..

undefinedImageType

Returns the name of undefined image type for the invalid image.

New in version 2.3.0.

ImageSchema BaseReadWrite