`matplotlib.cm`#

組み込みのカラーマップ、カラーマップ処理ユーティリティ、およびScalarMappablemixin。

こちらもご覧ください

組み込みカラーマップのリストのカラーマップリファレンス。

カラーマップの作成方法の例については、Matplotlib でカラーマップを作成します。

Choose Colormaps in Matplotlibでは、カラーマップの選択について詳しく説明しています。

データの正規化の詳細については、カラーマップの正規化を参照してください。

クラス matplotlib.cm。ColormapRegistry ( cmaps ) [ソース] #

拠点:Mapping

名前で Matplotlib に知られているカラーマップのコンテナー。

実験的

API が最終版になることを期待していますが、必要に応じて API を 3.6 に適応させるオプションを残しておきたいため、正式に 3.5 の実験的なものとしてマークします。

ユニバーサルレジストリのインスタンスはmatplotlib.colormapsです。ユーザーが自分自身をインスタンス化する必要はありませんColormapRegistry。

読み取りアクセスは、名前をColormapsにマッピングする dict のようなインターフェースを使用します。

import matplotlib as mpl
cmap = mpl.colormaps['viridis']

返さColormapれるはコピーであるため、変更によってカラーマップのグローバル定義が変更されることはありません。

次の方法で追加のカラーマップを追加できますColormapRegistry.register。

mpl.colormaps.register(my_colormap)

register ( cmap , * , name = None , force = False ) [source] #

新しいカラーマップを登録します。

cmap カラーマップ名は、Matplotlibの任意のパラメーターへの文字列引数として使用できます。にもありますpyplot.get_cmap。

カラーマップレジストリは、指定されたカラーマップのコピーを格納するため、元のカラーマップインスタンスに対する将来の変更は、登録されたカラーマップに影響を与えません。これは、登録時にカラーマップのスナップショットを取得するレジストリと考えてください。

パラメータ:

cmap matplotlib.colors.Colormap: 登録するカラーマップ。
名前文字列、オプション: カラーマップの名前。指定されていない場合は、cmap.name使用されます。
強制ブール、デフォルト: False: False の場合、既に登録されている名前を上書きしようとすると、ValueError が発生します。True は、組み込みカラーマップ以外の登録済みカラーマップの上書きをサポートします。

登録解除(名前) [ソース] #

レジストリからカラーマップを削除します。

組み込みのカラーマップは削除できません。

指定されたカラーマップが登録されていない場合、エラーなしで返され、デフォルトのカラーマップを登録解除しようとすると発生します。

警告

カラーマップ名は現在、複数のパッケージで使用できる共有名前空間です。unregister以前にその名前を登録したことがわかっている場合にのみ使用してください。特に、新しいカラーマップを登録する前に名前を消去する場合に備えて、登録を解除しないでください。

パラメータ:

名前文字列: 削除するカラーマップの名前。

レイズ:

ValueError: デフォルトの組み込みカラーマップを削除しようとした場合。

クラス matplotlib.cm。ScalarMappable ( norm = None , cmap = None ) [source] #

拠点:object

スカラーデータを RGBA にマップする mixin クラス。

ScalarMappable は、指定されたカラーマップから RGBA カラーを返す前に、データの正規化を適用します。

パラメータ:

norm Normalize(またはそのサブクラス) または str または None: 通常、データを interval にスケーリングする正規化オブジェクト。の場合、対応する名前のスケールに基づいてサブクラスが動的に生成されます。Noneの場合、ノルムはデフォルトで、処理された最初のデータに基づいてスケーリングを初期化するcolors.Normalizeオブジェクトになります。[0, 1]strNormalize
cmap str またはColormap: 正規化されたデータ値を RGBA カラーにマップするために使用されるカラーマップ。

自動スケーリング( ) [ソース] #: 現在の配列を使用してノルムインスタンスのスカラー制限を自動スケーリングします

autoscale_None ( ) [ソース] #: 現在の配列を使用してノルムインスタンスのスカラー制限を自動スケーリングし、None の制限のみを変更します

プロパティ callbacksSM [ソース] #

変更( ) [ソース] #: mappable が変更されるたびにこれを呼び出して、すべての callbackSM リスナーに「変更された」シグナルを通知します。

カラーバー#: この ScalarMappable に関連付けられた最後のカラーバー。なしの場合があります。

get_alpha ( ) [ソース] #

戻り値:

浮く: 常に 1 を返します。

get_array ( ) [ソース] #

色にマッピングされた値の配列を返します。

基本クラスScalarMappableは、配列の次元と形状について何も仮定しません。

get_clim ( ) [ソース] #: カラーマップの範囲にマップされる値 (最小、最大) を返します。

get_cmap ( ) [ソース] #: インスタンスを返しColormapます。

プロパティ ノルム#

set_array ( A ) [ソース] #

配列のようなAから値配列を設定します。

パラメータ:

配列のようなものまたは None

色にマップされる値。

基本クラスは、値配列AScalarMappableの次元と形状について何も仮定しません。

set_clim ( vmin =なし, vmax =なし) [ソース] #

イメージスケーリングのノルム制限を設定します。

パラメータ:

vmin、vmaxフロート

限界。

制限は、単一の位置引数としてタプル ( vmin、vmax ) として渡すこともできます。

set_cmap ( cmap ) [ソース] #

輝度データのカラーマップを設定します。

パラメータ:

cmapColormapまたは str または None

set_norm (ノルム) [ソース] #

正規化インスタンスを設定します。

パラメータ:

normNormalizeまたは str または None

ノート

このノルムにマッピング可能を使用するカラーバーがある場合、マッピング可能のノルムを設定すると、カラーバーのノルム、ロケーター、およびフォーマッターがデフォルトにリセットされます。

to_rgba ( x , alpha = None , bytes = False , norm = True ) [source] #

xに対応する正規化された rgba 配列を返します。

通常、xはスカラーの 1D または 2D シーケンスであり、この ScalarMappable に設定されたノルムとカラーマップに基づいて、rgba 値の対応する ndarray が返されます。

画像ファイルから読み取られた可能性があるなど、既に rgb または rgba である画像を処理するための特殊なケースが 1 つあります。xが 3 次元の ndarray で、最後の次元が 3 または 4 の場合、それは rgb または rgba 配列として扱われ、マッピングは行われません。配列は uint8 にすることも、0 ～ 1 の範囲の値を持つ浮動小数点にすることもできます。そうしないと、ValueError が発生します。マスクされた配列の場合、マスクは無視されます。最後の次元が 3 の場合、alpha kwarg (デフォルトは 1) を使用して透明度を塗りつぶします。最後の次元が 4 の場合、alpha kwarg は無視されます。既存のアルファを置き換えるものではありません。3 番目の次元が 3 または 4 以外の場合、ValueError が発生します。

いずれの場合も、bytesがFalse (デフォルト) の場合、rgba 配列は 0 ～ 1 の範囲の float になります。Trueの場合、返される rgba 配列は 0 ～ 255 の範囲の uint8 になります。

norm が False の場合、入力データの正規化は実行されず、範囲 (0-1) にあると見なされます。

matplotlib.cm。get_cmap ( name =なし, lut =なし) [source] #

[非推奨] カラーマップインスタンスを取得します。名前が Noneの場合、デフォルトで rc 値になります。

パラメータ:

namematplotlib.colors.Colormapまたは str または None、デフォルト: None: インスタンスの場合Colormap、それが返されます。それ以外の場合、 lutによってリサンプリングされる、Matplotlib に認識されているカラーマップの名前。デフォルトの None はrcParams["image.cmap"](デフォルト: 'viridis') を意味します。
lut int または None、デフォルト: None: nameがまだ Colormapインスタンスではなく、 lutが None でない場合、カラーマップは再サンプリングされ、ルックアップテーブルにlutエントリが含まれます。

戻り値:

カラーマップ

ノート

バージョン 3.6 以降非推奨:matplotlib.colormaps[name]代わりに使用してください。

matplotlib.cm。register_cmap ( name = None , cmap = None , * , override_builtin = False ) [source] #

[非推奨] によって認識されるセットにカラーマップを追加しget_cmap()ます。

名前でアクセスする新しいカラーマップを登録します

LinearSegmentedColormap('swirly', data, lut)
register_cmap(cmap=swirly_cmap)

パラメータ:

名前文字列、オプション

get_cmap()またはで使用できる名前rcParams["image.cmap"](デフォルト: 'viridis')

存在しない場合、名前はcmapnameの属性になります。

cmap matplotlib.colors.Colormap

2 番目の引数であり、デフォルト値がありますが、これは必須の引数です。

override_builtinブール値

組み込みのカラーマップをユーザー提供のカラーマップでオーバーライドできるようにします。

確実に必要でない限り、これを使用しないでください。

ノート

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

matplotlib.cm。unregister_cmap (名前) [ソース] #

[非推奨] によって認識されるカラーマップを削除しget_cmap()ます。

組み込みのカラーマップを削除することはできません。

指定されたカラーマップが登録されていない場合、エラーなしで返され、デフォルトのカラーマップを登録解除しようとすると発生します。

警告

カラーマップ名は現在、複数のパッケージで使用できる共有名前空間です。unregister_cmap以前にその名前を登録したことがわかっている場合にのみ使用してください。特に、新しいカラーマップを登録する前に名前を消去する場合に備えて、登録を解除しないでください。

パラメータ:

名前文字列: 登録解除するカラーマップの名前

戻り値:

カラーマップまたはなし: カラーマップが登録されていた場合、登録されていない場合はそれを返しますNone

レイズ:

ValueError: デフォルトの組み込みカラーマップを登録解除しようとした場合。

ノート

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

matplotlib.cm#

`matplotlib.cm`#