Skip to content

Utils

cmap_to_array(cmap)

Convert a colormap to an array of colors as RGB.

Parameters:

Name Type Description Default
cmap Colormap | Sequence

A colormap.

 required

Returns:

Type Description
ndarray

An array of colors.
Source code in tastymap/utils.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
def cmap_to_array(
    cmap: Colormap | Sequence,
) -> np.ndarray:
    """
    Convert a colormap to an array of colors as RGB.

    Args:
        cmap: A colormap.

    Returns:
        An array of colors.
    """
    if isinstance(cmap, str):
        cmap = get_cmap(cmap)  # type: ignore

    if isinstance(cmap, LinearSegmentedColormap):
        cmap_array = cmap(np.linspace(0, 1, cmap.N))
    elif isinstance(cmap, ListedColormap):
        cmap_array = np.array(cmap.colors)
    else:
        cmap_array = np.array(cmap)
    return cmap_array

get_cmap(cmap)

Get a colormap by name.

Parameters:

Name Type Description Default
cmap str

The name of the colormap.

 required

Returns:

Type Description
Colormap

A colormap.
Source code in tastymap/utils.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
def get_cmap(cmap: str) -> Colormap:
    """
    Get a colormap by name.

    Args:
        cmap: The name of the colormap.

    Returns:
        A colormap.
    """
    lower_colormaps = get_registered_cmaps()
    try:
        return _get_cmap(lower_colormaps[cmap.lower()])
    except KeyError:
        matches = get_close_matches(cmap, lower_colormaps.values(), n=5, cutoff=0.1)
        if matches:
            raise ValueError(
                f"Unknown colormap '{cmap}'. Did you mean one of these: {matches}?"
            )
        else:
            raise ValueError(f"Unknown colormap '{cmap}'.")

get_registered_cmaps()

Get a mapping of registered colormaps.

Returns:

Type Description
dict[str, str]

A mapping of registered colormaps.
Source code in tastymap/utils.py 
13
14
15
16
17
18
19
20
def get_registered_cmaps() -> dict[str, str]:
    """
    Get a mapping of registered colormaps.

    Returns:
        A mapping of registered colormaps.
    """
    return {cmap.lower(): cmap for cmap in colormaps()}

replace_match(pattern, string, key)

Find a pattern in a string and remove it.

Parameters:

Name Type Description Default
pattern str

The pattern to find.

 required
string str

The string to search.

 required
key str

The name of the pattern.

 required

Returns:

Type Description
tuple[str, str]

The new string and the match.
Source code in tastymap/utils.py 
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def replace_match(pattern: str, string: str, key: str) -> tuple[str, str]:
    """
    Find a pattern in a string and remove it.

    Args:
        pattern: The pattern to find.
        string: The string to search.
        key: The name of the pattern.

    Returns:
        The new string and the match.
    """
    matches = findall(pattern, string, IGNORECASE)
    if len(matches) > 1:
        raise ValueError(f"Should only contain one {key!r} but found {matches}")
    elif len(matches) == 1:
        string = sub(pattern, "", string, count=1, flags=IGNORECASE)
    return string, matches[0] if matches else ""

subset_cmap(cmap, indices, name=None)

Subset a colormap.

Parameters:

Name Type Description Default
cmap Colormap

A colormap.

 required
indices int | float | slice | Sequence

The indices to subset.

 required
name str | None

The name of the new colormap.

 None

Returns:

Type Description
LinearSegmentedColormap

A new colormap.
Source code in tastymap/utils.py 
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
79
80
81
82
83
84
85
86
87
88
89
def subset_cmap(
    cmap: Colormap,
    indices: int | float | slice | Sequence,
    name: str | None = None,
) -> LinearSegmentedColormap:
    """
    Subset a colormap.

    Args:
        cmap: A colormap.
        indices: The indices to subset.
        name: The name of the new colormap.

    Returns:
        A new colormap.
    """
    cmap_array = cmap_to_array(cmap)
    name = name or cmap.name
    if isinstance(indices, (int, float)):
        cmap_indices = np.array([indices] * 2).astype(int)
        name += f"_i{indices}"
    elif isinstance(indices, Sequence):
        cmap_indices = np.array(indices)
        if len(cmap_indices) == 1:
            cmap_indices = np.array([cmap_indices] * 2).astype(int)
        name += f"_i{','.join(str(i) for i in cmap_indices.flat)}"
    elif isinstance(indices, slice):
        cmap_indices = indices  # type: ignore
        step = indices.step
        start = indices.start
        stop = indices.stop
        if not indices.start and not indices.stop:
            if step == -1:
                name, r_match = replace_match(r"_r+(?=_|$)", name, "_r")
                if not r_match:
                    name += "_r"
            else:
                name += f"_i::{step}"
        else:
            name += f"_i{start}:{stop}:{step}"

    cmap_array = cmap_array[cmap_indices]
    cmap = LinearSegmentedColormap.from_list(name, cmap_array, N=len(cmap_array))
    return cmap