GdtCmap

class gdt.core.plot.plot.GdtCmap(name, alpha_min=0.0, alpha_max=1.0, alpha_scale='linear', callback=None)[source]

Bases: object

A specialized colormap class that implements an alpha gradient. A callback function can also be defined so that when any of the parameters are changed, the callback will be executed.

Parameters:

  • name (str) – Any standard Matplotlib colormap name

  • alpha_min (float, optional) – The minimum of the alpha gradient, between (0, 1) inclusive. Default is 0.0.

  • alpha_max (float, optional) – The maximum of the alpha gradient, between (0, 1) inclusive. Default is 1.0.

  • alpha_scale (str, optional) – Set to ‘linear’ for a linear gradient, or to ‘log’ for a logarithmic gradient. Default is ‘linear’

  • callback (function, optional) – The callback function to execute when a parameter is changed.

Attributes Summary

alpha_max

The maximum of the alpha gradient

alpha_min

The minimum of the alpha gradient

alpha_scale

linear or log

cmap

The custom Matplotlib colormap

name

The name of the base colormap

Methods Summary

set_callback(callback)

Set the callback function

Attributes Documentation

alpha_max

The maximum of the alpha gradient

Type:

(float)

alpha_min

The minimum of the alpha gradient

Type:

(float)

alpha_scale

linear or log

Type:

(str)

Type:

The scale of the alpha gradient

cmap

The custom Matplotlib colormap

Type:

(LinearSegmentedColormap)

name

The name of the base colormap

Type:

(str)

Methods Documentation

set_callback(callback)[source]

Set the callback function

Parameters:

callback (function) – The callback function