graphinglib.Heatmap.from_function#

classmethod Heatmap.from_function(func: Callable[[ArrayLike, ArrayLike], ArrayLike], x_axis_range: tuple[float, float], y_axis_range: tuple[float, float], color_map: str | Colormap = 'default', show_color_bar: bool = True, alpha_value: float = 1.0, aspect_ratio: str | float = 'default', origin_position: str = 'default', interpolation: str = 'none', number_of_points: tuple[int, int] = (50, 50)) Self[source]#

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. Default depends on the figure_style configuration.

show_color_barbool

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

alpha_valuefloat

Opacity value of the Heatmap. Defaults to 1.0.

aspect_ratiostr or float

Aspect ratio of the axes. Default depends on the figure_style configuration.

origin_positionstr

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

interpolationstr

Interpolation method to be applied to the image. 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).

Returns:
A Heatmap object created from a function.