biosspheres.utils.validation.inputs

Functions

big_l_validation(big_l, name)	To check if big_l (named name) represents the degree of a spherical harmonic.
bool_validation(b, name)
dimensions_array_validation(array, name, dim)	To check if array (named name) is a numpy array of one dimension.
disjoint_spheres_validation(radii, ...)	Checks that the spheres are pairwise disjoint, so neither overlapping, touching nor nested (e.g. concentric).
finite_values_in_array(array, name)	To check if array (named name) has only finite values.
float_array_validation(array, name)	To check if array (named name) is a numpy array of floats.
float_validation(fl, name)	To check if fl (named name) is a float type.
full_float_array_validation(array, name, dim)	To check if array (named name) is a dimD array with finite and real values.
integer_validation(integer, name)	To check if integer (named name) is an integer type.
is_scipy_linear_op(linear_op, name)	Checks if the provided object is a scipy linear operator.
is_scipy_sparse_array(array, name)	Checks if the provided object is a scipy sparse array.
n_validation(n, name)	Checks if n (named name) is a positive integer
numpy_array_validation(array, name)	To check if array (named name) is a numpy array.
one_dimensional_array_length_check(array, ...)
pi_validation(pi, name)	Checks if pi is a float different from 0
pii_validation(pii, name)	Extension of pii_validation for an array of 1D
radii_validation(radii, name)	Extension of radius_validation for an array of 1D
radius_validation(r, name)	Checks if r is a positive float
same_shape_check(array1, name1, array2, name2)	Checks if the provided arrays are of the same shape
same_type_check(array1, name1, array2, name2)	Checks if the provided arrays are of the same type
square_array_check(array, name)	Checks if the provided array is a square array
trigonometric_arrays_validation(array, name, dim)	To check if array (named name) is an array that corresponds with a trigonometric function bounded between -1 and 1.
two_dimensional_array_check(array, name)	All checks for a two-dimensional array.

biosspheres.utils.validation.inputs.big_l_validation(big_l: int, name: str) → None

To check if big_l (named name) represents the degree of a spherical harmonic.

biosspheres.utils.validation.inputs.dimensions_array_validation(array: ndarray, name: str, dim: int) → None

To check if array (named name) is a numpy array of one dimension.

biosspheres.utils.validation.inputs.disjoint_spheres_validation(radii: ndarray, center_positions: list, name: str) → None

Checks that the spheres are pairwise disjoint, so neither overlapping, touching nor nested (e.g. concentric).

biosspheres.utils.validation.inputs.finite_values_in_array(array: ndarray, name: str) → None

To check if array (named name) has only finite values.

biosspheres.utils.validation.inputs.float_array_validation(array: ndarray, name: str) → None

To check if array (named name) is a numpy array of floats. It assumes that array is a numpy array.

biosspheres.utils.validation.inputs.float_validation(fl: float, name: str) → None

To check if fl (named name) is a float type.

biosspheres.utils.validation.inputs.full_float_array_validation(array: ndarray, name: str, dim: int) → None

To check if array (named name) is a dimD array with finite and real values.

biosspheres.utils.validation.inputs.integer_validation(integer: int, name: str) → None

To check if integer (named name) is an integer type.

biosspheres.utils.validation.inputs.is_scipy_linear_op(linear_op: LinearOperator, name: str) → None

Checks if the provided object is a scipy linear operator.

biosspheres.utils.validation.inputs.is_scipy_sparse_array(array: sparray, name: str) → None

Checks if the provided object is a scipy sparse array.

biosspheres.utils.validation.inputs.n_validation(n: int, name: str) → None

Checks if n (named name) is a positive integer

biosspheres.utils.validation.inputs.numpy_array_validation(array: ndarray, name: str) → None

To check if array (named name) is a numpy array.

biosspheres.utils.validation.inputs.pi_validation(pi: float, name: str) → None

Checks if pi is a float different from 0

biosspheres.utils.validation.inputs.pii_validation(pii: ndarray, name: str) → None

Extension of pii_validation for an array of 1D

biosspheres.utils.validation.inputs.radii_validation(radii: ndarray, name: str) → None

Extension of radius_validation for an array of 1D

biosspheres.utils.validation.inputs.radius_validation(r: float, name: str) → None

Checks if r is a positive float

biosspheres.utils.validation.inputs.same_shape_check(array1: ndarray, name1: str, array2: ndarray, name2: str) → None

Checks if the provided arrays are of the same shape

biosspheres.utils.validation.inputs.same_type_check(array1: ndarray, name1: str, array2: ndarray, name2: str) → None

Checks if the provided arrays are of the same type

biosspheres.utils.validation.inputs.square_array_check(array: ndarray, name: str) → None

Checks if the provided array is a square array

biosspheres.utils.validation.inputs.trigonometric_arrays_validation(array: ndarray, name: str, dim: int) → None

To check if array (named name) is an array that corresponds with a trigonometric function bounded between -1 and 1.

biosspheres.utils.validation.inputs.two_dimensional_array_check(array: ndarray, name: str) → None

All checks for a two-dimensional array.