Skip to content

dsdl.geometry.media

Image

Bases: BaseGeometry

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/media.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class Image(BaseGeometry):

    def __init__(self, value, file_reader):
        """A Geometry class which abstracts an image object.

        Args:
            value: The relative path of the current image object.
            file_reader: The file reader object of the current image object.
        """
        self._loc = value
        self._reader = file_reader
        self.namespace = None
        _splits = value.split(".")
        if len(_splits) > 1:
            self._ext = value.split(".")[-1].lower()
        else:
            self._ext = ""

    def set_namespace(self, struct_obj):
        self.namespace = struct_obj
        self._reader = struct_obj.file_reader

    @property
    def location(self):
        """
        Returns:
            The relative path of the current image.
        """
        return self._loc

    def to_bytes(self):
        """Turn ImageMedia object to bytes.

        Returns:
            The bytes of the current image.
        """
        return io.BytesIO(self._reader.read(self._loc))

    def to_image(self):
        """Turn ImageMedia object to a `PIL.Image` object.

        Returns:
            The `PIL.Image` object of the current image.
        """
        if self._ext in ("tif", "tiff"):
            return Image_.fromarray(self.to_array())
        try:
            img = Image_.open(self.to_bytes())
        except Exception as e:
            raise FileReadError(f"Failed to convert bytes to an array. {e}") from None
        return img

    def to_array(self):
        """Turn ImageMedia object to numpy.ndarray.

        Returns:
            The `np.ndarray` object of the current image.
        """
        if self._ext in ("tif", "tiff"):
            return imread(self.to_bytes())
        return bytes_to_numpy(self.to_bytes())

    def __repr__(self):
        return f"path:{self.location}"

location property

Returns:

Type Description

The relative path of the current image.

__init__(value, file_reader)

A Geometry class which abstracts an image object.

Parameters:

Name Type Description Default
value

The relative path of the current image object.

 required
file_reader

The file reader object of the current image object.

 required
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/media.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def __init__(self, value, file_reader):
    """A Geometry class which abstracts an image object.

    Args:
        value: The relative path of the current image object.
        file_reader: The file reader object of the current image object.
    """
    self._loc = value
    self._reader = file_reader
    self.namespace = None
    _splits = value.split(".")
    if len(_splits) > 1:
        self._ext = value.split(".")[-1].lower()
    else:
        self._ext = ""

to_array()

Turn ImageMedia object to numpy.ndarray.

Returns:

Type Description

The np.ndarray object of the current image.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/media.py 
61
62
63
64
65
66
67
68
69
def to_array(self):
    """Turn ImageMedia object to numpy.ndarray.

    Returns:
        The `np.ndarray` object of the current image.
    """
    if self._ext in ("tif", "tiff"):
        return imread(self.to_bytes())
    return bytes_to_numpy(self.to_bytes())

to_bytes()

Turn ImageMedia object to bytes.

Returns:

Type Description

The bytes of the current image.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/media.py 
39
40
41
42
43
44
45
def to_bytes(self):
    """Turn ImageMedia object to bytes.

    Returns:
        The bytes of the current image.
    """
    return io.BytesIO(self._reader.read(self._loc))

to_image()

Turn ImageMedia object to a PIL.Image object.

Returns:

Type Description

The PIL.Image object of the current image.
Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/media.py 
47
48
49
50
51
52
53
54
55
56
57
58
59
def to_image(self):
    """Turn ImageMedia object to a `PIL.Image` object.

    Returns:
        The `PIL.Image` object of the current image.
    """
    if self._ext in ("tif", "tiff"):
        return Image_.fromarray(self.to_array())
    try:
        img = Image_.open(self.to_bytes())
    except Exception as e:
        raise FileReadError(f"Failed to convert bytes to an array. {e}") from None
    return img