pyvista.core._validation.validate.validate_arrayN

pyvista.core._validation.validate.validate_arrayN#

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

数値の1次元配列を検証します．

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

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

  • 数値

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

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

パラメータ:
arrVectorLike[float]

検証する配列．

reshapebool, default: True

もし True ならば，0次元のスカラーは (1,) に整形され，形状 (1, N) の2次元のベクトルは (1, N) に整形されます．そうでない場合，スカラーと2次元の入力はすべて無効とみなされます．

**kwargsdict, optional

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

戻り値:
np.ndarray

検証済みの1次元配列．

参考

validate_arrayN_unsigned

非負整数配列の同様な関数 ．

validate_array

汎用的な配列検証関数．

例

4つの要素を持つ1次元配列を検証します．

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

スカラー0次元の値は，自動的に1次元に整形されます．

>>> _validation.validate_arrayN(42.0)
array([42.0])

最初の次元が単一である2D配列は，自動的に1Dに整形されます．

>>> _validation.validate_arrayN([[1, 2]])
array([1, 2])

必要に応じて制約を追加します．

>>> _validation.validate_arrayN((1, 2, 3), must_have_length=3)
array([1, 2, 3])
目次