[matplotlib] colorbarのlabelの扱い方。

ここでは、matplotlib colorbarのlabelのいろいろな操作方法について紹介します。

matplotlibのバージョンは3.3.3 です。colorbar()ドキュメント日本語訳や、他のFAQもあわせて参考にしてみてくださいね。

• Figure.colorbar() / pyplot.colorbar() – matplotlibドキュメント日本語訳
• colorbar.ColorbarBaseクラス – matplotlibドキュメント日本語訳
• matplotlibのcolorbarを図と同じサイズにする方法。

下準備

次のようなcolorbarを付与したマップに対してラベル操作をしていきます。例はオブジェクト指向スタイルですが、colorbarはpyplotスタイルでも同様に扱えます。

import matplotlib.pyplot as plt

dat = [[1,2,3,4,],
       [5,6,7,8,],
       [9,10,11,12,],
       [13,14,15,16,],]
fig, ax = plt.subplots()
aximg = ax.matshow(dat)

fig.colorbar(aximg, ax=ax)
plt.show()

colorbarにラベル(label)を表示する

colorbarにラベル(例: ‘foobar’)を表示するには、colorbarを作成する際に、colorbarメソッドに次のようにlabelパラメータを渡します。

colorbar(mappable, ax=ax, label='foobar')

もう一つの方法としては、colorbarBaseの公開メソッドであるset_label()を使います。

colorbar(mappable, ax=ax).set_label('foobar')

colorbar()は返り値にColorbarを返します。

これは、オブジェクト指向スタイルのfigure.Figure.colorbar()でも、pyplotスタイルのpyplot.colorbar()でも同様です。

例

colorbarに’foobar’というラベルをセットします。

import matplotlib.pyplot as plt

dat = [[1,2,3,4,],
       [5,6,7,8,],
       [9,10,11,12,],
       [13,14,15,16,],]
fig, ax = plt.subplots()
aximg = ax.matshow(dat)

fig.colorbar(aximg, ax=ax, label='foobar') #'foobar'というラベルをセット
#fig.colorbar(aximg, ax=ax).set_label('foobar') #これでも可
plt.show()

ラベルが表示されました。

colorbarラベルのフォントサイズ(font size)

colorbar ラベルのフォントサイズを変更するには、colorbarのset_label()メソッドに、次のようにパラメータsizeかfontsizeを渡します。

colorbar(mappable, ax=ax).set_label('foobar', size=20)
# colorbar(mappable, ax=ax).set_label('foobar', fontsize=20) #これでも可

フォントサイズには、浮動小数点のほか、’large’なども使えます。

fontsize or size: float or {‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’}

他の方法としては、次のようにパラメータfontdictとして辞書形式のフォントスタイルを渡すことでも、フォントサイズを変更できます。

colorbar(mappable, ax=ax).set_label('foobar', fontdict={'size' : 20})

あるいは、rcParamsを変更すると、colorbarのラベルを含めて、他のラベルも一括してフォントサイズを変更することができます。colorbarでフォントサイズが指定されている場合はそちらが優先されます。

plt.rcParams['axes.labelsize'] = 10 #ラベル全体のフォントサイズ
plt.rcParams['font.size'] = 10 #全体のフォントサイズ

import matplotlib.pyplot as plt

dat = [[1,2,3,4,],
       [5,6,7,8,],
       [9,10,11,12,],
       [13,14,15,16,],]
fig, ax = plt.subplots()
aximg = ax.matshow(dat)

cb = fig.colorbar(aximg, ax=ax)
cb.set_label('foobar', size=20) #ラベルサイズを20ポイントにする

plt.show()

colorbar(mappable, ax=ax).set_label('foobar', color='r') #赤色にする
# colorbar(mappable, ax=ax).set_label('foobar', c='r') #これでも可

colorbar(mappable, ax=ax).set_label('foobar', backgroundcolor='r') #背景を赤色にする

fontdictにスタイルを渡す方法も使えます。

colorbar(mappable, ax=ax).set_label('foobar', fontdict={'color' : 'r'})

例

ラベル色を赤色にします。

import matplotlib.pyplot as plt

dat = [[1,2,3,4,],
       [5,6,7,8,],
       [9,10,11,12,],
       [13,14,15,16,],]
fig, ax = plt.subplots()
aximg = ax.matshow(dat)

cb = fig.colorbar(aximg, ax=ax)
cb.set_label('foobar', c='r') #ラベル文字色を赤にする。
cb.set_label('foobar', fontdict={'color' : '#a33'}) #これでも可

plt.show()

ラベル色が赤色になりました。

colorbar(mappable, ax=ax).set_label('foobar', y=1)

positionを使って次のようにもできます。

colorbar(mappable, ax=ax).set_label('foobar', position=(0,1))

ラベルとtickラベルの間隔をあけたい場合には、次の項「ラベルパディング」を参照してください。

matplotlibのversionが3.3.0以降であれば、locパラメータも使えます。

colorbar(mappable, ax=ax).set_label('foobar', loc='top')

loc{‘bottom’, ‘center’, ‘top’}, default: rcParams["xaxis.labellocation"] (default: 'center')

The label position. This is a high-level alternative for passing parameters x and horizontalalignment.

locパラメータが対応していないバージョンで使った場合には、’Text’ object has no property ‘loc’というエラーが出ます。matplotlibのバージョンは次のようにして確認します。

import matplotlib
matplotlib.__version__

matplotlibのバージョンを3.3.3などに指定してインストールするには次のようにします。google colabolatoryではこのコマンドでインストールすれば、最新のバージョンも使えますね。

!pip install matplotlib==3.3.3

例

ラベルを上端に移動します。

import matplotlib.pyplot as plt

dat = [[1,2,3,4,],
       [5,6,7,8,],
       [9,10,11,12,],
       [13,14,15,16,],]
fig, ax = plt.subplots()
aximg = ax.matshow(dat)

cb = fig.colorbar(aximg, ax=ax)
cb.set_label('foobar', y=1) #ラベルを上端に移動
#cb.set_label('foobar', loc='top') #version 3.3.0以降なら、これも可
plt.show()

ラベル位置が移動しました。

colorbarのラベルパディング/スペーシング (labelpad)

colorbarのラベルとtickがぶつかっているなどして、ラベルの間隔をあけたい場合には、labelpadパラメータをポイント単位で渡します。

colorbar(mappable, ax=ax).set_label('foobar', labelpad=10)

labelpad: float, default: None
Spacing in points from the axes bounding box including ticks and tick labels.

例

colorbarのtickラベルとラベルの間に100ポイントの余白をあけます。

import matplotlib.pyplot as plt

dat = [[1,2,3,4,],
       [5,6,7,8,],
       [9,10,11,12,],
       [13,14,15,16,],]
fig, ax = plt.subplots()
aximg = ax.matshow(dat)

fig.colorbar(aximg, ax=ax).set_label('foobar', labelpad=100)

plt.show()

余白があきました。

colorbarのラベル回転 (rotation)

回転するには、colorbar.set_label()にrotationパラメータを渡します。回転角は、度(deg.)で指定します。xの正方向を0度として、反時計回りに数えます。

colorbar(mappable, ax=ax).set_label('foobar', rotation=270)

90度がデフォルト状態です。0度だと水平です。270度でデフォルトから反転します。

例

ラベルを反転する。

import matplotlib.pyplot as plt

dat = [[1,2,3,4,],
       [5,6,7,8,],
       [9,10,11,12,],
       [13,14,15,16,],]
fig, ax = plt.subplots()
aximg = ax.matshow(dat)

cb = fig.colorbar(aximg, ax=ax)
cb.set_label('foobar', rotation=270) #270度回転

plt.show()

もっと複雑なことをする

colorbar.set_label()は、実際には、colorbarのaxプロパティに対してset_ylabel()しています。

colorbar.ax.set_ylabel('foobar')

そのため、axes.set_ylabel()でできることは、colorbar.set_label()でもできますので、axes.set_ylabel()のドキュメントを参照してみてください。

• matplotlib.axes.Axes.set_ylabel

axes.set_ylabel()には、text.Textプロパティをパラメータとして渡せますので、このドキュメントも参照してみてください。

• matplotlib.text.Text

例

label == ylabelだということはxlabelはどこにあるのか?

import matplotlib.pyplot as plt

dat = [[1,2,3,4,],
       [5,6,7,8,],
       [9,10,11,12,],
       [13,14,15,16,],]
fig, ax = plt.subplots()
aximg = ax.matshow(dat)

cb = fig.colorbar(aximg, ax=ax)
cb.ax.set_xlabel('cb_xlabel')

plt.show()