nan_report_with_input

caf.toolkit.math_utils.nan_report_with_input(array, input_dict)

Create a report of NaN values in relative matrix locations.

Uses an input array (usually the result of a calculation) to find the locations of all np.NaN values. Once found, the index of these values are found in the input_dict arrays. These values are then used to generate a report.

Parameters:

• array (ndarray) – The array to find the NaN values in.

• input_dict (dict[str, ndarray]) – A dictionary of arrays of the same shape as array. The keys are the names to define each input, and the values the array.

Returns:

A pandas DataFrame reporting where the np.NaN values are. Will have a column named “axis_{i}” for each axis in array. Will also have additional columns named “output” (for array values) and one named after each key in input_dict for the corresponding array values.

Return type:

report