Skip to content

zen_api/acquisition/v1beta/frame_data.proto#

Version: 2026.5.1

Package: zen_api.acquisition.v1beta

Download proto source

Message FrameData#

A simple container for the frame data. This can contain either a full frame or only a part of it (e.g., in case of partial acquisition when working with EM and LSM).

Field Number Type Presence Description
experiment_id 1 string singular The ID of the experiment.
frame_number 2 int32 singular The frame sequence number.
One frame can represent either a single image taken by the camera or one full scan in
case of partial acquisition. One frame can also contain multiple channels if they are
acquired in the same image or scan.
frame_position 3 zen_api.acquisition.v1beta.FramePosition singular The position of the full frame.
frame_size 4 zen_api.common.v1.IntSize singular The size of the full frame (in pixels).
frame_stage_position 5 zen_api.acquisition.v1beta.FrameStagePosition singular The stage position of the acquired full frame.
scaling 6 zen_api.acquisition.v1beta.Scaling singular The scaling of the frame.
pixel_data 7 zen_api.acquisition.v1beta.FramePixelData singular The pixel data of the frame.
This can contain either the pixels of a full frame or only a part of it (e.g., a line or
a rectangle in case of partial acquisition when working with EM and LSM).