StreamImage Class Reference

Base class of all stream related images. More...

Inherits Image.

Inherited by MultiPartImage, and RingBufferImage.

Properties
	raw_timestamp = property
	float: Gets the raw timestamp as reported by the driver.
Properties inherited from Image
	bounds = property
	cvb.Rect: Bounding rectangle of the image in pixels.
	color_model = property
	int: Color model realized by this image (see cvb.ColorModel).
	coordinate_system = property
	cvb.AffineMatrix2D: Gets or sets the coordinate system of the image.
	height = property
	int: Height of the image in pixels.
	plane_data_types_identical = property
	bool: Check if all planes have the same data type.
	planes = property
	List[cvb.ImagePlane]: Access all planes for this image.
	size = property
	cvb.Size2D: Size of the image in pixels.
	width = property
	int: Width of the image in pixels.

Additional Inherited Members
Public Member Functions inherited from Image
cvb.Image	clone (self)
	Creates a new image object, that is a copy of the current instance.
None	copy (self, cvb.Image target_image, Optional[cvb.Rect] source_rect, Optional[cvb.Point2D] target_position)
	Copies the image data from the source rectangle of this image to the target position inside the target image.
cvb.Image	create (int width, int height, Optional[int] num_planes, Optional[cvb.DataType] data_type)
	Creates an uninitialized image with the given parameters.
cvb.Image	create (cvb.Size2D size, Optional[int] num_planes, Optional[cvb.DataType] data_type)
	Creates an uninitialized image with the given parameters.
cvb.Image	from_images (int mapping, List[cvb.Image] images)
	Create an image that is the result of concatenating a series of input images.
cvb.Image	from_pixel_format (cvb.Size2D size, int format)
	Creates an uninitialized image with the given parameters.
cvb.Image	from_pixel_format (int width, int height, int format)
	Creates an uninitialized image with the given parameters.
cvb.Image	from_planes (int mapping, List[cvb.ImagePlane] planes)
	Create an image that is the result of concatenating a series of input planes.
List[float]	get_pixel (self, cvb.Point2D position)
	Gets the pixel values for all planes at a give position (as float list).
cvb.Point2D	image_to_pixel_coordinates (self, cvb.Point2D point)
	Convert a point from image to pixel coordinates.
cvb.Area2D	image_to_pixel_coordinates (self, cvb.Area2D area)
	Convert an area from image to pixel coordinates.
cvb.Image	load (str file_name)
	Loads an image with the given file name.
cvb.Image	map (self, cvb.Rect source_rect, Optional[cvb.Size2D] target_size)
	Creates a mapped image of the region of that image scaled to the size.
cvb.Image	map_rotated (self, int rotation)
	Creates a mapped image of this whole image rotated by the given rotation.
cvb.Point2D	pixel_to_image_coordinates (self, cvb.Point2D point)
	Convert a point from pixel to image coordinates.
cvb.Point2D	pixel_to_image_coordinates (self, cvb.Point2D area)
	Convert an area from pixel to image coordinates.
None	raise_pixel_content_changed (self, cvb.Rect rect)
	Inform clients listening to the pixel content changed event, that the image data has been updated in the given rectangle.
cvb.EventCookie	register_event_pixel_content_changed (self, Callable[[cvb.Image, cvb.Rect], None] handler)
	Register a listener to the pixel content changed event.
None	save (self)
	Write the current content of the image into a file.
None	save (self, str file_name, float quality)
	Write the current content of the image into a file with the given quality.
None	unregister_event_pixel_content_changed (self, cvb.EventCookie event_cookie)
	Manually unregister a listener from the pixel content changed event.

Detailed Description

Base class of all stream related images.

A stream related image is returned from a grab synchronization method like Stream.wait(). These kinds of images normally use an underlying ring buffer or a queue to reuse memory and increase performance. This then implies, that the validity of this image's data is limited according to the used acquisition engine / strategy.

By default, you expect images of this type to be valid from creation until the next synchronization / acquisition start.

The content of a stream image may be overwritten, depending on cvb.RingBufferLockMode.

Property Documentation

raw_timestamp

raw_timestamp = property

static

float: Gets the raw timestamp as reported by the driver.

This value's unit depends on the driver used.