pyvista.core._validation.check.check_shape

目次

pyvista.core._validation.check.check_shape#

check_shape(
array: _ArrayLikeOrScalar[NumberType],
/,
shape: _ShapeLike | list[_ShapeLike],
*,
name: str = 'Array',
) → None[ソース]#

配列が指定された形状を持つかどうかをチェックします．

パラメータ:
arrayfloat | ArrayLike[float]

Number or array to check.

shapeShapeLike | list[ShapeLike]

単一の形状，または任意の形状のリスト．整数 i の場合，その形状は (i,) と解釈されます．例えば，Nx3の配列が許される場合は (-1,3) となります．スカラー値（0次元）の場合は () を使用します．リストの場合，配列は指定された形状の少なくとも1つを持たなければなりません．

namestr, default: "Array"

エラーメッセージが発生した場合に使用する変数名．

エラー処理:
ValueError

(複数の)配列に指定された形状のものがない場合．

参考

check_length
check_ndim

例

配列が一次元かどうかをチェックします．

>>> import numpy as np
>>> from pyvista import _validation
>>> _validation.check_shape([1, 2, 3], shape=(-1))

配列が一次元かスカラーかどうかをチェックします．

>>> _validation.check_shape(1, shape=[(), (-1)])

配列が3x3か4x4かをチェックします．

>>> _validation.check_shape(np.eye(3), shape=[(3, 3), (4, 4)])
目次