dsdl.geometry.shape

ImageShape

Bases: Shape

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/shape.py

class ImageShape(Shape):
    def __init__(self, value, mode="hw"):
        """A Geometry class which abstracts an image's shape.

        Args:
            value: A list which contains the width and height of the image.
            mode: The shape mode, value should be `"hw"` or `"wh"`. When `mode=="hw"`, the `value` arg should be image's [height, width]
                when `mode=="wh"', the `value` arg should be images's [width, height]

        Attributes:
            _width(int): The width of the image.
            _height(int): The height of the image.
        """
        assert mode.lower() in ("hw", "wh")
        super(ImageShape, self).__init__(value, mode.lower(), "image")
        if mode == "hw":
            self._height, self._width = value[0], value[1]
        else:
            self._width, self._height = value[0], value[1]

    @property
    def height(self):
        """
        Returns:
            The height of the image.
        """
        return self._height

    @property
    def width(self):
        """
        Returns:
            The width of the image.
        """
        return self._width

    def __repr__(self):
        return f"image height: {self.height}; image width: {self.width}"

height property

Returns:

Type	Description
	The height of the image.

width property

Returns:

Type	Description
	The width of the image.

__init__(value, mode='hw')

A Geometry class which abstracts an image's shape.

Parameters:

Name	Type	Description	Default
value		A list which contains the width and height of the image.	required
mode		The shape mode, value should be "hw" or "wh". When mode=="hw", the value arg should be image's [height, width] when mode=="wh"', thevalue` arg should be images's [width, height]	'hw'

Attributes:

Name	Type	Description
_width(int)		The width of the image.
_height(int)		The height of the image.

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/shape.py

def __init__(self, value, mode="hw"):
    """A Geometry class which abstracts an image's shape.

    Args:
        value: A list which contains the width and height of the image.
        mode: The shape mode, value should be `"hw"` or `"wh"`. When `mode=="hw"`, the `value` arg should be image's [height, width]
            when `mode=="wh"', the `value` arg should be images's [width, height]

    Attributes:
        _width(int): The width of the image.
        _height(int): The height of the image.
    """
    assert mode.lower() in ("hw", "wh")
    super(ImageShape, self).__init__(value, mode.lower(), "image")
    if mode == "hw":
        self._height, self._width = value[0], value[1]
    else:
        self._width, self._height = value[0], value[1]

Shape

Bases: BaseGeometry

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/shape.py

class Shape(BaseGeometry):
    def __init__(self, value, mode, media):
        """A Geometry class which abstracts a media's shape.

        Args:
            value: A list which contains the shape information of the media.
            mode: The shape mode, which represents the format of media'shape. For Exsample, an image shape's mode can be "hw" or "wh".
            media: The media type, such as "image", "video" and so on.

        Attributes:
            _value(list[int]): The shape value of the media.
            _media_type(str): The type of the media.
            _mode(str): The mode of the media's shape.
        """
        media = media.lower()
        mode = mode.lower()
        self._media_type = media
        self._value = value
        self._mode = mode

    @property
    def media_type(self):
        """
        Returns:
            The media type of the current Shape object.
        """
        return self._media_type

    @property
    def value(self):
        """
        Returns:
            The shape value.
        """
        return self._value

    @property
    def mode(self):
        """
        Returns:
            The mode of the shape.
        """
        return self._mode

    def __repr__(self):
        return f"{self.media_type} shape: {self.value}"

media_type property

Returns:

Type	Description
	The media type of the current Shape object.

mode property

Returns:

Type	Description
	The mode of the shape.

value property

Returns:

Type	Description
	The shape value.

__init__(value, mode, media)

A Geometry class which abstracts a media's shape.

Parameters:

Name	Type	Description	Default
value		A list which contains the shape information of the media.	required
mode		The shape mode, which represents the format of media'shape. For Exsample, an image shape's mode can be "hw" or "wh".	required
media		The media type, such as "image", "video" and so on.	required

Attributes:

Name	Type	Description
_value(list[int])		The shape value of the media.
_media_type(str)		The type of the media.
_mode(str)		The mode of the media's shape.

Source code in /Users/bin/anaconda3/envs/dsdl/lib/python3.10/site-packages/dsdl/geometry/shape.py

def __init__(self, value, mode, media):
    """A Geometry class which abstracts a media's shape.

    Args:
        value: A list which contains the shape information of the media.
        mode: The shape mode, which represents the format of media'shape. For Exsample, an image shape's mode can be "hw" or "wh".
        media: The media type, such as "image", "video" and so on.

    Attributes:
        _value(list[int]): The shape value of the media.
        _media_type(str): The type of the media.
        _mode(str): The mode of the media's shape.
    """
    media = media.lower()
    mode = mode.lower()
    self._media_type = media
    self._value = value
    self._mode = mode