pyvista.Plotter.screenshot

pyvista.Plotter.screenshot#

Plotter.screenshot(
filename: str | Path | BytesIO | bool | None = None,
transparent_background: bool | None = None,
return_img: bool = True,
window_size: Sequence[int] | None = None,
scale: int | None = None,
) → pyvista_ndarray | None[ソース]#

現在のカメラ位置でスクリーンショットを撮ります．

パラメータ:
filenamestr | Path | io.BytesIO, optional

イメージを書き込む場所．Noneの場合，イメージは書き込まれません．

transparent_backgroundbool, optional

背景を透明にするかどうかを指定します．既定値は，プロッタのテーマで検索されます．

return_imgbool, default: True

True の場合，イメージの numpy.ndarray が返されます．

window_sizesequence[int], optional

スクリーンショットを撮る前に，プロッタのサイズをこの (width, height) に設定します．

scaleint, optional

高解像度の画像を作成するために，ウィンドウサイズをスケールするための係数を設定します．もし None ならば，このプロッタの image_scale プロパティを使用します，デフォルトは1です．

戻り値:
pyvista.pyvista_ndarray

ピクセルRGBと，アルファを含む配列．サイズ:

  • [ウィンドウの高さxウィンドウの幅x3] transparent_background が False に設定されている場合．

  • [ウィンドウの高さxウィンドウの幅x4] transparent_background が True に設定されている場合．

参考

スクリーンショットを保存する

例

>>> import pyvista as pv
>>> sphere = pv.Sphere()
>>> plotter = pv.Plotter(off_screen=True)
>>> actor = plotter.add_mesh(sphere)
>>> plotter.screenshot('screenshot.png')
目次