pyvista.core._validation.validate.validate_array3

pyvista.core._validation.validate.validate_array3#

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

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

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

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

  • 数値で実数．

返される配列は (3,) の形になるようにフォーマットされます．

パラメータ:
arrfloat | VectorLike[float] | MatrixLike[float]

検証する配列．

reshapebool, default: True

もし True ならば， (1, 3) 形状の2次元ベクトルは有効な入力とみなされ，出力が一貫して1次元であることを保証するために (3,) に整形されます．

broadcastbool, default: False

もし True ならば，スカラー値や1つの要素を持つ1次元配列は有効な入力とみなされ，1つの値は長さ3の配列にブロードキャストされます．

**kwargsdict, optional

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

戻り値:
np.ndarray

3つの要素を持つ有効な数値の1次元配列．

参考

validate_number

単一の数字の同じような関数 ．

validate_arrayN

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

validate_array

汎用的な配列検証関数．

例

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

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

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

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

スカラー0次元値は，3要素の1次元配列として自動的にブロードキャストされます．

>>> _validation.validate_array3(42.0, broadcast=True)
array([42.0, 42.0, 42.0])

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

>>> _validation.validate_array3((1, 2, 3), must_be_nonnegative=True)
array([1, 2, 3])
目次