ChunkImageBufferDescription Class Reference

Describes a GenICam Pixel Format Naming Convention (PFNC) compatible image memory buffer with possibly additional data. More...

Inherits ImageBufferDescription.

Public Member Functions
cvb.gevserver.ChunkImageBufferDescription	create_chunk_image_buffer_description (cvb.Size2D size, int pixel_format, int color_model, cvb.DataType data_type, int total_payload_size)
	Creates a default chunk image buffer description. More...
cvb.gevserver.ChunkImageBufferDescription	create_chunk_image_buffer_description_pfnc (cvb.Size2D size, int pixel_format, int total_payload_size)
	Creates a default chunk image buffer description. More...
Public Member Functions inherited from ImageBufferDescription
cvb.gevserver.ImageBufferDescription	create_image_buffer_description (cvb.Size2D size, int color_model, cvb.DataType data_type)
	Creates a default image buffer description. More...
cvb.gevserver.ImageBufferDescription	create_image_buffer_description_pfnc (cvb.Size2D size, int pixel_format)
	Creates a default image buffer description. More...

Properties
	layout_id = property
	int: Gets or sets the layout identifier for the chunks. More...
	total_payload_size = property
	int: Gets or sets a valid payload size over all chunks including the image chunk.
Properties inherited from ImageBufferDescription
	line_padding = property
	int: Gets or sets the line padding. More...
	offset = property
	cvb.Point2D: Gets or sets the image's offset on the sensor. More...
	pixel_format = property
	int: Gets or sets the image pixel format (see cvb.PfncFormat).
	size = property
	cvb.Size2D: Gets or sets the image size.

Detailed Description

Describes a GenICam Pixel Format Naming Convention (PFNC) compatible image memory buffer with possibly additional data.

This buffer does not need to be CVB Image compatible. You can use all PFNC values, even packed ones.

Member Function Documentation

create_chunk_image_buffer_description()

cvb.gevserver.ChunkImageBufferDescription create_chunk_image_buffer_description	(	cvb.Size2D	size,
		int	pixel_format,
		int	color_model,
		cvb.DataType	data_type,
		int	total_payload_size
	)

Creates a default chunk image buffer description.

Tries to map the given color_model and data_type to a PfncFormat.

Parameters

size : cvb.Size2D Width and height in pixels.

pixel_format : int GenICam PFNC format value (see cvb.PfncFormat).

color_model : int Color model of the image to send (see cvb.ColorModel).

data_type : cvb.DataType CVB data type of the image to send.

total_payload_size : int Size of the valid payload over all chunks (including the image).

Returns

cvb.gevserver.ChunkImageBufferDescription Its default chunk image buffer description.

create_chunk_image_buffer_description_pfnc()

cvb.gevserver.ChunkImageBufferDescription create_chunk_image_buffer_description_pfnc	(	cvb.Size2D	size,
		int	pixel_format,
		int	total_payload_size
	)

Creates a default chunk image buffer description.

Parameters

size : cvb.Size2D Width and height in pixels.

pixel_format : int GenICam PFNC format value (see cvb.PfncFormat).

total_payload_size : int Size of the valid payload over all chunks (including the image).

Returns

cvb.gevserver.ChunkImageBufferDescription Its default chunk image buffer description.

Property Documentation

layout_id

layout_id = property

static

int: Gets or sets the layout identifier for the chunks.

Change the identifier if the layout size of the chunks you send changes. This is to reduce parse time on the client side. An easy way to define such an identifier is to use a bit field for all supported chunks. A value of 0 means that the layout mechanism is not used and the client must parse the chunk layout for each buffer.