pyvista.Color

目次

pyvista.Color#

class Color(*args, **kwargs)[ソース]#

pyvista ライブラリで使用される異なる色表現間の変換を行うヘルパークラスです．

多くの pyvista メソッドは ColorLike パラメータを受け取ります．このヘルパークラスは，そのようなパラメータを，基本的な (VTK) メソッドで使用される必要な形式に変換するために使用されます．色名 ( str ) や 16 進文字列 ( str ) ， RGB(A) 配列 ( tuple , list または int や float ) の numpy.ndarray は ColorLike パラメータとみなされ，このクラスによって変換することが可能です．

See Named Colors for a list of supported colors.

パラメータ:
colorColorLike, optional

文字列，RGB配列，RGBA配列，16進数色文字列のいずれか．RGB(A)シーケンスは，0から1までのfloatか，0から255までのintとして提供されるべきです．16進数の色文字列には，オプションで '#' や 0x' という接頭辞をつけることができます．不透明度を指定しなかった場合は， default_opacity が使用されます．また， color に None を指定すると， default_color が代わりに使用されます．以下の例は，すべて '白' の色を表現しています．

  • 'white'

  • 'w'

  • [1.0, 1.0, 1.0]

  • [255, 255, 255, 255]

  • '#FFFFFF'

opacityint | float | str, optional

表現された色の不透明度．与えられた color に関連するすべての不透明度を上書きします．許容される不透明度は，0 から 1 までの浮動小数点数，0 から 255 までの整数，または長さ 2（とオプションのプレフィックス長）の 16 進文字列です．以下の例では，すべて完全に不透明な色を表現しています．

  • 1.0

  • 255

  • '#ff'

default_colorColorLike, optional

color が None の場合に使用されるデフォルトの色です． もしこの値が None であれば，デフォルトではグローバルテーマカラーを使用します． フォーマットは color と同じです．

default_opacityint | float | str, optional

表現された色のデフォルトの不透明度．color`` が不透明度を指定しない場合，および opacity が None の場合に使用されます．フォーマットは opacity と同じです．

例

色名，float RGBA 列，integer RGBA 列，RGBA 16 進文字列を使用して，透明な緑色を作成します．

>>> import pyvista as pv
>>> pv.Color('green', opacity=0.5)
Color(name='green', hex='#00800080', opacity=128)
>>> pv.Color([0.0, 0.5, 0.0, 0.5])
Color(name='green', hex='#00800080', opacity=128)
>>> pv.Color([0, 128, 0, 128])
Color(name='green', hex='#00800080', opacity=128)
>>> pv.Color('#00800080')
Color(name='green', hex='#00800080', opacity=128)

メソッド

Color.convert_color_channel(val)

与えられた色チャンネルの値を整数表現に変換します．

Color.from_dict(dict_)

JSONデシリアライズのために辞書から構築します．

Color.linear_to_srgb()

リニアカラー値からsRGBカラー値へ変換します．

Color.srgb_to_linear()

リニアカラー値からsRGBカラー値へ変換します．

Color.strip_hex_prefix(h)

16進文字列から '#' または 0x' という接頭辞を取り除きます．

Color.to_dict()

JSONシリアライズのために辞書に変換します．

アトリビュート

Color.float_rgb

色の値を RGB float のタプルとして返します．

Color.float_rgba

色の値を RGBA float のタプルとして返します．

Color.hex_rgb

色の値をRGBの16進数で返します．

Color.hex_rgba

色の値をRGBAの16進数で返します．

Color.int_rgb

色の値を RGB integer のタプルとして返します．

Color.int_rgba

色の値を RGBA integer のタプルとして返します．

Color.name

色名を返します．

Color.opacity

この色の不透明度を (0-255) の範囲で返します．

Color.vtk_c3ub

色の値をVTK Color3ubのインスタンスとして返します．
目次