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

Improed CaptureObject documentation

Browse source
This commit is contained in:
Joel Collins 2019-02-06 15:18:02 +00:00
parent 9253f1badf
commit 1436e58283
2 changed files with 94 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/source/capture.rst
View file

@ -1,5 +1,7 @@
Stream Object
Capture Object
=======================================================
By default, all image and video capture data are stored to instances of :py:class:`openflexure_microscope.camera.capture.CaptureObject`. This class mostly wraps up complexity associated with moving data between disk and memory. The class also includes some convenience features such as automatically cleaning up captures marked as temporary, handling metadata files and file names, and generating image thumbnails. Often, the most recent capture wants to be store din memory, for applications that involve immediately processing the capture data in some way. Rather than manually keep track of the location of the capture data, you can use the CaptureObject ``data`` attribute, which automatically returns capture data from the fastest available location. Below are details of available methods and attributes.
.. automodule:: openflexure_microscope.camera.capture
:members: