diff --git a/src/openflexure_microscope_server/things/__init__.py b/src/openflexure_microscope_server/things/__init__.py index 28a16309..cfa95023 100644 --- a/src/openflexure_microscope_server/things/__init__.py +++ b/src/openflexure_microscope_server/things/__init__.py @@ -69,7 +69,7 @@ class OFMThing(lt.Thing): :param path: The relative path within the data directory of this Thing's data dir that the data shudl be saved. - :path absolute: Set to True if the current path is absolute. A relative path + :param absolute: Set to True if the current path is absolute. A relative path will be returned. An validation error will be raised if the absolute path is not within the data directory. diff --git a/src/openflexure_microscope_server/things/camera/__init__.py b/src/openflexure_microscope_server/things/camera/__init__.py index a2bf2564..478386fc 100644 --- a/src/openflexure_microscope_server/things/camera/__init__.py +++ b/src/openflexure_microscope_server/things/camera/__init__.py @@ -610,9 +610,11 @@ class BaseCamera(OFMThing, ABC): This is not an action as it exposes a direct path for saving - :param path: The path to save the file to - :param save_resolution: can be set to resize the image before saving. By - default this is None meaning that the image is saved at original resolution. + :param path: The path to save the file to, this should be a ``RelativeDataPath`` + object. If the saving Thing is not set for the path, the camera's data + directory will be used. + :param capture_mode: (Optional) The name of the capture mode as defined by the + camera. """ buffer_id = self.capture_to_memory(capture_mode=capture_mode) self.save_from_memory(path=path, buffer_id=buffer_id) @@ -667,9 +669,6 @@ class BaseCamera(OFMThing, ABC): be written to. :param path: The path to save the file to - :param save_resolution: can be set to resize the image before saving. By - default this is None meaning that the image is saved at original - resolution. :param buffer_id: The buffer id of the image to save, this was returned by ``capture_to_memory`` """ diff --git a/src/openflexure_microscope_server/things/camera/picamera.py b/src/openflexure_microscope_server/things/camera/picamera.py index fd3a9083..63f8fa03 100644 --- a/src/openflexure_microscope_server/things/camera/picamera.py +++ b/src/openflexure_microscope_server/things/camera/picamera.py @@ -526,7 +526,7 @@ class StreamingPiCamera2(BaseCamera, ABC): """Ensure in correct mode for capture. If the camera is already in the correct mode, the stream isn't paused and - this is the same as using ``self._streaming_picamera(). + this is the same as using ``self._streaming_picamera()``. Otherwise, pause stream, and switch switch mode. Mode is reset and stream restarts stream after the context manager closes. @@ -579,8 +579,10 @@ class StreamingPiCamera2(BaseCamera, ABC): It's likely to be highly inefficient - raw and/or uncompressed captures using binary image formats will be added in due course. - :param stream_name: (Optional) The PiCamera2 stream to use, should be one of - ["main", "lores", "raw", "full"]. Default = "main" + :param capture_mode: (Optional) The name of the capture mode as defined by the + camera. + :param raw: Whether to capture RAW data. Capturing RAW data may infore some + of the camera mode settings. :raises TimeoutError: if this time is exceeded during capture. """ diff --git a/src/openflexure_microscope_server/things/camera/simulation.py b/src/openflexure_microscope_server/things/camera/simulation.py index b3384367..405ff3fd 100644 --- a/src/openflexure_microscope_server/things/camera/simulation.py +++ b/src/openflexure_microscope_server/things/camera/simulation.py @@ -490,7 +490,10 @@ class SimulatedCamera(BaseCamera): It's likely to be highly inefficient - raw and/or uncompressed captures using binary image formats will be added in due course. - :param stream_name: Currently ignored, this argument exists to ensure consistent API across camera Things. + :param capture_mode: (Optional) The name of the capture mode as defined by the + camera. + :param raw: Raw Capture is not implemented for the simulation microscope. + Setting this to True will result in an error. """ if raw is True: raise NotImplementedError( diff --git a/src/openflexure_microscope_server/things/scan_workflows.py b/src/openflexure_microscope_server/things/scan_workflows.py index d691bdab..f8d1402c 100644 --- a/src/openflexure_microscope_server/things/scan_workflows.py +++ b/src/openflexure_microscope_server/things/scan_workflows.py @@ -171,7 +171,7 @@ class ScanWorkflow(Generic[SettingModelType], lt.Thing): :param dz: The dz for autofocus. :param images_dir: The path to the directory for saving images. - :param capture mode: The name of the camera capture mode. + :param capture_mode: The name of the camera capture mode. :return: A tuple ready to pass out of acquisition routine. In this method, image is always taken, so first return is True.