An image encoded as e.g. a JPEG or PNG.

Rerun also supports uncompressed images with the archetypes.Image. For images that refer to video frames see archetypes.VideoFrameReference.

Fields

Required

• blob: Blob

Recommended

• media_type: MediaType

Optional

• opacity: Opacity
• draw_order: DrawOrder
• magnification_filter: MagnificationFilter

Can be shown in

• Spatial2DView
• Spatial3DView (if logged under a projection)
• DataframeView

API reference links

• 🌊 C++ API docs for EncodedImage
• 🐍 Python API docs for EncodedImage
• 🦀 Rust API docs for EncodedImage

Example

Encoded image

"""Create and log an image."""

from pathlib import Path

import rerun as rr

image_file_path = Path(__file__).parent / "ferris.png"

rr.init("rerun_example_encoded_image", spawn=True)

rr.log("image", rr.EncodedImage(path=image_file_path))

View