CVBpy 15.0
IndexedStream Class Reference

A stream with a finite number of images, which can also be accessed via an index. More...

Inherits Stream.

Properties

 image_count = property
 int: Gets the number of images contained in this stream.
 
 image_index = property
 int: Gets or sets the index of the current active image.
 
- Properties inherited from Stream
 acquisition_interface = property
 int: Gets or sets the interface of this implementation (see cvb.AcquisitionInterface).
 
 is_running = property
 bool: Returns whether the acquisition is currently active.
 
 ring_buffer = property
 Optional[cvb.RingBuffer]: Gets the ring buffer interface object if present.
 
 statistics = property
 cvb.StreamStatistics: Gets statistics.
 
- Properties inherited from StreamBase
 is_indexed = property
 bool: Returns whether this stream is an indexed stream.
 

Additional Inherited Members

- Public Member Functions inherited from Stream
Tuple[Optional[cvb.StreamImage], int] get_snapshot (self)
 Acquires a single image and returns it. More...
 
Tuple[Optional[cvb.StreamImage], int] get_timed_snapshot (self, int time_span)
 Acquires a single image for a given time span and returns it. More...
 
Tuple[Optional[Union[cvb.RingBufferImage, cvb.StreamImage]], int] wait (self)
 Waits forever for the next acquired image and returns it. More...
 
cvb.AsyncWaitResult wait_async (self, int time_span)
 Waits asynchronously for the next acquired image. More...
 
cvb.AsyncWaitResult wait_async_for (self, int time_span)
 Waits asyncronously for the given time span for the next acquired image. More...
 
Tuple[Optional[Union[cvb.RingBufferImage, cvb.StreamImage]], int] wait_for (self, int time_span)
 Waits for the given time span for the next acquired image. 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...
 

Detailed Description

A stream with a finite number of images, which can also be accessed via an index.