rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Created initial general documentation

Browse source
This commit is contained in:
Joel Collins 2018-11-16 15:46:19 +00:00
parent dd7a3ff2e5
commit ea10cf1ce9
16 changed files with 607 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

31
openflexure_microscope/camera/base.py
View file

@ -34,13 +34,12 @@ def entry_by_id(id: str, object_list: list):
class CameraEvent(object):
def __init__(self):
"""
Create a frame-signaller object for StreamingCamera.
"""
A frame-signaller object used by any instances or subclasses of BaseCamera.
An event-like class that signals all active clients
when a new frame is available.
"""
An event-like class that signals all active clients when a new frame is available.
"""
def __init__(self):
self.events = {}
def wait(self, timeout: int=5):
@ -79,21 +78,23 @@ class CameraEvent(object):
class BaseCamera(object):
"""
Base implementation of StreamingCamera.
"""
def __init__(self):
"""Base implementation of StreamingCamera."""
self.thread = None # Background thread that reads frames from camera
self.camera = None # Camera object, for direct access to camera
self.thread = None #: Background thread reading frames from camera
self.camera = None #: Camera object
self.frame = None # Current frame is stored here by background thread
self.last_access = 0 # Time of last client access to the camera
self.frame = None #: bytes: Current frame is stored here by background thread
self.last_access = 0 #: time: Time of last client access to the camera
self.event = CameraEvent()
self.state = {} # Create dict for capture state
self.settings = {} # Create dict to store settings
self.state = {} #: dict: Dictionary for capture state
self.settings = {} #: dict: Dictionary of camera settings
# Capture data
self.images = []
self.videos = []
self.images = [] #: list: List of image capture objects
self.videos = [] #: list: List of video recording objects
def __enter__(self):
"""Create camera on context enter."""

3
openflexure_microscope/camera/capture.py
View file

@ -11,6 +11,9 @@ thumbnail_size = (60, 60)
class StreamObject(object):
"""
StreamObject used to store and process capture data, and metadata.
"""
def __init__(
self,
write_to_file: bool=None,

91
openflexure_microscope/camera/pi.py
View file

@ -55,12 +55,12 @@ DEFAULT_CONFIG = os.path.join(HERE, 'config_picamera.yaml')
class StreamingCamera(BaseCamera):
"""Raspberry Pi camera implementation of StreamingCamera."""
def __init__(self):
"""Raspberry Pi camera implementation of StreamingCamera."""
# Run BaseCamera init
BaseCamera.__init__(self)
# Attach to Pi camera
self.camera = picamera.PiCamera()
self.camera = picamera.PiCamera() #: :py:class:`picamera.PiCamera`: Picamera object
# Camera settings
self.settings.update({
@ -93,13 +93,21 @@ class StreamingCamera(BaseCamera):
# HANDLE SETTINGS
# TODO: Handle exceptions
# TODO: Have this take a dictionary (not a config file)
# TODO: Web API entry point to send settings as JSON to this method
# TODO: Separate method to store current settings back to YAML file
# TODO: API entry point to get settings to JSON
def update_settings(self, config_path: str=None) -> None:
"""Open config_picamera.yaml file and write to camera."""
"""
Open config_picamera.yaml file and write to camera.
Todo:
TODO: Handle exceptions
TODO: Have this take a dictionary (not a config file)
TODO: Web API entry point to send settings as JSON to this method
TODO: Separate method to store current settings back to YAML file
TODO: API entry point to get settings to JSON
"""
global DEFAULT_CONFIG
paused_stream = False
@ -164,7 +172,12 @@ class StreamingCamera(BaseCamera):
"Cannot update camera settings while recording is active.")
def change_zoom(self, zoom_value: int=1) -> None:
"""Change the camera zoom, handling recentering and scaling."""
"""Change the camera zoom, handling recentering and scaling.
Todo:
TODO: Needs to be re-implemented
"""
zoom_value = float(zoom_value)
if zoom_value < 1:
zoom_value = 1
@ -204,17 +217,20 @@ class StreamingCamera(BaseCamera):
folder: str='record',
fmt: str='h264',
quality: int=15):
"""Start a new video recording, writing to a target object.
"""Start recording.
Start a new video recording, writing to a target object.
Args:
target (str/BytesIO): Target object to write bytes to.
write_to_file (bool/NoneType): Should the StreamObject write to a file?
filename (str): Name of the stored file. Defaults to timestamp.
folder (str): Relative directory to store data file in.
fmt (str): Format of the capture.
Returns:
target_object (str/BytesIO): Target object.
target (str/BytesIO): Target object to write bytes to.
(default StreamObject)
write_to_file (bool/NoneType): Should the StreamObject write to a file?
(default True for video capture)
filename (str): Name of the stored file.
(defaults to timestamp)
folder (str): Relative directory to store data file in.
fmt (str): Format of the capture.
(default 'h264')
"""
# Start recording method only if a current recording is not running
if not self.state['record_active']:
@ -274,9 +290,9 @@ class StreamingCamera(BaseCamera):
"""
Pause capture on a splitter port.
splitter_port (int): Splitter port to stop recording on
resolution ((int, int)): Resolution to set the camera to,
after stopping recording.
Args:
splitter_port (int): Splitter port to stop recording on
resolution ((int, int)): Resolution to set the camera to, after stopping recording.
"""
logging.debug("Pausing stream")
# If no resolution is specified, default to image_resolution
@ -296,9 +312,9 @@ class StreamingCamera(BaseCamera):
"""
Resume capture on a splitter port.
splitter_port (int): Splitter port to start recording on
resolution ((int, int)): Resolution to set the camera to,
before starting recording.
Args:
splitter_port (int): Splitter port to start recording on
resolution ((int, int)): Resolution to set the camera to, before starting recording.
"""
logging.debug("Unpausing stream")
if not resolution:
@ -330,17 +346,14 @@ class StreamingCamera(BaseCamera):
Defaults to JPEG format.
Target object can be overridden for development purposes.
target (str/BytesIO): Target object to write data bytes to.
write_to_file (bool): Should the StreamObject write to a file,
instead of BytesIO stream?
use_video_port (bool): Capture from the video port used for streaming.
(lower resolution, faster)
filename (str): Name of the stored file.
(defaults to timestamp)
folder (str): Relative directory to store data file in.
fmt (str): Format of the capture.
(default 'h264')
resize ((int, int)): Resize the captured image.
Args:
target (str/BytesIO): Target object to write data bytes to.
write_to_file (bool): Should the StreamObject write to a file, instead of BytesIO stream?
use_video_port (bool): Capture from the video port used for streaming. Lower resolution, faster.
filename (str): Name of the stored file. Defaults to timestamp.
folder (str): Relative directory to store data file in.
fmt (str): Format of the capture.
resize ((int, int)): Resize the captured image.
"""
# If no target is specified, store to StreamingCamera
if not target:
@ -391,9 +404,9 @@ class StreamingCamera(BaseCamera):
resize: Tuple[int, int]=None) -> np.ndarray:
"""Capture an uncompressed still YUV image to a Numpy array.
use_video_port (bool): Capture from the video port used for streaming.
(lower resolution, faster)
resize ((int, int)): Resize the captured image.
Args:
use_video_port (bool): Capture from the video port used for streaming. Lower resolution, faster.
resize ((int, int)): Resize the captured image.
"""
if use_video_port:
resolution = self.settings['video_resolution']