pyvista.Plotter

class Plotter(*args, **kwargs)

vtkメッシュまたは無感覚な配列を表示するためのオブジェクトのプロット．

パラメータ:

off_screenbool, optional

True の場合，画面をレンダリングしません．自動スクリーンショットに便利です．

notebookbool, optional

True の場合，作成されたプロットはjupyterノートブック内に配置されます．jupyterコンソールがアクティブであると仮定します． off_screen を自動的に有効にします．

shapesequence[int], optional

メインウィンドウ内のサブレンダリングウィンドウの数． shape=(2, 1) で2 acrossを， shape=(2, 2) で2 x 2 グリッドを指定します．デフォルトでは，レンダウィンドウは1つだけです．文字列記述子をshapeとして受け入れることもできます．例:

• shape="3|1" とは，左側に3区画，右側に1区画という意味です．

• shape="4/2" は，上に4プロット，下に2プロットを意味します．

borderbool, optional

各レンダリングウィンドウの周囲に境界を描きます．

border_colorColorLike, default: "k"

文字列，RGBリスト，または16進カラー文字列．例:

• color='white'

• color='w'

• color=[1.0, 1.0, 1.0]

• color='#FFFFFF'

window_sizesequence[int], optional

ピクセル単位のウィンドウサイズ．デフォルトは [1024, 768] です．ただし，関連するテーマの window_size プロパティで別の値が設定されている場合を除きます．

line_smoothingbool, default: False

Trueの場合，ラインスムージングを有効にします．

polygon_smoothingbool, default: False

True の場合，ポリゴンのスムージングを有効にします．

lightingstr, default: 'light kit"

プロッタに設定する照明．使用可能なオプション:

• 'light kit': 5個のライトで構成されるvtk Light Kitです．

• 'three lights': 3つのライトを使用した照明．

• 'none': インスタンス化時に光源がありません．

デフォルトは 'light kit' (正確には，Light Kitのように動作する5つの独立したライト)です．

themepyvista.plotting.themes.Theme, optional

Plot固有のテーマ．

image_scaleint, optional

スクリーンショットを保存する際のスケールファクター．画像のサイズは window_size にこのスケールファクターを掛けたものになります．

例

>>> import pyvista as pv
>>> mesh = pv.Cube()
>>> another_mesh = pv.Sphere()
>>> pl = pv.Plotter()
>>> actor = pl.add_mesh(
...     mesh, color='red', style='wireframe', line_width=4
... )
>>> actor = pl.add_mesh(another_mesh, color='blue')
>>> pl.show()

メソッド

Plotter.add_actor(actor[, reset_camera, ...])	レンダリングウィンドウにアクターを追加します．
Plotter.add_affine_transform_widget(actor[, ...])	3D affine 変換ウィジェットを追加します．
Plotter.add_arrows(cent, direction[, mag])	プロッタに矢印を追加します．
Plotter.add_axes([interactive, line_width, ...])	左下隅にインタラクティブ軸ウィジェットを追加します．
Plotter.add_axes_at_origin([x_color, ...])	原点に軸アクターを追加します．
Plotter.add_background_image(image_path[, ...])	背景イメージをプロットに追加します．
Plotter.add_blurring()	ぼかしを入れます．
Plotter.add_bounding_box([color, ...])	プロットの境界にラベルなしのチェックボックスを追加します．
Plotter.add_box_widget(callback[, bounds, ...])	ボックスウィジェットをシーンに追加します．
Plotter.add_camera_orientation_widget([...])	カメラの向きを表すウィジェットをアクティブレンダラーに追加します．
Plotter.add_chart(chart, *charts)	このレンダラーにチャートを追加します．
Plotter.add_checkbox_button_widget(callback)	チェックボックスボタンウィジェットをシーンに追加します．
Plotter.add_composite(dataset[, color, ...])	プロッターにコンポジットデータセットを追加します．
Plotter.add_cursor([bounds, focal_point, color])	PyVistaまたはVTKデータセットのシルエットをカーソルに追加します．
Plotter.add_floor([face, i_resolution, ...])	床メッシュを表示します．
Plotter.add_key_event(key, callback)	指定されたキーが押されたときにコールバックに関数を追加します．
Plotter.add_legend([labels, bcolor, border, ...])	凡例をレンダリングウィンドウに追加します．
Plotter.add_legend_scale([...])	レンダーウィンドウにスケールや距離の情報をアノテートします．
Plotter.add_light(light[, only_active])	シーンにライトを追加します．
Plotter.add_line_widget(callback[, bounds, ...])	シーンに線ウィジェットを追加します．
Plotter.add_lines(lines[, color, width, ...])	プロッティングオブジェクトに線分を追加します．
Plotter.add_logo_widget([logo, position, ...])	ビューポートの上部にロゴウィジェットを追加します．
Plotter.add_measurement_widget([callback, color])	距離ウィジェットでインタラクティブに距離を測定します．
Plotter.add_mesh(mesh[, color, style, ...])	PyVistaがシーンにラップできるPyVista/VTKメッシュまたはデータセットを追加します．
Plotter.add_mesh_clip_box(mesh[, invert, ...])	ボックスウィジェットを使用してメッシュをクリップします．
Plotter.add_mesh_clip_plane(mesh[, normal, ...])	プレインウィジェットを使用してメッシュをクリップします．
Plotter.add_mesh_isovalue(mesh[, scalars, ...])	スライダを使用してメッシュの輪郭を作成します．
Plotter.add_mesh_slice(mesh[, normal, ...])	プレインウィジェットを使用してメッシュをスライスします．
Plotter.add_mesh_slice_orthogonal(mesh[, ...])	3つのインタラクティブな平面でメッシュをスライスします．
Plotter.add_mesh_slice_spline(mesh[, ...])	スプラインウィジェットを使用してメッシュをスライスします．
Plotter.add_mesh_threshold(mesh[, scalars, ...])	スライダを使用してメッシュに閾値を適用します．
Plotter.add_on_render_callback(callback[, ...])	ポストレンダリングで呼び出されるメソッドを追加します．
Plotter.add_orientation_widget(actor[, ...])	方向マーカーウィジェットで指定したアクターを使用します．
Plotter.add_plane_widget(callback[, normal, ...])	シーンに平面ウィジェットを追加します．
Plotter.add_point_labels(points, labels[, ...])	各ポイントに割り当てられたリストラベルから1つのラベルを持つポイントアクターを作成します．
Plotter.add_point_scalar_labels(points, labels)	データセットのポイントに，スカラー値のラベルを付けます．
Plotter.add_points(points[, style])	メッシュにポイントを追加します．
Plotter.add_ruler(pointa, pointb[, ...])	ルーラーを追加します．
Plotter.add_scalar_bar([title, mapper, ...])	最後の入力メッシュによって設定された範囲を使用してスカラーバーを作成します．
Plotter.add_silhouette(mesh[, color, ...])	PyVistaまたはVTKデータセットのシルエットをシーンに追加します．
Plotter.add_slider_widget(callback, rng[, ...])	スライダバーウィジェットを追加します．
Plotter.add_sphere_widget(callback[, ...])	1つまたは複数の球ウィジェットをシーンに追加します．
Plotter.add_spline_widget(callback[, ...])	スプラインウィジェットを作成し，シーンに追加します．
Plotter.add_text(text[, position, ...])	既定では，印刷オブジェクトの左上コーナーに文字を追加します．
Plotter.add_text_slider_widget(callback, data)	テキストスライダバーウィジェットを追加します．
Plotter.add_timer_event(max_steps, duration, ...)	タイマーイベントとしてコールバックする関数を追加します．
Plotter.add_title(title[, font_size, color, ...])	プロットの上部中央にテキストを追加します．
Plotter.add_volume(volume[, scalars, clim, ...])	ボリュームを追加し，デフォルトではスマートマッパーを使用してレンダーします．
Plotter.add_volume_clip_plane(volume[, ...])	プレインウィジェットを使用してボリュームをクリップします．
Plotter.clear()	すべてのアクターとプロパティを削除して，プロットをクリアします．
Plotter.clear_actors()	すべてのレンダラーからアクターを消去します．
Plotter.clear_box_widgets()	ボックスウィジェットをすべて削除します．
Plotter.clear_button_widgets()	ボタンウィジェットをすべて削除します．
Plotter.clear_camera_widgets()	カメラウィジェットをすべて削除にします．
Plotter.clear_events_for_key(key[, ...])	キーに関連付けられているコールバックを削除します．
Plotter.clear_line_widgets()	ラインウィジェットをすべて削除します．
Plotter.clear_logo_widgets()	ロゴウィジェットをすべて削除します．
Plotter.clear_measure_widgets()	測定ウィジェットをすべて削除します．
Plotter.clear_on_render_callbacks()	以前に render() で登録したすべてのコールバックメソッドをクリアします．
Plotter.clear_plane_widgets()	プレーンウィジェットをすべて削除します．
Plotter.clear_slider_widgets()	スライダーウィジェットをすべて削除します．
Plotter.clear_sphere_widgets()	球ウィジェットをすべて削除します．
Plotter.clear_spline_widgets()	スプラインウィジェットをすべて削除します．
Plotter.close()	レンダーウィンドウを閉じます．
Plotter.deep_clean()	メモリのプロッタをクリーニングします．
Plotter.disable()	このレンダラのカメラをインタラクティブにできないようにします．
Plotter.disable_3_lights()	enable_lightkit を使用してください．このメソッドは非推奨です．
Plotter.disable_anti_aliasing([all_renderers])	アンチエイリアスを無効にします．
Plotter.disable_depth_of_field()	被写界深度のプロットを無効にします．
Plotter.disable_depth_peeling()	深度ピーリングを無効にします．
Plotter.disable_eye_dome_lighting()	Eye-Dome Lighting (EDL) を無効にします．
Plotter.disable_hidden_line_removal([...])	隠線除去を無効にします．
Plotter.disable_parallel_projection()	パース投影を使用するようにカメラをリセットします．
Plotter.disable_picking()	アクティブなピッキングを無効にし，オブザーバーを削除します．
Plotter.disable_shadows()	影を無効にします．
Plotter.disable_ssao()	スクリーンスペース・アンビエント・オクルージョン (SSAO)を無効化します．
Plotter.disable_stereo_render()	アナグリフステレオレンダリングを無効にします．
Plotter.enable()	このレンダラのカメラをインタラクティブにします．
Plotter.enable_3_lights([only_active])	3ライトイルミネーションを有効にします．
Plotter.enable_anti_aliasing([aa_type, ...])	アンチエイリアスを有効にします．
Plotter.enable_block_picking([callback, side])	コンポジットブロックピッキングを有効にします．
Plotter.enable_cell_picking([callback, ...])	矩形選択ツールでセルをピックできるようにします．
Plotter.enable_depth_of_field([...])	被写界深度のプロットを有効にします．
Plotter.enable_depth_peeling([...])	デプスのピーリングを有効にすると，半透明のジオメトリのレンダリングが向上します．
Plotter.enable_element_picking([callback, ...])	メッシュ上の個々の要素を選択します．
Plotter.enable_eye_dome_lighting()	Eye-Dome Lighting (EDL) を有効にします．
Plotter.enable_fly_to_right_click([callback])	右クリック位置をトラックするようにカメラを設定します．
Plotter.enable_geodesic_picking([callback, ...])	測地パスでの選択を有効にします．
Plotter.enable_hidden_line_removal([...])	隠線除去を有効にします．
Plotter.enable_horizon_picking([callback, ...])	範囲選択を使用可能にします．
Plotter.enable_image_style()	インタラクティブスタイルをImageに設定します．
Plotter.enable_joystick_actor_style()	インタラクティブスタイルをジョイスティックアクターに設定します．
Plotter.enable_joystick_style()	インタラクティブスタイルをジョイスティックカメラに設定します．
Plotter.enable_lightkit([only_active])	デフォルトのライトキットライティングを有効にします．
Plotter.enable_mesh_picking([callback, ...])	メッシュのピッキングを可能にします．
Plotter.enable_parallel_projection()	平行投影を有効にします．
Plotter.enable_path_picking([callback, ...])	パスの選択を有効にします．
Plotter.enable_point_picking([callback, ...])	カーソル下のポイントでのピッキングを有効にします．
Plotter.enable_rectangle_picking([callback, ...])	セルの矩形ベースの選択を有効にします．
Plotter.enable_rectangle_through_picking([...])	シーンを通して，矩形ベースのセルの選択を有効にします．
Plotter.enable_rectangle_visible_picking([...])	可視面で矩形ベースのセルピッキングを有効にします．
Plotter.enable_rubber_band_2d_style()	インタラクティブスタイルをラバーバンド2Dに設定します．
Plotter.enable_rubber_band_style()	インタラクティブスタイルをラバーバンド選択に設定します．
Plotter.enable_shadows()	影を有効にします．
Plotter.enable_ssao([radius, bias, ...])	Surface Space Ambient Occlusion (SSAO)を有効化します．
Plotter.enable_stereo_render()	アナグリフステレオレンダリングを有効にします．
Plotter.enable_surface_point_picking([...])	メッシュの表面上の点をピッキングできるようにする．
Plotter.enable_terrain_style([...])	対話型スタイルを地形に設定します．
Plotter.enable_trackball_actor_style()	インタラクティブスタイルをトラックボールアクターに設定します．
Plotter.enable_trackball_style()	インタラクティブスタイルをトラックボールカメラに設定します．
Plotter.enable_zoom_style()	インタラクティブスタイルをラバーバンドズームに設定します．
Plotter.export_gltf(filename[, inline_data, ...])	現在のレンダリングシーンをglTFファイルとしてエクスポートします．
Plotter.export_html(filename)	このプロッタをインタラクティブなシーンとしてHTMLファイルに書き出すことができます．
Plotter.export_obj(filename)	シーンをOBJフォーマットにエクスポートします．
Plotter.export_vrml(filename)	現在のレンダリングシーンをVRMLファイルとしてエクスポートします．
Plotter.export_vtksz([filename, format])	このプロッタをVTK.js OfflineLocalViewファイルとしてエクスポートします．
Plotter.fly_to(point)	カレントカメラの焦点をある位置に移動します．
Plotter.fly_to_mouse_position([focus])	最後に保存されたマウス位置にフォーカスします．
Plotter.generate_orbital_path([factor, ...])	データシーンの周囲に軌道パスを生成します．
Plotter.get_default_cam_pos([negative])	デフォルトの焦点とビューアップを返します．
Plotter.get_image_depth([fill_value, ...])	現在のレンダーウィンドウを表すDepth画像を返します．
Plotter.get_pick_position()	ピックの位置やエリアを返します．
Plotter.hide_axes()	軸方向ウィジェットを非表示にします．
Plotter.hide_axes_all()	全てのレンダラーで軸方向ウィジェットを非表示にします．
Plotter.image_scale_context([scale])	孤立したコンテキストで画像のスケールを設定します．
Plotter.import_gltf(filename[, set_camera])	glTFファイルをプロッターに取り込みます．
Plotter.import_vrml(filename)	VRML ファイルをプロッターに取り込みます．
Plotter.increment_point_size_and_line_width(...)	すべてのアクターのポイントサイズと線幅の増分．
Plotter.isometric_view()	カメラを既定のアイソメビューにリセットします．
Plotter.isometric_view_interactive()	現在のインタラクティブレンダリングウィンドウをアイソメビューに設定します．
Plotter.key_press_event(*args)	キー押下イベントを聞きます．
Plotter.left_button_down(*args)	左ボタンダウンクリックのイベントを登録します．
Plotter.link_views([views])	ビューのカメラをリンクします．
Plotter.open_gif(filename[, loop, fps, ...])	gifファイルを開きます．
Plotter.open_movie(filename[, framerate, ...])	ffmpegライタへの接続を確立します．
Plotter.orbit_on_path([path, focus, step, ...])	フォーカスポイントに焦点を合わせて，指定されたパス上をオービットします．
Plotter.pick_click_position()	3 Dプロット内の対応するクリック位置を返します．
Plotter.pick_mouse_position()	3 Dプロット内の対応するマウス位置を返します．
Plotter.remove_actor(actor[, reset_camera, ...])	レンダリングからアクターを削除します．
Plotter.remove_all_lights([only_active])	シーンからすべてのライトを削除します．
Plotter.remove_background_image()	現在のレンダラーの背景画像を削除します．
Plotter.remove_blurring()	1つのぼかしパスを削除します．
Plotter.remove_bounding_box([render])	バウンディングボックスを削除します．
Plotter.remove_bounds_axes()	境界軸を削除します．
Plotter.remove_chart(chart_or_index)	このレンダラーからチャートを削除します．
Plotter.remove_environment_texture()	環境テクスチャを削除します．
Plotter.remove_floors([clear_kwargs, render])	すべてのフロアアクターを削除します．
Plotter.remove_legend([render])	凡例アクターを削除します．
Plotter.remove_scalar_bar([title, render])	スカラーバーを削除します．
Plotter.render()	メインウィンドウをレンダリングします．
Plotter.reset_camera([render, bounds])	アクティブなレンダウィンドウのカメラをリセットします．
Plotter.reset_camera_clipping_range()	カメラのクリッピングプレーンをリセットします．
Plotter.reset_key_events()	すべてのキー押下イベントをデフォルトにリセットします．
Plotter.save_graphic(filename[, title, ...])	レンダリングウィンドウのスクリーンショットをグラフィックファイルとして保存します．
Plotter.screenshot([filename, ...])	現在のカメラ位置でスクリーンショットを撮ります．
Plotter.set_background(color[, top, right, ...])	背景色を設定します．
Plotter.set_chart_interaction(interactive[, ...])	アクティブなレンダラーのチャートとのインタラクションを設定またはトグルします．
Plotter.set_color_cycler(color_cycler[, ...])	カラーサイクラーを設定またはリセットします．
Plotter.set_environment_texture(texture[, ...])	イメージベースのライティングに使用する環境テクスチャを設定します．
Plotter.set_focus(point)	ポイントにフォーカスを設定します．
Plotter.set_position(point[, reset, render])	カメラ位置をポイントに設定します．
Plotter.set_scale([xscale, yscale, zscale, ...])	シーン内のすべてのアクターをスケールします．
Plotter.set_viewup(vector[, reset, render])	カメラのビューアップベクトルを設定します．
Plotter.show([title, window_size, ...])	プロットウィンドウを表示します．
Plotter.show_axes()	軸方向ウィジェットを表示します．
Plotter.show_axes_all()	すべてのレンダラで軸方向ウィジェットを表示します．
Plotter.show_bounds([mesh, bounds, ...])	境界軸を追加します．
Plotter.show_grid(**kwargs)	目盛線と境界軸のラベルを表示します．
Plotter.store_click_position(*args)	クリック位置をビューポート座標に保存します．
Plotter.store_mouse_position(*args)	マウスの位置を保存します．
Plotter.subplot(index_row[, index_column])	アクティブなサブプロットを設定します．
Plotter.track_click_position([callback, ...])	クリック位置を記録します．
Plotter.track_mouse_position()	マウスの位置を追跡します．
Plotter.unlink_views([views])	ビューのカメラをリンクを削除します．
Plotter.untrack_click_position([side])	クリック位置のトラッキングを停止します．
Plotter.untrack_mouse_position()	マウス位置のトラッキングを停止します．
Plotter.update([stime, force_redraw])	ウィンドウを更新し，再描画し，メッセージクエリを処理します．
Plotter.update_bounds_axes()	レンダーウィンドウの境界軸を更新します．
Plotter.update_coordinates(points[, mesh, ...])	プロッタのオブジェクトの点を更新します．
Plotter.update_scalar_bar_range(clim[, name])	アクティブなスカラーバーまたは名前付きスカラーバーの値の範囲を更新します．
Plotter.update_scalars(scalars[, mesh, render])	プロッタのオブジェクトのスカラー値を更新します．
Plotter.view_isometric([negative, render])	カメラを既定のアイソメビューにリセットします．
Plotter.view_vector(vector[, viewup, render])	指定したベクトルの方向にカメラを向けます．
Plotter.view_xy([negative, render])	XY平面を表示します．
Plotter.view_xz([negative, render])	XZ平面を表示します．
Plotter.view_yx([negative, render])	YX平面を表示します．
Plotter.view_yz([negative, render])	YZ平面を表示します．
Plotter.view_zx([negative, render])	ZX平面を表示します．
Plotter.view_zy([negative, render])	ZY平面を表示します．
Plotter.where_is(name)	指定されたアクターのサブプロット座標を返します．
Plotter.window_size_context([window_size])	孤立したコンテキストでレンダーウィンドウのサイズを設定します．
Plotter.write_frame()	動画ファイルに1つのフレームを書き込みます．
Plotter.zoom_camera(value)	カメラのズームとレンダリング．

アトリビュート

Plotter.actors	アクティブなレンダラーのアクターを返します．
Plotter.background_color	アクティブなレンダーウィンドウのバックグラウンドカラーを返します．
Plotter.bounds	アクティブなレンダラーの境界を返します．
Plotter.camera	アクティブなレンダラーのアクティブカメラを返します．
Plotter.camera_position	アクティブなレンダウィンドウのカメラ位置を返します．
Plotter.camera_set	アクティブなレンダラーのカメラが設定されている場合に返すか設定します．
Plotter.center	アクティブなレンダラーの中心を返します．
Plotter.click_position
Plotter.image	現在のレンダーウィンドウの画像配列を返します．
Plotter.image_depth	現在のレンダーウィンドウを表すDepth画像を返します．
Plotter.image_scale	スクリーンショットを保存する際のスケールファクターを取得または設定します．
Plotter.last_update_time
Plotter.legend	凡例アクター．
Plotter.length	シーンのバウンディングボックスの対角線の長さを返します．
Plotter.meshes	プロッターメッシュを返します．
Plotter.mouse_position
Plotter.parallel_projection	アクティブなレンダーウィンドウの平行投影状態を返すか設定します．
Plotter.parallel_scale	アクティブなレンダーウィンドウの平行スケールを返すか設定します．
Plotter.pickable_actors	選択可能なアクターを返す，または設定します．
Plotter.picked_actor	ピックしたメッシュを返します．
Plotter.picked_block_index	ピックしたブロックのインデックスを返します．
Plotter.picked_cell	ピックしたセルを返します．
Plotter.picked_cells	ピックしたセルを返します．
Plotter.picked_mesh	ピックしたメッシュを返します．
Plotter.picked_point	ピックした点を返します．
Plotter.render_window	このプロッタにアタッチされているvtkRenderWindowにアクセスします．
Plotter.renderer	アクティブなレンダラーを返します．
Plotter.scalar_bar	最初のスカラーバー．(後方互換性のために保持されています)．
Plotter.scalar_bars	スカラーバー．
Plotter.scale	アクティブなレンダラーのスケーリングを返します．
Plotter.shape	plotterの形を返します．
Plotter.suppress_rendering	レンダリング呼び出しを抑制するかどうかを取得または設定します．
Plotter.theme	このプロッタで使用するテーマを返すか設定します．
Plotter.window_size	レンダリングウィンドウのサイズを (width, height) で返します．