vibrav.util.data_checking module

exception vibrav.util.data_checking.NaNValueFound[source]

Bases: Exception

exception vibrav.util.data_checking.SizeError[source]

Bases: Exception

vibrav.util.data_checking.check_size(data, size, var_name, dataframe=False)[source]

Simple method to check the size of the input array.

Parameters:

  • data (np.array or pd.DataFrame) – Data array to determine the size.

  • size (tuple) – Size expected.

  • var_name (str) – Name of the variable for printing in the error message.

Raises:

  • ValueError – If the given array does not have the shape given in the size parameter.

  • TypeError – If there are any not a number or null values in the array.