CompositeStreamBase Class Reference

Base class of all composite based streams. More...

Inherits StreamBase.

Inherited by CompositeStream, ImageStream, and PointCloudStream.

Public Member Functions
None	deregister_flow_set_pool (self)
	Removes an existing flow set pool from the acquisition engine.
None	device_abort (self)
	Stops the stream in the device immediately.
None	device_start (self, int buffer_count_to_acquire=-1)
	Starts the stream on the device.
None	device_stop (self)
	Stops the stream in the device.
None	engine_abort (self)
	Stops the acquisition engine immediately.
None	engine_start (self, int buffer_count_to_acquire=-1)
	Starts the acquisition engine on the host.
None	engine_stop (self, int timeout=-1)
	Stops the acquisition engine.
None	register_managed_flow_set_pool (self, int flow_set_count)
	Registers an internal flows set pool.
bool	try_device_abort (self)
	Stops the stream in the device immediately.
bool	try_device_stop (self)
	Stops the stream in the device.
bool	try_engine_abort (self)
	Stops the acquisition engine immediately.
bool	try_engine_stop (self, int timeout=-1)
	Stops the acquisition engine.
Public Member Functions inherited from StreamBase
None	abort (self)
	Stops the acquisition of images immediately.
None	start (self)
	Starts the acquisition.
None	stop (self)
	Stops the acquisition.
bool	try_abort (self)
	Stops the acquisition of images immediately.
bool	try_stop (self)
	Stops the acquisition.

Properties
	acquisition_state = property
	int: Returns the current acquisition state (see cvb.AcquisitionState).
	flow_set_count = property
	int: Gets the number of registered flow sets.
	min_required_flow_set_count = property
	int: Gets minimum number of flow sets required for the acquisition.
	node_maps = property
	Dict[str, Optional[cvb.NodeMap]]: Gets the dictionary holding all available NodeMaps.
Properties inherited from StreamBase
	is_indexed = property
	bool: Returns whether this stream is an indexed stream.

Detailed Description

Base class of all composite based streams.

Member Function Documentation

deregister_flow_set_pool()

None deregister_flow_set_pool

(

self

)

Removes an existing flow set pool from the acquisition engine.

Removing a flow set pool can be useful in between subsequent registrations to reduce memory consumption.This method must only be called when the stream is in AcquisitionState.Stopped.

device_start()

None device_start	(		self,
		int	buffer_count_to_acquire = -1 )

Starts the stream on the device.

Parameters

buffer_count_to_acquire : int Number of buffers to acquire. The default value of -1 starts continuous acquisition that needs to be stopped via engine_stop or engine_abort.

engine_start()

None engine_start	(		self,
		int	buffer_count_to_acquire = -1 )

Starts the acquisition engine on the host.

Parameters

buffer_count_to_acquire : int Number of buffers to acquire. The default value of -1 starts continuous acquisition that needs to be stopped via engine_stop or engine_abort.

engine_stop()

None engine_stop	(		self,
		int	timeout = -1 )

Stops the acquisition engine.

The default value of -1 uses an infinite timeout.

Parameters

timeout : int Timeout duration in milliseconds.

register_managed_flow_set_pool()

None register_managed_flow_set_pool	(		self,
		int	flow_set_count )

Registers an internal flows set pool.

Parameters

flow_set_count : int Number of flow sets to allocate.

try_device_abort()

bool try_device_abort

(

self

)

Stops the stream in the device immediately.

Returns

bool True if successfully stopped, false on error.

try_device_stop()

bool try_device_stop

(

self

)

Stops the stream in the device.

Returns

bool True if successfully stopped, false on error.

try_engine_abort()

bool try_engine_abort

(

self

)

Stops the acquisition engine immediately.

Returns

bool True if successfully stopped, false on error.

try_engine_stop()

bool try_engine_stop	(		self,
		int	timeout = -1 )

Stops the acquisition engine.

The default value of -1 uses an infinite timeout.

Parameters

timeout : int Timeout duration in milliseconds.

Returns

bool True if successfully stopped, false on error.

Property Documentation

node_maps

node_maps = property

static

Dict[str, Optional[cvb.NodeMap]]: Gets the dictionary holding all available NodeMaps.

Access a node map using cvb.NodeMapID, e.g. the GenTL device node map:

node_map = device.node_maps[cvb.NodeMapID.Device]