pyvista.core._validation.validate.validate_arrayNx3

pyvista.core._validation.validate.validate_arrayNx3#

validate_arrayNx3(
arr: VectorLike[float] | MatrixLike[float],
/,
*,
reshape: bool = True,
**kwargs,
)[ソース]#

配列が数値で Nx3 の形状であることを検証します．

配列は，入力値を確認するためにチェックされます:

  • は (N, 3) の形状を持つか， (N, 3) に整形することができます．

  • 数値

返される配列はその値が以下となるようにフォーマットされます:

  • (N, 3) の形をしています．

パラメータ:
arrVectorLike[float] | MatrixLike[float]

検証する配列．

reshapebool, default: True

もし True ならば，3つの要素を持つ1次元配列は有効な入力とみなされ，出力が2次元であることを保証するために (1, 3) に整形されます．

**kwargsdict, optional

validate_array() に渡す追加のキーワード引数です．

戻り値:
np.ndarray

(N, 3) の形状を持つ有効な配列．

参考

validate_arrayN

一次元配列の同様な関数 ．

validate_array

汎用的な配列検証関数．

例

Nx3の配列を検証します．

>>> from pyvista import _validation
>>> _validation.validate_arrayNx3(((1, 2, 3), (4, 5, 6)))
array([[1, 2, 3],
       [4, 5, 6]])

1次元の3要素配列は自動的に2Dに変形されます．

>>> _validation.validate_arrayNx3([1, 2, 3])
array([[1, 2, 3]])

制約を追加します．

>>> _validation.validate_arrayNx3(
...     ((1, 2, 3), (4, 5, 6)), must_be_in_range=[0, 10]
... )
array([[1, 2, 3],
       [4, 5, 6]])
目次