Image

class foxglove.layouts.ImagePanel

Display annotated images.

For more information, see [the documentation](https://docs.foxglove.dev/docs/visualization/panels/image).

config: ImageConfig

title: str | None = None

The title of the panel.

class foxglove.layouts.ImageConfig

Configuration for the image panel.

image_mode: ImageModeConfig | None = None

layers: dict[str, BaseRendererGridLayerSettings | BaseRendererTiledMapLayerSettings | BaseRendererUrdfLayerSettings] | None = None

Settings for layers in the scene, indexed by instanceId.

scene: BaseRendererSceneSettings | None = None

topics: dict[str, BaseRendererCameraTopicSettings | BaseRendererGridTopicSettings | BaseRendererLaserScanTopicSettings | BaseRendererPointCloudTopicSettings | BaseRendererPosesTopicSettings | BaseRendererPoseTopicSettings | BaseRendererRosGridMapTopicSettings | BaseRendererRosMarkerTopicSettings | BaseRendererRosOccupancyGridTopicSettings | BaseRendererRosPolygonTopicSettings | BaseRendererRosVelodyneScanTopicSettings | BaseRendererRosVoxelGridTopicSettings | BaseRendererSceneUpdateTopicSettings | BaseRendererUrdfTopicSettings | BaseRendererVoxelGridTopicSettings | BaseRendererImageTopicSettings] | None = None

Settings for topics, indexed by topicName

transforms: dict[str, BaseRendererLayerSettingsTransform] | None = None

frameId -> settings

class foxglove.layouts.ImageAnnotationSettings

Settings for an image annotation topic.

visible: bool | None = None

Whether to display the annotation.

class foxglove.layouts.ImageModeConfig

Settings specific to the Image panel.

annotations: dict[str, ImageAnnotationSettings] | None = None

Settings for the image annotations, indexed by topicName

calibration_topic: str | None = None

Calibration topic to use for distortion and 3D markers

color_field: str | None = None

Value used for “colorMap” coloring logic; any numeric field in the message. Used only if “colorMode” is not “flat”.

color_map: Optional[Literal['turbo', 'rainbow']] = None

Color palette for mapping “colorField” values to colors. Used only if “colorMode” is “colormap”.

color_mode: Optional[Literal['flat', 'gradient', 'colormap', 'rgb', 'rgba', 'rgba-fields']] = None

One of: “flat”, “gradient”, “colormap”, “rgb”, “rgba”, or “rgba-fields”.

explicit_alpha: float | None = None

Sets alpha value for all colors. Used only when “colorMode” is “colormap” or “rgb”.

flat_color: str | None = None

Hex code for color of each point. Used only when “colorMode” is “flat”.

flip_horizontal: bool | None = None

Flip image across the vertical axis

flip_vertical: bool | None = None

Flip image across the horizontal axis

gradient: tuple[str, str] | None = None

The two colors to interpolate between. Used only if “colorMode” is “gradient”.

image_schema_name: str | None = None

Message schema to display

image_topic: str | None = None

Camera image or video topic to display.

max_value: float | None = None

Maximum (white) value for single-channel images.

min_value: float | None = None

Minimum (black) value for single-channel images.

rectify_image: bool | None = None

Whether to rectify (undistort) the image. If turned off, images will be displayed as is and 3D topic visualization will be disabled.

rotation: Optional[Literal[0, 90, 180, 270]] = None

Amount of image rotation

synchronize: bool | None = None

Display annotations only when their messages’ timestamps match

video_decoder: str | None = None

Video decoder