senseye_cameras package

Subpackages

• senseye_cameras.input package
  • Submodules
  • senseye_cameras.input.camera_ffmpeg module
  • senseye_cameras.input.camera_pylon module
  • senseye_cameras.input.camera_raw_video module
  • senseye_cameras.input.camera_ueye module
  • senseye_cameras.input.camera_usb module
  • senseye_cameras.input.input module
  • senseye_cameras.input.input_factory module
  • senseye_cameras.input.microphone module
  • Module contents
• senseye_cameras.output package
  • Submodules
  • senseye_cameras.output.audio_file module
  • senseye_cameras.output.file module
  • senseye_cameras.output.h264_pipe module
  • senseye_cameras.output.output module
  • senseye_cameras.output.output_factory module
  • senseye_cameras.output.video_file module
  • Module contents

Submodules

senseye_cameras.loop_thread module

class senseye_cameras.loop_thread.LoopThread(frequency=1000, stop_on_error=False)

Bases: threading.Thread

Class to follow common pattern of looping thread

loop()

on_error(e)

on_start()

on_stop()

restart()

Restart at thread Seperated from start / stop because thread functions like join / is alive May return unexpected results from this

run()

Method representing the thread’s activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object’s constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

stop(join=True)

senseye_cameras.reader module

class senseye_cameras.reader.Reader(q, on_read=None, type='usb', config=None, id=0, frequency=None, reading=False, writing=False)

Bases: senseye_cameras.loop_thread.LoopThread

Reads data into a queue.

loop()

on_stop()

senseye_cameras.safe_queue module

class senseye_cameras.safe_queue.SafeQueue(maxsize=0, module='Generic')

Bases: queue.Queue

Class that extends Python Queue to safely handle exceptions from Queue accessor methods.

get(block=True, timeout=None)

Attempt to retrieve an element from the queue, handling the Empty exception if it arises. Returns the item or None if dequeue is unsuccessful.

Note: It is possible that a None object was enqueued. Checking for a None value on a get() call will be ambiguous in this case. It may mean the original item was None or that the queue is empty.

get_nowait()

Non-blocking get with exception handling.

put(item, block=True, timeout=None, force=False)

Attempt to insert an item into the queue, handling the Full exception if it arises. Return True if item is successfully enqueued. If a force was required, return the dequeued item.

put_nowait(item, force=False)

Non-blocking put with exception handling.

remove_existing(num_elements=None)

Pops items from self queue and appends to a list. Mutates self queue by removing qsize elements.

Note: If you force an item to be input into the queue during this operation, you may clobber data. For example: - SafeQueue size is 10 when remove_existing() is called - SafeQueue maxsize is 10 - SafeQueue.put_nowait(an_item, force=True) - The first item is forced off, and may not have been grabbed into the list. - Using a mutex here may cause a deadlock.

to_list()

Converts queue to a list.

senseye_cameras.stream module

class senseye_cameras.stream.Stream(input_type='usb', input_config=None, id=0, output_type='ffmpeg', output_config=None, path='.', input_frequency=None, output_frequency=None, reading=False, writing=False, on_read=None, on_write=None, queue_size=700)

Bases: object

Links an Input with an Output.

Args:

input_type/input_config/id: see create_input. output_type/output_config/path: see create_output reading/writing (bool): whether to read/write on start. on_read (func): called on frame read. Function should take fn(data=None, timestamp=None) as args. on_read/on_write (func): called on frame write. Function should take fn(data=None)

set_path(path=None)

Sets the writers’ path.

start_reading()

Starts reading in frames.

start_writing()

Starts writing frames.

stop()

stop_reading()

Stops reading in frames.

stop_writing()

Stops writing frames.

senseye_cameras.writer module

class senseye_cameras.writer.Writer(q, on_write=None, type='ffmpeg', config=None, path=0, frequency=None, writing=False, input_config=None)

Bases: senseye_cameras.loop_thread.LoopThread

Writes data from a queue into an output file.

flush()

initialize_writer()

loop()

on_stop()

set_path(path=None)

Module contents

Senseye Camera Utility Package.

abstractions:

camera - a video/camera interface that produces frames. recorder - an interface that takes in frames and writes them to disk.

create a camera/recorder through the create_camera/create_recorder functions.