tf.io.encode_jpeg

JPEG-encode an image.

View aliases

Main aliases

tf.image.encode_jpeg

Compat aliases for migration

See Migration guide for more details.

tf.compat.v1.image.encode_jpeg, tf.compat.v1.io.encode_jpeg, `tf.compat.v2.image.encode_jpeg`, `tf.compat.v2.io.encode_jpeg`

tf.io.encode_jpeg(
    image, format='', quality=95, progressive=False, optimize_size=False,
    chroma_downsampling=True, density_unit='in', x_density=300, y_density=300,
    xmp_metadata='', name=None
)

image is a 3-D uint8 Tensor of shape [height, width, channels].

The attr format can be used to override the color format of the encoded output. Values can be:

• '': Use a default format based on the number of channels in the image.
• grayscale: Output a grayscale JPEG image. The channels dimension of image must be 1.
• rgb: Output an RGB JPEG image. The channels dimension of image must be 3.

If format is not specified or is the empty string, a default format is picked in function of the number of channels in image:

• 1: Output a grayscale image.
• 3: Output an RGB image.

Args
image	A Tensor of type uint8. 3-D with shape [height, width, channels].
format	An optional string from: "", "grayscale", "rgb". Defaults to "". Per pixel image format.
quality	An optional int. Defaults to 95. Quality of the compression from 0 to 100 (higher is better and slower).
progressive	An optional bool. Defaults to False. If True, create a JPEG that loads progressively (coarse to fine).
optimize_size	An optional bool. Defaults to False. If True, spend CPU/RAM to reduce size with no quality change.
chroma_downsampling	An optional bool. Defaults to True. See http://en.wikipedia.org/wiki/Chroma_subsampling
density_unit	An optional string from: "in", "cm". Defaults to "in". Unit used to specify x_density and y_density: pixels per inch ('in') or centimeter ('cm').
x_density	An optional int. Defaults to 300. Horizontal pixels per density unit.
y_density	An optional int. Defaults to 300. Vertical pixels per density unit.
xmp_metadata	An optional string. Defaults to "". If not empty, embed this XMP metadata in the image header.
name	A name for the operation (optional).

Returns
A Tensor of type string.