The image stream class. More...
Inherits CompositeStreamBase.
Public Member Functions | |
Tuple[Optional[cvb.MultiPartImage], int, Optional[cvb.NodeMapEnumerator]] | wait (self, Optional[cvb.CancellationToken] token) |
Waits forever for the next acquired image. More... | |
cvb.AsyncWaitResultImageTuple | wait_async (self, int time_span) |
Waits asynchronously for the next acquired image. More... | |
cvb.AsyncWaitResultImageTuple | wait_async_for (self, int time_span) |
Waits asynchronously for the given time span for the next acquired image. More... | |
Tuple[Optional[cvb.MultiPartImage], int, Optional[cvb.NodeMapEnumerator]] | wait_for (self, int time_span, Optional[cvb.CancellationToken] token) |
Waits for the given time span for the next acquired image. More... | |
Public Member Functions inherited from CompositeStreamBase | |
None | deregister_flow_set_pool (self) |
Removes an existing flow set pool from the acquisition engine. More... | |
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. More... | |
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. More... | |
None | engine_stop (self, int timeout=-1) |
Stops the acquisition engine. More... | |
None | register_managed_flow_set_pool (self, int flow_set_count) |
Registers an internal flows set pool. More... | |
bool | try_device_abort (self) |
Stops the stream in the device immediately. More... | |
bool | try_device_stop (self) |
Stops the stream in the device. More... | |
bool | try_engine_abort (self) |
Stops the acquisition engine immediately. More... | |
bool | try_engine_stop (self, int timeout=-1) |
Stops the acquisition engine. More... | |
Public Member Functions inherited from StreamBase | |
None | abort (self) |
Stops the acquisition of images immediately. More... | |
None | start (self) |
Starts the acquisition. More... | |
None | stop (self) |
Stops the acquisition. More... | |
bool | try_abort (self) |
Stops the acquisition of images immediately. More... | |
bool | try_stop (self) |
Stops the acquisition. More... | |
Additional Inherited Members | |
Properties inherited from CompositeStreamBase | |
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. More... | |
Properties inherited from StreamBase | |
is_indexed = property | |
bool: Returns whether this stream is an indexed stream. | |
The image stream class.
Tuple[Optional[cvb.MultiPartImage], int, Optional[cvb.NodeMapEnumerator]] wait | ( | self, | |
Optional[cvb.CancellationToken] | token | ||
) |
Waits forever for the next acquired image.
token : Optional[cvb.CancellationToken] A token to cancel this individual wait.
Tuple[Optional[cvb.MultiPartImage], int, Optional[cvb.NodeMapEnumerator]] A tuple containing an image, the wait status (see cvb.WaitStatus), and a node map enumerator.
cvb.AsyncWaitResultImageTuple wait_async | ( | self, | |
int | time_span | ||
) |
Waits asynchronously for the next acquired image.
time_span : int Time (in ms) to wait for an image.
cvb.AsyncWaitResultImageTuple An async wait result that is awaitable.
cvb.AsyncWaitResultImageTuple wait_async_for | ( | self, | |
int | time_span | ||
) |
Waits asynchronously for the given time span for the next acquired image.
time_span : int Time (in ms) to wait for an image.
cvb.AsyncWaitResultImageTuple An async wait result that is awaitable.
Tuple[Optional[cvb.MultiPartImage], int, Optional[cvb.NodeMapEnumerator]] wait_for | ( | self, | |
int | time_span, | ||
Optional[cvb.CancellationToken] | token | ||
) |
Waits for the given time span for the next acquired image.
time_span : int Time to wait for data (in ms).
token : Optional[cvb.CancellationToken] A token to cancel this individual wait.
Tuple[Optional[cvb.MultiPartImage], int, Optional[cvb.NodeMapEnumerator]] A tuple containing a image, the wait status (see cvb.WaitStatus), and an node map enumerator.