sleap.gui.overlays.instance¶

Overlay for showing instances.

class sleap.gui.overlays.instance.InstanceOverlay(labels: sleap.io.dataset.Labels = None, player: sleap.gui.widgets.video.QtVideoPlayer = None, state: sleap.gui.state.GuiState = None)[source]¶

Class for adding instances as overlays on video frames.

Mostly this overlay just adds the relevant instances to the player (i.e., QtVideoPlayer) which does the actual drawing.

labels¶: The Labels dataset from which to get overlay data.

player¶: The video player in which to show overlay.

state¶: Object used to communicate with application.

add_to_scene(video, frame_idx)[source]¶: Adds overlay for frame to player scene.