Core

cook_tmap(colors_or_cmap, num_colors=None, reverse=False, name=None, hue=None, saturation=None, value=None, bad=None, under=None, over=None, from_color_model=None)

Cook a completely new colormap or modify an existing one.

Parameters:

Name	Type	Description	Default
colors_or_cmap	Sequence | str | Colormap	A list of colors or a colormap instance or string.	required
num_colors	int | None	Number of colors in the colormap. Defaults to None.	None
reverse	bool	Whether to reverse the colormap. Defaults to False.	False
name	str | None	Name of the colormap; if provided, registers the cmap. Defaults to None.	None
hue	float | None	Hue factor (-255 to 255) to tweak by.	None
saturation	float | None	Saturation factor (-10 to 10) to tweak by.	None
value	float | None	Brightness value factor (0, 3) to tweak by.	None
bad	str | None	Color for bad values. Defaults to None.	None
under	str | None	Color for underflow values. Defaults to None.	None
over	str | None	Color for overflow values. Defaults to None.	None
from_color_model	ColorModel | str | None	Color model of the input colormap; required if colors_or_cmap is an Sequence and not hexcodes. Defaults to None.	None

Returns:

Name	Type	Description
TastyMap	TastyMap	A new TastyMap instance with the new colormap.

Source code in tastymap/core.py

def cook_tmap(
    colors_or_cmap: Sequence | str | Colormap,
    num_colors: int | None = None,
    reverse: bool = False,
    name: str | None = None,
    hue: float | None = None,
    saturation: float | None = None,
    value: float | None = None,
    bad: str | None = None,
    under: str | None = None,
    over: str | None = None,
    from_color_model: ColorModel | str | None = None,
) -> TastyMap:
    """Cook a completely new colormap or modify an existing one.

    Args:
        colors_or_cmap: A list of colors or a colormap instance or string.
        num_colors: Number of colors in the colormap. Defaults to None.
        reverse: Whether to reverse the colormap. Defaults to False.
        name: Name of the colormap; if provided, registers the cmap. Defaults to None.
        hue: Hue factor (-255 to 255) to tweak by.
        saturation: Saturation factor (-10 to 10) to tweak by.
        value: Brightness value factor (0, 3) to tweak by.
        bad: Color for bad values. Defaults to None.
        under: Color for underflow values. Defaults to None.
        over: Color for overflow values. Defaults to None.
        from_color_model: Color model of the input colormap; required if
            colors_or_cmap is an Sequence and not hexcodes. Defaults to None.

    Returns:
        TastyMap: A new TastyMap instance with the new colormap.
    """
    if isinstance(colors_or_cmap, str):
        tmap = TastyMap.from_str(colors_or_cmap)
    elif isinstance(colors_or_cmap, LinearSegmentedColormap):
        tmap = TastyMap(colors_or_cmap)
    elif isinstance(colors_or_cmap, ListedColormap):
        tmap = TastyMap.from_listed_colormap(colors_or_cmap)
    elif isinstance(colors_or_cmap, (Sequence, np.ndarray)):
        if not isinstance(colors_or_cmap[0], str) and from_color_model is None:
            raise ValueError(
                "Please specify from_color_model to differentiate "
                "between RGB and HSV color models."
            )
        if len(colors_or_cmap) == 1:
            colors_or_cmap = list(colors_or_cmap) * 2
        tmap = TastyMap.from_list(
            colors_or_cmap, color_model=from_color_model or ColorModel.RGB
        )
    else:
        raise TypeError(
            f"Expected str, LinearSegmentedColormap, ListedColormap, or Sequence; "
            f"received {type(colors_or_cmap)!r}."
        )

    if bad or under or over:
        tmap = tmap.set_extremes(bad=bad, under=under, over=over)

    if hue or saturation or value:
        tmap = tmap.tweak_hsv(hue=hue, saturation=saturation, value=value)

    if num_colors:
        tmap = tmap.resize(num_colors)

    if reverse:
        tmap = tmap.reverse()

    if name:
        tmap.cmap.name = name
        tmap.register()

    return tmap

pair_tbar(plot, colors_or_cmap_or_tmap, bounds, labels=None, uniform_spacing=True, **tbar_kwargs)

Create a custom colorbar for a plot.

Parameters:

Name	Type	Description	Default
plot	Any	A matplotlib or HoloViews plot.	required
colors_or_cmap_or_tmap	Sequence | str | Colormap | TastyMap	A list of colors or a colormap instance or string.	required
bounds	slice | Sequence[float]	Bounds of the colorbar.	required
labels	list[str] | None	Labels for the colorbar.	None
uniform_spacing	bool	Whether to space the colors uniformly.	True
tbar_kwargs	dict[str, Any]	Keyword arguments for the colorbar.	{}

Returns:

Type	Description
	The plot.

Source code in tastymap/core.py

def pair_tbar(
    plot: Any,
    colors_or_cmap_or_tmap: (Sequence | str | Colormap | TastyMap),
    bounds: slice | Sequence[float],
    labels: list[str] | None = None,
    uniform_spacing: bool = True,
    **tbar_kwargs: dict[str, Any],
):
    """Create a custom colorbar for a plot.

    Args:
        plot: A matplotlib or HoloViews plot.
        colors_or_cmap_or_tmap: A list of colors or a colormap instance or string.
        bounds: Bounds of the colorbar.
        labels: Labels for the colorbar.
        uniform_spacing: Whether to space the colors uniformly.
        tbar_kwargs: Keyword arguments for the colorbar.

    Returns:
        The plot.
    """
    tmap = colors_or_cmap_or_tmap
    if not isinstance(tmap, TastyMap):
        tmap = cook_tmap(colors_or_cmap_or_tmap)  # type: ignore

    if hasattr(plot, "axes"):
        tbar = MatplotlibTastyBar(
            tmap,
            bounds=bounds,
            labels=labels,
            uniform_spacing=uniform_spacing,
            **tbar_kwargs,  # type: ignore
        )
    elif hasattr(plot, "opts"):
        tbar = HoloViewsTastyBar(  # type: ignore
            tmap,
            bounds=bounds,
            labels=labels,
            uniform_spacing=uniform_spacing,
            **tbar_kwargs,  # type: ignore
        )
    else:
        raise NotImplementedError
    return tbar.add_to(plot)