zen_api/acquisition/v1beta/frame_pixel_data.proto

Version: 2026.5.1

Package: zen_api.acquisition.v1beta

Download proto source

Message FramePixelData

A simple container for the frame pixel data. 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).

Field	Number	Type	Presence	Description
start_position	1	zen_api.common.v1.IntPoint	singular	The start position (in pixels) of the pixel data in the frame. Together with the size property, this represents the rectangle where the pixels are located inside the full frame. For ordinary acquisition this will be the top left corner of the frame, but for partial acquisition this can be any position inside the full frame relative to the top left corner.
size	2	zen_api.common.v1.IntSize	singular	Size (in pixels) of the pixel data. Together with the start position property, this represents the rectangle where the pixels are located inside the full frame. For ordinary acquisition this will be the full frame size, but for partial acquisition this can be just one part of the full frame.
pixel_type	3	zen_api.acquisition.v1beta.PixelType	singular	The pixel type of the frame.
raw_data	4	bytes	singular	The raw pixel data. The value of individual pixels is contained in this container. The pixel values need to be extracted from the raw byte data. The number of bits needed to extract a single pixel from the raw byte data and the format it is stored in is determined by the pixel type property.