locan.visualize.colormap

Provide colormaps for visualization.

This module provides convenience functions for using colormap definitions from various visualization packages.

Default colormaps in locan are set through the locan.configuration.COLORMAP_DEFAULTS mapping.

Named colormaps are registered through the locan.visualization.colormap.colormap_registry mapping.

In locan locan.Colormap serves as adapter class to provide an interface for various visualization functions. Instances of locan.Colormap can be requested through the locan.visualization.colormap.get_colormap() function and contain references to matplotlib and napari colormap instances.

Examples

>>> colormap = locan.get_colormap("viridis")
>>> assert isinstance(colormap.matplotlib, mcolors.Colormap)
>>> colormap.name
viridis

>>> colormap = locan.Colormap.from_matplotlib(colormap="viridis")
>>> assert isinstance(colormap.matplotlib, mcolors.Colormap)
>>> colormap.name
viridis

Variables

colormap_registry

A mapping of names onto Colormap instances.

Classes

Colormap(colormap)	Container class for colormaps.
Colormaps(value[, names, module, qualname, ...])	Preferred colormap types to be used for visualization.

Functions

get_colormap(colormap)

Get a locan.Colormap instance from colormap searching string identifier through colormap_registry, matplotlib colormaps, napari_colormaps.