httomolibgpu.misc.supp_func

Contents

httomolibgpu.misc.supp_func#

This is a collection of supplementary functions (utils) to perform various data checks

httomolibgpu.misc.supp_func.data_checker(data: <cp.ndarray>, verbosity: bool = True, method_name: str | None = None) → bool[source]#

Function that performs the variety of checks on input data, in some cases also correct the data and prints warnings. Currently it checks for: the presence of infs and nans in data.

Parameters:

  • data (xp.ndarray) – Input CuPy or Numpy array either float32 or uint16 data type.

  • verbosity (bool) – If enabled, then the printing of the warning happens when data contains infs or nans.

  • method_name (str, optional.) – Method’s name for which input data is tested.

Returns:

Returns corrected or not data array.

Return type:

cp.ndarray

Contents