2.2.38. czekitout.convert.to_real_numpy_array_3d

to_real_numpy_array_3d(obj, obj_name)

Convert input object to a real-valued 3D numpy array.

If the input object is not a real-valued 3D matrix, then a TypeError exception is raised with the message:

The object ``<obj_name>`` must be real-valued 3D matrix.

where <obj_name> is replaced by the contents of the string obj_name.

Parameters:

objany type

Input object.

obj_namestr

Name of the input object.

Returns:

resultnumpy.ndarray

The object resulting from the conversion.