graphinglib.Heatmap.from_function

classmethod Heatmap.from_function(func: Callable[[TypeAliasForwardRef('ArrayLike'), TypeAliasForwardRef('ArrayLike')], TypeAliasForwardRef('ArrayLike')], x_axis_range: tuple[float, float], y_axis_range: tuple[float, float], color_map: str | Colormap | Inherit = Inherit, color_map_range: tuple[float, float] | None = None, show_color_bar: bool = True, alpha: float = 1.0, aspect_ratio: str | float | Inherit = Inherit, origin_position: str | Inherit = Inherit, interpolation: str = 'none', number_of_points: tuple[int, int] = (50, 50), norm: str | Normalize | None = None) → Self

Creates a heatmap from a function.

Parameters:

funcCallable[[ArrayLike, ArrayLike], ArrayLike]

Function to be plotted. Works with regular functions and lambda functions.

x_axis_range, y_axis_rangetuple[float, float], optional

The range of x and y values used for the axes as tuples containing the start and end of the range.

color_mapstr, Colormap

The color map to use for the Heatmap. Can either be specified as a string (named colormap from Matplotlib) or a Colormap object. Examples include "viridis", "plasma", and "coolwarm". Default depends on the figure_style configuration.

color_map_range: tuple[float, float], optional

The data range covered by the color map, given as (minimum, maximum).

show_color_barbool

Whether or not to display the color bar next to the plot. Defaults to True.

alphafloat

Opacity value of the Heatmap. Range is 0 (transparent) to 1 (opaque). Defaults to 1.0.

aspect_ratiostr or float

Aspect ratio of the axes. Values include "auto", "equal", or a positive float. Default depends on the figure_style configuration.

origin_positionstr

Position of the origin of the axes (upper left or lower left corner). Values are "upper" and "lower". Default depends on the figure_style configuration.

interpolationstr

Interpolation method to be applied to the image. Values include "none", "nearest", "bilinear", "bicubic", "spline16", "spline36", "hanning", "hamming", "hermite", "kaiser", "quadric", "catrom", "gaussian", "bessel", "mitchell", "sinc", and "lanczos". Defaults to "none".

See also

For other interpolation methods, refer to Interpolations for imshow.

number_of_pointstuple[int, int]

Number of points in the x and y coordinates. Defaults to (50, 50).

normstr or Normalize, optional

Normalization of the colormap. Default is None.

Returns:

A Heatmap object created from a function.