ImageBufferDescription Class Reference

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

Inherits object.

Inherited by ChunkImageBufferDescription.

Public Member Functions
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
	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.

This buffer needn't be CVB Image compatible. You can use all PFNC values even packed ones.

Member Function Documentation

create_image_buffer_description()

cvb.gevserver.ImageBufferDescription create_image_buffer_description	(	cvb.Size2D	size,
		int	color_model,
		cvb.DataType	data_type
	)

Creates a default 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.

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.

Returns

cvb.gevserver.ImageBufferDescription The default image buffer description.

create_image_buffer_description_pfnc()

cvb.gevserver.ImageBufferDescription create_image_buffer_description_pfnc	(	cvb.Size2D	size,
		int	pixel_format
	)

Creates a default image buffer description.

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

Parameters

size : cvb.Size2D GenICam PFNC format value.

pixel_format : int CVB data type of the image to send.

Returns

cvb.gevserver.ImageBufferDescription The default image buffer description.

Property Documentation

line_padding

line_padding = property

static

int: Gets or sets the line padding.

Line padding is a contiguous block at the end of each line that holds no meaningful data. This is normally used to align lines.

offset

offset = property

static

cvb.Point2D: Gets or sets the image's offset on the sensor.

The server always sends an image with the given Size. The offset is only for information.