matplotlib.colorbar#

颜色条是从标量值到颜色的映射的可视化。在 Matplotlib 中,它们被绘制到一个专用的Axes.

笔记

颜色条通常是通过Figure.colorbar或其 pyplot 包装器创建的pyplot.colorbar,它在内部Colorbarmake_axes_gridspec(for -positioned GridSpecaxes) 或make_axes(for non - GridSpecpositioned axes) 一起使用。

最终用户很可能不需要直接使用此模块的 API。

matplotlib.colorbar。颜色栏ax , mappable=None , * , cmap=None , norm=None , alpha=None , values=None , bounds= None , orientation='vertical' , ticklocation='auto' , extend=None , spacing='uniform ' , ticks=None , format=None , drawedges=False , filled=<deprecated parameter> , extendfrac=None , extendrect=False , label='') [来源] #

基地:object

在现有坐标区中绘制颜色条。

通常,颜色条是使用Figure.colorbaror 创建的,pyplot.colorbar并与ScalarMappables 相关联(例如 AxesImage生成的 via imshow)。

为了绘制与图中其他元素不相关的颜色条,例如,当单独显示颜色图时,可以创建一个空的 ScalarMappable,或者直接传递cmapnorm而不是mappableColorbar

有用的公共方法是set_label()add_lines()

参数
斧头Axes

Axes绘制颜色条的实例。

可映射的ScalarMappable

将使用其颜色图和规范的可映射对象。

为了显示价值过低和过高的颜色,可映射的规范应指定为

norm = colors.Normalize(clip=False)

要显示颜色与索引而不是 0-1 比例,请使用:

norm=colors.NoNorm()
cmap Colormap,默认值:(rcParams["image.cmap"]默认值'viridis':)

要使用的颜色图。此参数被忽略,除非可映射为无。

规范Normalize

要使用的规范化。此参数被忽略,除非可映射 为无。

阿尔法浮动

介于 0(透明)和 1(不透明)之间的颜色条透明度。

方向{'垂直','水平'}
ticklocation {'auto', 'left', 'right', 'top', 'bottom'}
拉边布尔
填充布尔
扩展{'两者都','两者','min','max'}

为超出范围的值设置尖端(除非“两者都不”)。这些是使用颜色图 set_under 和 set_over 方法为给定颜色图设置的。

extendfrac {,'自动',长度,长度}

如果设置为None,最小和最大三角形颜色条扩展的长度都是内部颜色条长度的 5%(这是默认设置)。

如果设置为“自动”,则使三角形颜色条扩展的长度与内部框的长度相同(当间距设置为“统一”时)或与相应的相邻内部框的长度相同(当间距设置为“成比例”时)。

如果是标量,则将最小和最大三角形颜色条扩展的长度表示为内部颜色条长度的一部分。也可以给出分数的二元素序列,分别指示最小和最大颜色条扩展的长度作为内部颜色条长度的一部分。

扩展矩形布尔

如果False最小和最大颜色条扩展将是三角形的(默认)。如果为True,则扩展将是矩形的。

间距{'均匀','比例'}

对于离散的颜色条(BoundaryNorm或轮廓),'uniform' 为每种颜色提供相同的空间;'proportional' 使空间与数据间隔成比例。

刻度无或刻度或定位器列表

如果为 None,则从输入中自动确定刻度。

格式None 或 str 或 Formatter

如果没有,ScalarFormatter则使用。支持格式字符串,例如,"%4.2e""{x:.2e}",。Formatter可以给出替代方案。

拉边布尔

是否在颜色边界处画线。

标签str

颜色条长轴上的标签。

边界、值无或序列

如果未设置,颜色图将以 0-1 的比例显示。如果是序列,的长度必须小于边界1 。对于由边界中的相邻条目分隔的每个区域,将使用映射到 values 中相应值的颜色。通常仅对索引颜色(即norm=NoNorm())或其他异常情况有用。

属性
斧头Axes

Axes绘制颜色条的实例。

列表

一个列表LineCollection(如果没有画线,则为空)。

分隔线LineCollection

一个 LineCollection(如果drawedges是则为空False)。

add_lines ( * args , ** kwargs ) [来源] #

在颜色条上画线。

这些行被附加到列表中lines

参数
级别数组

行的位置。

颜色颜色或颜色列表

适用于所有线条的单一颜色或适用于每条线条的一个颜色值。

线宽浮动或类似数组

适用于所有行的单个线宽或适用于每行的一个线宽。

擦除布尔值,默认值:True

是否删除任何以前添加的行。

笔记

或者,也可以使用签名调用此方法 ,在这种情况下 , levelscolorslinewidths取自contour_setcolorbar.add_lines(contour_set, erase=True)

drag_pan ( button , key , x , y ) [source] #
draw_all ( ) [来源] #

[弃用] 根据当前 cmap 和 norm 计算任何自由参数,并进行所有绘图。

笔记

3.6 版后已弃用:改用 fig.draw_without_rendering()。

属性 填充[来源] #
属性 格式化程序#

颜色条的主要刻度标签Formatter

get_ticks ( minor = False ) [来源] #

将刻度作为位置列表返回。

参数
次要布尔值,默认值:False

如果 True 返回次要刻度。

属性 定位器#

颜色条的主要刻度Locator

属性 次要格式化程序#

颜色条的小勾号Formatter

属性 小定位器#

颜色条的小勾号Locator

minorticks_off ( ) [来源] #

关闭颜色条的小刻度。

Minorticks_on ( ) [来源] #

打开彩条小刻度。

n_rasterize = 50 #
属性 补丁[来源] #
删除( ) [来源] #

从图中删除此颜色条。

如果颜色条是使用use_gridspec=True以前的 gridspec 创建的,则会恢复。

set_alpha ( alpha ) [来源] #

将透明度设置在 0(透明)和 1(不透明)之间。

如果提供了数组,则alpha将设置为 None 以使用与颜色图关联的透明度值。

set_label ( label , * , loc = None , ** kwargs ) [source] #

向颜色条的长轴添加标签。

参数
标签str

标签文本。

loc str,可选

标签的位置。

  • 对于 {'left', 'center', 'right'} 之一的水平方向

  • 对于 {'bottom', 'center', 'top'} 之一的垂直方向

默认为rcParams["xaxis.labellocation"](default: 'center') 或rcParams["yaxis.labellocation"](default: 'center') 取决于方向。

**kwargs

关键字参数被传递给set_xlabel/ set_ylabel。支持的关键字是标签板Text属性。

set_ticklabels ( ticklabels , update_ticks=<deprecated parameter> , * , minor=False , **kwargs ) [source] #

[劝阻]设置刻度标签。

灰心

不鼓励使用此方法,因为它依赖于刻度位置。在大多数情况下,您会想要使用它 。set_ticks(positions, labels=labels)

如果您使用此方法,则应始终在之前固定刻度位置,例如通过使用或在颜色条的长轴上Colorbar.set_ticks显式设置 a 。FixedLocator否则,刻度可以自由移动,标签可能会出现在意想不到的位置。

参数
刻度标签序列的 str 或Text

Colorbar.set_ticks用于标记由;设置的序列中每个刻度位置的文本 标签的数量必须与位置的数量相匹配。

update_ticks布尔值,默认值:True

此关键字参数将被忽略并将被删除。已弃用

布尔

如果为 True,则设置次要刻度而不是主要刻度。

**kwargs

Text标签的属性。

set_ticks ( ticks , update_ticks=<deprecated parameter> , labels=None , * , minor=False , **kwargs ) [source] #

设置刻度位置。

参数
刻度线列表

刻度位置列表。

str的标签列表,可选

刻度标签列表。如果未设置,标​​签将显示数据值。

次要布尔值,默认值:False

如果False,设置主要刻度;如果True, 次要刻度。

**kwargs

Text标签的属性。这些只有在您传递标签时才会生效。在其他情况下,请使用tick_params.

update_normal (可映射) [来源] #

更新实体补丁、线条等。

这意味着当此颜色条所属的图像或等高线图的范数发生变化时调用。

如果可映射对象上的规范与以前不同,这将重置轴的定位器和格式化程序,因此如果这些已被定制,则需要再次定制它们。但是,如果规范仅更改vminvmaxcmap的值,则将保留旧的格式化程序和定位器。

update_ticks ( ) [来源] #

设置刻度和刻度标签。用户不应需要此功能。

matplotlib.colorbar。ColorbarBase [来源] #

的别名Colorbar

matplotlib.colorbar。make_axes ( parents , location = None , orientation = None , fraction = 0.15 , shrink = 1.0 , aspect = 20 , ** kwargs ) [来源] #

创建一个Axes适合的颜色条。

通过调整大小和重新定位parents将轴放置在父轴的图形

参数
父母Axes或名单Axes

用作放置颜色条的父级的轴。

位置无或 {'left', 'right', 'top', 'bottom'}

创建颜色条轴的位置,相对于父轴。它还决定了颜色条的方向(左右颜色条是垂直的,顶部和底部的颜色条是水平的)。如果没有,如果设置了位置,则位置将来自 方向(右侧的垂直颜色条,底部的水平颜色条),如果未设置方向,则默认为“右”。

方向无或 {'vertical', 'horizo​​ntal'}

颜色条的方向。最好设置颜色条的位置 ,因为这也决定了方向;传递不兼容的位置方向值会引发异常。

分数浮点数,默认值:0.15

用于颜色条的原始轴的分数。

收缩浮动,默认:1.0

与颜色条大小相乘的分数。

方面浮动,默认:20

长尺寸与短尺寸的比率。

pad float,默认值:0.05如果垂直,0.15如果水平

颜色条和新图像轴之间的原始轴的分数。

(浮动,浮动),可选

颜色条轴的锚点。如果垂直,则默认为 (0.0, 0.5);(0.5, 1.0) 如果水平。

panchor (float, float), 或False , 可选

颜色栏父轴的锚点。如果为False,则父坐标区的锚点将保持不变。如果垂直,则默认为 (1.0, 0.5);(0.5, 0.0) 如果水平。

返回
卡克斯Axes

子轴。

kwargs字典

创建颜色条实例时要传递的精简关键字字典。

matplotlib.colorbar。make_axes_gridspec ( parent , * , location = None , orientation = None , fraction = 0.15 , shrink = 1.0 , aspect = 20 , ** kwargs ) [source] #

创建一个SubplotBase适合的颜色条。

通过调整大小和重新定位parent ,将轴放置在轴的图形中。

这个功能类似于make_axes。主要区别是

虽然此功能旨在与 兼容make_axes,但可能存在一些细微差别。

参数
父母Axes

用作放置颜色条的父级的轴。

位置无或 {'left', 'right', 'top', 'bottom'}

创建颜色条轴的位置,相对于父轴。它还决定了颜色条的方向(左右颜色条是垂直的,顶部和底部的颜色条是水平的)。如果没有,如果设置了位置,则位置将来自 方向(右侧的垂直颜色条,底部的水平颜色条),如果未设置方向,则默认为“右”。

方向无或 {'vertical', 'horizo​​ntal'}

颜色条的方向。最好设置颜色条的位置 ,因为这也决定了方向;传递不兼容的位置方向值会引发异常。

分数浮点数,默认值:0.15

用于颜色条的原始轴的分数。

收缩浮动,默认:1.0

与颜色条大小相乘的分数。

方面浮动,默认:20

长尺寸与短尺寸的比率。

pad float,默认值:0.05如果垂直,0.15如果水平

颜色条和新图像轴之间的原始轴的分数。

(浮动,浮动),可选

颜色条轴的锚点。如果垂直,则默认为 (0.0, 0.5);(0.5, 1.0) 如果水平。

panchor (float, float), 或False , 可选

颜色栏父轴的锚点。如果为False,则父坐标区的锚点将保持不变。如果垂直,则默认为 (1.0, 0.5);(0.5, 0.0) 如果水平。

返回
卡克斯SubplotBase

子轴。

kwargs字典

创建颜色条实例时要传递的精简关键字字典。