Image¶

class itala.itala.IImage(*args, **kwargs)¶

Bases: IDisposable

property bytes_filled: int¶: Get the amount of bytes actually stored in the buffer.

clone() → IImage¶

Creates a new image cloned from the current one with its own allocated memory. It needs to be disposed when it’s no longer required via Dispose().

Warning: Chunk data access via GenApi is not available for cloned images: if the source image is directly coming from a grab, it’s highly recommended to manually retrieve the needed chunk values before the source image gets disposed.

Return type:: IImage
Returns:: Pointer to the cloned image instance.

convert(dest_format: PfncFormat) → IImage¶

Creates a new image converted from the current one with its own allocated memory and the specified pixel format. It needs to be disposed when it’s no longer required via Dispose().

Warning: Chunk data access via GenApi is not available for converted images: if the source image is directly coming from a grab, it’s highly recommended to manually retrieve the needed chunk values before the source image gets disposed.

When converting from packed to unpacked formats, the resulting data is aligned according to the PFNC specification. Most of the time the resulting data is LSB aligned, e.g. a 12-bit pixel value stored in a 16-bit component has its MSBs padded with zeroes. See the official PFNC document hosted by EMVA for details.

Return type:: IImage
Returns:: Converted image instance.

property frame_id: int¶: Get the ID of the image.

get_chunk_node(name: str) → PyObject *¶

get_data() → int¶

property has_chunk_data: bool¶: Report wether the buffer contains chunk data or not.

property height: int¶: Get the height of the image in pixels.

property is_incomplete: bool¶: Reports wether the grabbed image is incomplete, i.e. some bytes are missing due to transfer issues.

property offset_x: int¶: Get the offsex along the X axis of the image, in pixels.

property offset_y: int¶: Get the offsex along the Y axis of the image, in pixels.

property padding_x: int¶: Get the padding along the X axis of the image, in pixels.

property padding_y: int¶: Get the padding along the Y axis of the image, in pixels.

property payload_size: int¶: Get the payload size of the image, in bytes.

property pixel_format: PfncFormat¶: Get the pixel format of the image. The PFNC standard from GenICam is used to identify the format.

property thisown¶: The membership flag

property timestamp: int¶: Get the timestamp of the image.

property width: int¶: Get the width of the image in pixels.