Skip to content

Color

This page contains classes defined in hakowan.common.color module.

ColorLike: TypeAlias = float | int | str | tuple | list module-attribute

Color-like type alias is types that can be converted to a color.

Color

A minimal representation of color.

Source code in hakowan/common/color.py 
 8
 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
73
74
75
76
77
78
class Color:
    """A minimal representation of color."""

    @classmethod
    def from_hex(cls, hex_color):
        """Construct color from hex."""
        c = hex_color.lstrip("#")
        assert len(c) == 6
        return Color(
            int(c[0:2], 16) / 255.0,
            int(c[2:4], 16) / 255.0,
            int(c[4:6], 16) / 255.0,
        )

    def __init__(self, red=0.0, green=0.0, blue=0.0):
        """Construct color from RGB."""
        self.color = np.array([red, green, blue])

    def __getitem__(self, i):
        """Get color channel."""
        return self.color[i]

    def __add__(self, other):
        """Add two colors."""
        c = self.color + other.color
        return Color(*c)

    def __mul__(self, scale):
        """Multiply color by a scalar."""
        c = self.color * scale
        return Color(*c)

    def __rmul__(self, scale):
        """Multiply color by a scalar."""
        return self.__mul__(scale)

    def __eq__(self, other):
        """Check if two colors are equal."""
        return np.all(self.color == other.color)

    def __ne__(self, other):
        """Check if two colors are not equal."""
        return not self == other

    def __iter__(self):
        """Iterate over color channels."""
        return self.color.__iter__()

    def __repr__(self):
        """String representation of color."""
        return f"Color ({self.red}, {self.green}, {self.blue})"

    @property
    def red(self):
        """Red channel."""
        return self.color[0]

    @property
    def green(self):
        """Green channel"""
        return self.color[1]

    @property
    def blue(self):
        """Blue channel"""
        return self.color[2]

    @property
    def data(self):
        """Raw data"""
        return self.color

red property

Red channel.

green property

Green channel

blue property

Blue channel

data property

Raw data

from_hex(hex_color) classmethod

Construct color from hex.

Source code in hakowan/common/color.py 
11
12
13
14
15
16
17
18
19
20
@classmethod
def from_hex(cls, hex_color):
    """Construct color from hex."""
    c = hex_color.lstrip("#")
    assert len(c) == 6
    return Color(
        int(c[0:2], 16) / 255.0,
        int(c[2:4], 16) / 255.0,
        int(c[4:6], 16) / 255.0,
    )

__init__(red=0.0, green=0.0, blue=0.0)

Construct color from RGB.

Source code in hakowan/common/color.py 
22
23
24
def __init__(self, red=0.0, green=0.0, blue=0.0):
    """Construct color from RGB."""
    self.color = np.array([red, green, blue])

__getitem__(i)

Get color channel.

Source code in hakowan/common/color.py 
26
27
28
def __getitem__(self, i):
    """Get color channel."""
    return self.color[i]

__add__(other)

Add two colors.

Source code in hakowan/common/color.py 
30
31
32
33
def __add__(self, other):
    """Add two colors."""
    c = self.color + other.color
    return Color(*c)

__mul__(scale)

Multiply color by a scalar.

Source code in hakowan/common/color.py 
35
36
37
38
def __mul__(self, scale):
    """Multiply color by a scalar."""
    c = self.color * scale
    return Color(*c)

__rmul__(scale)

Multiply color by a scalar.

Source code in hakowan/common/color.py 
40
41
42
def __rmul__(self, scale):
    """Multiply color by a scalar."""
    return self.__mul__(scale)

__eq__(other)

Check if two colors are equal.

Source code in hakowan/common/color.py 
44
45
46
def __eq__(self, other):
    """Check if two colors are equal."""
    return np.all(self.color == other.color)

__ne__(other)

Check if two colors are not equal.

Source code in hakowan/common/color.py 
48
49
50
def __ne__(self, other):
    """Check if two colors are not equal."""
    return not self == other

__iter__()

Iterate over color channels.

Source code in hakowan/common/color.py 
52
53
54
def __iter__(self):
    """Iterate over color channels."""
    return self.color.__iter__()

__repr__()

String representation of color.

Source code in hakowan/common/color.py 
56
57
58
def __repr__(self):
    """String representation of color."""
    return f"Color ({self.red}, {self.green}, {self.blue})"