img.codecs

Interface for codes to decode/encode images from/to different image formats

Source code in python/src/wavelet_buffer/img/codecs.py

class BaseCodec:
    """Interface for codes to decode/encode images from/to different image formats"""

    def decode(self, blob: bytes) -> "np.ndarray[np.float32]":
        """Decode an image from bytes to a numpy image
        Args:
            blob: serialized image e.g. JPEG
        Returns:
            image as numpy array
        """
        raise NotImplemented()

    def encode(self, data: "np.ndarray[np.float32]", start_channel: int = 0) -> bytes:
        """Encode a numpy image to byte string
        Args:
            data: numpy image
            start_channel: start channel for conversion
        Returns:
            serialized image e.g. JPEG
        """
        raise NotImplemented()

    def channel_number(self) -> int:
        """Return number ofr channel RGB=3, Gray=1"""
        raise NotImplemented()

channel_number()

Return number ofr channel RGB=3, Gray=1

Source code in python/src/wavelet_buffer/img/codecs.py

def channel_number(self) -> int:
    """Return number ofr channel RGB=3, Gray=1"""
    raise NotImplemented()

decode(blob)

Decode an image from bytes to a numpy image

Parameters:

Name	Type	Description	Default
blob	bytes	serialized image e.g. JPEG	required

Returns:

Type	Description
np.ndarray[np.float32]	image as numpy array

Source code in python/src/wavelet_buffer/img/codecs.py

def decode(self, blob: bytes) -> "np.ndarray[np.float32]":
    """Decode an image from bytes to a numpy image
    Args:
        blob: serialized image e.g. JPEG
    Returns:
        image as numpy array
    """
    raise NotImplemented()

encode(data, start_channel=0)

Encode a numpy image to byte string

Parameters:

Name	Type	Description	Default
data	np.ndarray[np.float32]	numpy image	required
start_channel	int	start channel for conversion	0

Returns:

Type	Description
bytes	serialized image e.g. JPEG

Source code in python/src/wavelet_buffer/img/codecs.py

def encode(self, data: "np.ndarray[np.float32]", start_channel: int = 0) -> bytes:
    """Encode a numpy image to byte string
    Args:
        data: numpy image
        start_channel: start channel for conversion
    Returns:
        serialized image e.g. JPEG
    """
    raise NotImplemented()

Bases: BaseCodec

Codec for JPEG <-> numpy RGB image conversion

Source code in python/src/wavelet_buffer/img/codecs.py

class RgbJpeg(BaseCodec):
    """Codec for JPEG <-> numpy RGB image conversion"""

    def __init__(self, write_quality: float = 1.0):
        """
        Args:
            write_quality: quality of encoded image. Should be from 0 to 1.0
        """
        self._impl = impl.RgbJpeg(write_quality)

    def decode(self, blob: bytes) -> "np.ndarray[np.float32]":
        return self._impl.decode(blob)

    def encode(self, data: "np.ndarray[np.float32]", start_channel: int = 0) -> bytes:
        return self._impl.encode(data, start_channel)

    def channel_number(self) -> int:
        return self._impl.channel_number()

__init__(write_quality=1.0)

Parameters:

Name	Type	Description	Default
write_quality	float	quality of encoded image. Should be from 0 to 1.0	1.0

Source code in python/src/wavelet_buffer/img/codecs.py

def __init__(self, write_quality: float = 1.0):
    """
    Args:
        write_quality: quality of encoded image. Should be from 0 to 1.0
    """
    self._impl = impl.RgbJpeg(write_quality)

Bases: BaseCodec

Codec for JPEG <-> numpy HSL image conversion

Source code in python/src/wavelet_buffer/img/codecs.py

class HslJpeg(BaseCodec):
    """Codec for JPEG <-> numpy HSL image conversion"""

    def __init__(self, write_quality: float = 1.0):
        """
        Args:
            write_quality: quality of encoded image. Should be from 0 to 1.0
        """
        self._impl = impl.HslJpeg(write_quality)

    def decode(self, blob: bytes) -> "np.ndarray[np.float32]":
        return self._impl.decode(blob)

    def encode(self, data: "np.ndarray[np.float32]", start_channel: int = 0) -> bytes:
        return self._impl.encode(data, start_channel)

    def channel_number(self) -> int:
        return self._impl.channel_number()

__init__(write_quality=1.0)

Parameters:

Name	Type	Description	Default
write_quality	float	quality of encoded image. Should be from 0 to 1.0	1.0

Source code in python/src/wavelet_buffer/img/codecs.py

def __init__(self, write_quality: float = 1.0):
    """
    Args:
        write_quality: quality of encoded image. Should be from 0 to 1.0
    """
    self._impl = impl.HslJpeg(write_quality)

Bases: BaseCodec

Codec for JPEG <-> numpy monochrome image conversion

Source code in python/src/wavelet_buffer/img/codecs.py

class GrayJpeg(BaseCodec):
    """Codec for JPEG  <-> numpy monochrome image conversion"""

    def __init__(self, write_quality: float = 1.0):
        """
        Args:
            write_quality: quality of encoded image. Should be from 0 to 1.0
        """
        self._impl = impl.GrayJpeg(write_quality)

    def decode(self, blob: bytes) -> "np.ndarray[np.float32]":
        return self._impl.decode(blob)

    def encode(self, data: "np.ndarray[np.float32]", start_channel: int = 0) -> bytes:
        return self._impl.encode(data, start_channel)

    def channel_number(self) -> int:
        return self._impl.channel_number()

__init__(write_quality=1.0)

Parameters:

Name	Type	Description	Default
write_quality	float	quality of encoded image. Should be from 0 to 1.0	1.0

Source code in python/src/wavelet_buffer/img/codecs.py

def __init__(self, write_quality: float = 1.0):
    """
    Args:
        write_quality: quality of encoded image. Should be from 0 to 1.0
    """
    self._impl = impl.GrayJpeg(write_quality)