Source code for pyobs.interfaces.IImageFormat

from abc import ABCMeta, abstractmethod
from typing import List, Any

from .interface import Interface
from pyobs.utils.enums import ImageFormat


class IImageFormat(Interface, metaclass=ABCMeta):
    """The module supports different image formats (e.g. INT16, FLOAT32), mainly used by cameras."""

    __module__ = "pyobs.interfaces"

[docs] @abstractmethod async def set_image_format(self, fmt: ImageFormat, **kwargs: Any) -> None: """Set the camera image format. Args: fmt: New image format. Raises: ValueError: If format could not be set. """ ...
[docs] @abstractmethod async def get_image_format(self, **kwargs: Any) -> ImageFormat: """Returns the camera image format. Returns: Current image format. """ ...
[docs] @abstractmethod async def list_image_formats(self, **kwargs: Any) -> List[str]: """List available image formats. Returns: List of available image formats. """ ...
__all__ = ["IImageFormat"]