matplotlib.colorbar#

カラーバーは、スカラー値から色へのマッピングを視覚化したものです。Matplotlib では、それらは専用のAxes.

ノート

カラーバーは通常、Figure.colorbarまたはその pyplot wrapperを介して作成されますpyplot.colorbar。これは、内部的に(配置された軸の場合) または(配置されていない軸の場合)Colorbarと一緒に 使用されます。make_axes_gridspecGridSpecmake_axesGridSpec

ほとんどの場合、エンドユーザーはこのモジュールの API を直接使用する必要はありません。

クラス matplotlib.colorbar。カラーバー( ax、 mappable =None、 *、 cmap=None、 norm=None、 alpha=None、 values=None、 boundary= None、 orientation='vertical'、 ticklocation='auto'、 extend=None、 spacing='uniform ' , ticks=None , format=None , drawedges=False , filled=<非推奨のパラメータ> , extendfrac =None , extrect=False , label='' ) [ソース] #

拠点:object

既存の座標軸にカラー バーを描画します。

通常、カラーバーはFigure.colorbarまたは pyplot.colorbarを使用して作成され、 に関連付けられScalarMappableます ( AxesImage生成された ビアなどimshow)。

Figure 内の他の要素に関連付けられていないカラーバーを描画するには、たとえば、カラーマップを単独で表示する場合、空の を作成する か、またはmappable toの代わりにcmapとnormScalarMappableを直接渡すことができます。Colorbar

便利なパブリック メソッドはset_label()とadd_lines()です。

パラメータ:
斧Axes

カラーバーが描画されるAxesインスタンス。

マッピング可能ScalarMappable

カラーマップとノルムが使用されるマップ可能オブジェクト。

アンダーバリューとオーバーバリューの色を表示するには、マッピング可能なノルムを次のように指定する必要があります。

norm = colors.Normalize(clip=False)

0 から 1 のスケールではなく、インデックスに対する色を表示するには、次を使用します。

norm=colors.NoNorm()
cmap Colormap、デフォルト: rcParams["image.cmap"](デフォルト: 'viridis')

使用するカラーマップ。mappableが Noneでない限り、このパラメーターは無視されます。

ノルムNormalize

使用する正規化。mappable が Noneでない限り、このパラメーターは無視されます。

アルファフロート

0 (透明) と 1 (不透明) の間のカラーバーの透明度。

向き{'vertical', 'horizo​​ntal'}
ticklocation {'auto', 'left', 'right', 'top', 'bottom'}
ドローエッジブール
埋められたブール
拡張{'どちらでもない', '両方', '最小', '最大'}

範囲外の値には尖った端を作成します (「どちらでもない」場合を除く)。これらは、カラーマップの set_under および set_over メソッドを使用して、特定のカラーマップに対して設定されます。

extendfrac {なし、「自動」、長さ、長さ}

Noneに設定すると、三角形のカラー バー拡張の最小値と最大値の両方が、内部カラー バーの長さの 5% になります (これが既定の設定です)。

'auto' に設定すると、三角形のカラー バーの拡張部分が内部ボックスと同じ長さ (間隔が 'uniform' に設定されている場合) またはそれぞれの隣接する内部ボックスと同じ長さ (間隔が 'proportional' に設定されている場合) になります。

スカラーの場合、三角形のカラー バー拡張の最小値と最大値の両方の長さを、内部カラー バーの長さの割合として示します。2 要素の分数列を指定することもできます。これは、最小および最大のカラー バー拡張の長さをそれぞれ内部カラー バーの長さの分数として示します。

ブール値を拡張

Falseの場合、最小および最大のカラーバー拡張は三角形になります (デフォルト)。Trueの場合、拡張は長方形になります。

間隔{'uniform', 'proportional'}

個別のカラーバー (BoundaryNormまたは等高線) の場合、'uniform' は各色に同じスペースを与えます。'proportional' は、スペースをデータ間隔に比例させます。

ticksなしまたは目盛りのリストまたはロケータ

None の場合、ティックは入力から自動的に決定されます。

format None または str または Formatter

None の場合ScalarFormatterは使用されます。"%4.2e"や などのフォーマット文字列"{x:.2e}"がサポートされています。代わりに代替案Formatterが提示される場合があります。

ドローエッジブール

色の境界に線を引くかどうか。

ラベル文字列

カラーバーの長軸のラベル。

境界、値なしまたはシーケンス

設定されていない場合、カラーマップは 0 ～ 1 のスケールで表示されます。シーケンスの場合、値の長さは境界より 1 小さくなければなりません。境界内の隣接するエントリによって区切られた各領域に対して、値内の対応する値にマップされた色が使用されます。通常、インデックス付きの色 (つまりnorm=NoNorm()) またはその他の異常な状況でのみ役立ちます。

属性:
斧Axes

カラーバーが描画されるAxesインスタンス。

行リスト

LineCollection(線が描画されていない場合は空)のリスト。

仕切りLineCollection

LineCollection ( drawedgesがの場合は空False)。

add_lines ( *引数, ** kwargs ) [ソース] #

カラーバーに線を引きます。

行がリストに追加されますlines。

パラメータ:
配列のようなレベル

線の位置。

色色または色のリスト

すべての線に単一の色を適用するか、各線に 1 つの色の値を適用します。

float または array-like の線幅

すべての行に単一の線幅を適用するか、各行に 1 つの線幅を適用します。

ブール値を消去、デフォルト: True

以前に追加された行を削除するかどうか。

ノート

または、このメソッドをシグネチャ で呼び出すこともできます。この場合 、 levels、colors、およびlinewidthsは、contour_setから取得されます。colorbar.add_lines(contour_set, erase=True)

drag_pan (ボタン,キー, x , y ) [ソース] #
draw_all ( ) [ソース] #

[非推奨] 現在の cmap とノルムに基づいて自由なパラメーターを計算し、すべての描画を行います。

ノート

バージョン 3.6 以降非推奨:代わりに fig.draw_without_rendering() を使用してください。

プロパティ が満たされた[ソース] #
プロパティ フォーマッタ#

カラーバーの大目盛ラベルFormatter。

get_ticks (マイナー= False ) [ソース] #

目盛りを位置のリストとして返します。

パラメータ:
マイナーブール値、デフォルト: False

True の場合、マイナー ティックを返します。

プロパティ ロケーター#

カラーバーの大目盛りLocator。

プロパティ マイナーフォーマッタ#

カラーバーの小目盛りFormatter。

プロパティ マイナーロケータ#

カラーバーの小目盛りLocator。

minorticks_off ( ) [ソース] #

カラーバーのマイナー ティックをオフにします。

minorticks_on ( ) [ソース] #

カラーバーのマイナー ティックをオンにします。

n_rasterize = 50 #
プロパティ パッチ[ソース] #
削除( ) [ソース] #

このカラー バーを Figure から削除します。

カラーバーが以前の gridspec で作成された場合use_gridspec=Trueは復元されます。

set_alpha (アルファ) [ソース] #

透明度を 0 (透明) から 1 (不透明) の間で設定します。

配列が指定されている場合、alphaは None に設定され、カラーマップに関連付けられた透明度の値が使用されます。

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

カラー バーの長軸にラベルを追加します。

パラメータ:
ラベル文字列

ラベル テキスト。

loc str、オプション

ラベルの場所。

  • 水平方向の場合、{'left', 'center', 'right'} のいずれか

  • 垂直方向の場合、{'bottom', 'center', 'top'} のいずれか

方向に応じて、デフォルトはrcParams["xaxis.labellocation"](デフォルト: 'center') またはrcParams["yaxis.labellocation"](デフォルト: ) になります。'center'

**kwargs

set_xlabelキーワード引数は/ に渡されset_ylabelます。サポートされているキーワードは、labelpadとTextプロパティです。

set_ticklabels ( ticklabels , update_ticks=<非推奨の パラメーター> , * , minor=False , **kwargs ) [source] #

[お勧めしません]目盛りラベルを設定します。

がっかり

目盛りの位置に依存するため、このメソッドの使用は推奨されません。ほとんどの場合、 代わりに を使用します。set_ticks(positions, labels=labels)

この方法を使用している場合は、カラーバーの長軸にa を使用するColorbar.set_ticksか明示的に設定するなどして、目盛りの位置を事前に固定する必要があります。FixedLocatorそうしないと、目盛りが自由に移動し、ラベルが予期しない位置に配置される可能性があります。

パラメータ:
str または of のticklabelsシーケンスText

によって設定されたシーケンス内の各目盛り位置にラベルを付けるためのテキスト Colorbar.set_ticks。ラベルの数は場所の数と一致する必要があります。

update_ticks bool、デフォルト: True

このキーワード引数は無視され、削除されます。非推奨

マイナーブール

True の場合、主ティックの代わりに副ティックを設定します。

**kwargs

Textラベルのプロパティ。

set_ticks ( ticks , update_ticks=<非推奨の パラメーター> , labels=None , * , minor=False , **kwargs ) [source] #

目盛りの位置を設定します。

パラメータ:
フロートのリスト

ティック位置のリスト。

ラベルstr のリスト、オプション

目盛りラベルのリスト。設定されていない場合、ラベルにはデータ値が表示されます。

マイナーブール値、デフォルト: False

の場合False、主目盛りを設定します。の場合True、マイナー ティック。

**kwargs

Textラベルのプロパティ。これらは、 labelsを渡した場合にのみ有効になります。それ以外の場合は をご利用くださいtick_params。

update_normal ( mappable ) [ソース] #

ソリッド パッチ、ラインなどを更新します。

これは、このカラーバーが属する画像または等高線図のノルムが変更されたときに呼び出されることを意図しています。

マッピング可能のノルムが以前と異なる場合、これにより軸のロケーターとフォーマッターがリセットされるため、これらがカスタマイズされている場合は、再度カスタマイズする必要があります。ただし、ノルムがvmin、vmaxまたはcmapの値のみを変更する場合、古いフォーマッターとロケーターが保持されます。

update_ticks ( ) [ソース] #

目盛りと目盛りラベルを設定します。これはユーザーには必要ありません。

matplotlib.colorbar. ColorbarBase [ソース] #

のエイリアスColorbar

matplotlib.colorbar. make_axes ( parents、 location = None、 orientation = None、 fraction = 0.15、 shrink = 1.0、 aspect = 20、 ** kwargs ) [source] #

Axesカラーバーに適した を作成します。

軸は、親のサイズと位置を変更することによって、親の軸の Figure に配置されます。

パラメータ:
親AxesまたはリストAxes

カラーバーを配置するための親として使用する Axes。

location None または {'left', 'right', 'top', 'bottom'}

カラーバー軸が作成される、親軸に対する相対的な位置。また、カラーバーの方向も決定します (左右のカラーバーは垂直、上下のカラーバーは水平)。None の場合、位置は、 設定されている場合は方向から取得されます (垂直カラーバーが右側に、水平カラーバーが下部にある)、または方向が設定されていない場合はデフォルトで「右」になります。

向きNone または {'vertical', 'horizo​​ntal'}

カラーバーの向き。カラーバーの位置を設定することをお勧めします。これにより、方向 も決定されます。位置と向きに互換性のない値を渡すと、例外が発生します。

分数浮動小数点数、デフォルト: 0.15

カラーバーに使用する元の軸の割合。

縮小フロート、デフォルト: 1.0

カラーバーのサイズに掛ける分数。

アスペクトフロート、デフォルト: 20

長い寸法と短い寸法の比率。

パッドフロート、デフォルト: 垂直の場合は 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 (親, * ,位置=なし,方向=なし,分数= 0.15 ,収縮= 1.0 ,アスペクト= 20 , ** kwargs ) [ソース] #

SubplotBaseカラーバーに適した を作成します。

親のサイズと位置を変更することにより、軸は親軸の Figure に配置されます。

この関数は に似ていmake_axesます。主な違いは

この関数は と互換性があるように意図されていますがmake_axes、いくつかの小さな違いがある可能性があります。

パラメータ:
親Axes

カラーバーを配置するための親として使用する Axes。

location None または {'left', 'right', 'top', 'bottom'}

カラーバー軸が作成される、親軸に対する相対的な位置。また、カラーバーの方向も決定します (左右のカラーバーは垂直、上下のカラーバーは水平)。None の場合、位置は、 設定されている場合は方向から取得されます (垂直カラーバーが右側に、水平カラーバーが下部にある)、または方向が設定されていない場合はデフォルトで「右」になります。

向きNone または {'vertical', 'horizo​​ntal'}

カラーバーの向き。カラーバーの位置を設定することをお勧めします。これにより、方向 も決定されます。位置と向きに互換性のない値を渡すと、例外が発生します。

分数浮動小数点数、デフォルト: 0.15

カラーバーに使用する元の軸の割合。

縮小フロート、デフォルト: 1.0

カラーバーのサイズに掛ける分数。

アスペクトフロート、デフォルト: 20

長い寸法と短い寸法の比率。

パッドフロート、デフォルト: 垂直の場合は 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辞書

カラーバー インスタンスの作成時に渡される縮小キーワード ディクショナリ。