pyflink.dataframe.DataType.image#

classmethod DataType.image(mode: Optional[pyflink.common.image.ImageMode] = None, height: Optional[int] = None, width: Optional[int] = None) → pyflink.dataframe.datatype.DataType[source]#

Decoded image type.

Parameters

mode – Image mode, e.g. ImageMode.L, ImageMode.LA, ImageMode.RGB, ImageMode.RGBA, or ImageMode.L16.
height – Fixed image height. Requires mode and width.
width – Fixed image width. Requires mode and height.

Only the fully fixed-shape form enables optimized serialization. Mode-only images remain self-describing at runtime.

Example:

>>> DataType.image()
>>> DataType.image(ImageMode.RGB)
>>> DataType.image(ImageMode.RGB, height=224, width=224)