SciFiReaders.readers.microscopy.spm.stm.nanonis_base.load_array

Contents

SciFiReaders.readers.microscopy.spm.stm.nanonis_base.load_array#

SciFiReaders.readers.microscopy.spm.stm.nanonis_base.load_array(file, allow_pickle=True)[source]#

Wrapper to numpy.load method for binary files.

See numpy.load documentation for more details.

Parameters:
  • file (file or str) – The file to read. File-like objects must support the

  • the (seek() and read() methods. Pickled files require that)

  • well. (file-like object support the readline() method as)

  • allow_pickle (bool, optional) – Allow loading pickled object arrays stored in npy files. Reasons for disallowing pickles include security, as loading pickled data can execute arbitrary code. If pickles are disallowed, loading object arrays will fail. Default: True

Returns:

result – Data stored in the file. For .npz files, the returned instance of NpzFile class must be closed to avoid leaking file descriptors.

Return type:

array, tuple, dict, etc.