decode_image¶
- torchvision.io.decode_image(input: Tensor, mode: ImageReadMode = ImageReadMode.UNCHANGED, apply_exif_orientation: bool = False) Tensor [source]¶
Detect whether an image is a JPEG, PNG or GIF and performs the appropriate operation to decode the image into a 3 dimensional RGB or grayscale Tensor.
The values of the output tensor are in uint8 in [0, 255] for most cases. If the image is a 16-bit png, then the output tensor is uint16 in [0, 65535] (supported from torchvision
0.21
. Since uint16 support is limited in pytorch, we recommend callingtorchvision.transforms.v2.functional.to_dtype()
withscale=True
after this function to convert the decoded image into a uint8 or float tensor.- Parameters:
input (Tensor) – a one dimensional uint8 tensor containing the raw bytes of the PNG or JPEG image.
mode (ImageReadMode) – the read mode used for optionally converting the image. Default:
ImageReadMode.UNCHANGED
. SeeImageReadMode
class for more information on various available modes. Ignored for GIFs.apply_exif_orientation (bool) – apply EXIF orientation transformation to the output tensor. Ignored for GIFs. Default: False.
- Returns:
output (Tensor[image_channels, image_height, image_width])