Updated documentation to LT070 style

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. 

By default, all image and video capture data are stored to instances of :py:class:`openflexure_microscope.captures.CaptureObject`. This class mostly wraps up complexity associated with moving data between disk and memory. 

The class also includes some convenience features such as handling metadata tags and file names, and generating image thumbnails. Additionally, the class handles storing capture metadata to Exif tags in supported formats. 

Below are details of available methods and attributes.

.. automodule:: openflexure_microscope.camera.capture

.. automodule:: openflexure_microscope.captures.capture

    :members:

 No newline at end of file

        """

        Take an image capture and return it without saving

        """

        # Expect a "use_video_port" boolean, which defaults to True if none is given

        @use_args({"use_video_port": fields.Boolean(missing=True)})

        args = {"use_video_port": fields.Boolean(missing=True)}

        # Our success response (200) returns an image (image/jpeg mimetype)

        @doc_response(200, mimetype="image/jpeg")

        responses = {

            200: {"content_type": "image/jpeg"}

        }

        def post(self, args):

            """

            Take a non-persistant image capture.

                # Return our image data using Flasks send_file function

                return send_file(io.BytesIO(stream.read()), mimetype="image/jpeg")

In this example, we are also making use of the ``@doc_response`` decorator, to document that our successful response (HTTP code 200) will return data with a mimetype ``image/jpeg``, as well as ``@use_args`` to accept optional parameters with POST requests.

In this example, we are also making use of the ``responses`` attribute, to document that our successful response (HTTP code 200) will return data with a mimetype ``image/jpeg``, as well as ``args`` to accept optional parameters with POST requests.

Complete example

----------------

from labthings.server.find import find_component

from labthings.server.view import View

from labthings.server.decorators import use_body

from labthings.server import fields

## Extension methods

class ExampleRenameView(View):

    # Expect a request parameter called "name", which is a string. Pass to argument "args".

    @use_body(fields.String(required=True, example="My Example Microscope"))

    def post(self, body):

    # Expect a request parameter called "name", which is a string. 

    # Passed to the argument "args".

    args = fields.String(required=True, example="My Example Microscope")

    def post(self, args):

        # Look for our new name in the request body

        new_name = body

        new_name = args

        # Find our microscope component

        microscope = find_component("org.openflexure.microscope")

from labthings.server.find import find_component

from labthings.server.view import View

from labthings.server.decorators import use_args, marshal_with

from labthings.server.schema import Schema

from labthings.server import fields

## Extension views

class ExampleIdentifyView(View):

    # Format our returned object using MicroscopeIdentifySchema

    @marshal_with(MicroscopeIdentifySchema())

    schema = MicroscopeIdentifySchema()

    def get(self):

        # Find our microscope component

        microscope = find_component("org.openflexure.microscope")

class ExampleRenameView(View):

    # Format our returned object using MicroscopeIdentifySchema

    @marshal_with(MicroscopeIdentifySchema())

    schema = MicroscopeIdentifySchema()

    # Expect a request parameter called "name", which is a string. Pass to argument "args".

    @use_args({"name": fields.String(required=True, example="My Example Microscope")})

    args = {"name": fields.String(required=True, example="My Example Microscope")}

    def post(self, args):

        # Look for our "name" parameter in the request arguments

        new_name = args.get("name")

from labthings.server.find import find_component

from labthings.server.view import View, PropertyView

from labthings.server.decorators import (

    use_args,

    marshal_with,

    ThingProperty,

    PropertySchema,

)

from labthings.server.schema import Schema

from labthings.server import fields

# Since we only have a GET method here, it'll register as a read-only property

class ExampleIdentifyView(PropertyView):

    # Format our returned object using MicroscopeIdentifySchema

    @marshal_with(MicroscopeIdentifySchema())

    schema = MicroscopeIdentifySchema()

    def get(self):

        """

        Show identifying information about the current microscope object

        microscope = find_component("org.openflexure.microscope")

        # Return our microscope object,

        # let @marshal_with handle formatting the output

        # let schema handle formatting the output

        return microscope

# We can use a single schema for all methods if the input and output will be formatted identically

# Eg. Here, we will always expect a "name" string argument, and always return a "name" string attribute

@PropertySchema({"name": fields.String(required=True, example="My Example Microscope")})

# We can use a single schema as the input and output will be formatted identically

# Eg. We always expect a "name" string argument, and always return a "name" string attribute

class ExampleRenameView(PropertyView):

    schema = {"name": fields.String(required=True, example="My Example Microscope")}

    def get(self):

        """

        Show the current microscope name

        rename(microscope, new_name)

        # Return our microscope object,

        # let @marshal_with handle formatting the output

        # let schema handle formatting the output

        return microscope