pyvista.core._validation.validate.validate_data_range

pyvista.core._validation.validate.validate_data_range#

validate_data_range(rng: VectorLike[float], /, **kwargs)[ソース]#

データ範囲を検証します．

デフォルトでは，以下を確実にするためにデータ範囲がチェックされます:

  • 2つの値がある

  • 実数である

  • 下限境界は上限境界を超えない

パラメータ:
rngVectorLike[float]

(lower_bound, upper_bound) 形式で検証する範囲．

**kwargsdict, optional

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

戻り値:
tuple

(lower_bound, upper_bound) 形式で検証範囲．

参考

validate_array

汎用的な配列検証関数．

例

データ範囲を検証します．

>>> from pyvista import _validation
>>> _validation.validate_data_range([-5, 5])
(-5, 5)

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

>>> _validation.validate_data_range([0, 1.0], must_be_nonnegative=True)
(0.0, 1.0)
目次