SciFiReaders.readers.microscopy.spm.stm.nanonis_sxm.NanonisSXMReader

SciFiReaders.readers.microscopy.spm.stm.nanonis_sxm.NanonisSXMReader#

class SciFiReaders.readers.microscopy.spm.stm.nanonis_sxm.NanonisSXMReader(file_path, *args, **kwargs)[source]#

Bases: Reader

Parameters:

file_path (str) – Path to the file that needs to be read

self._input_file_path#

Path to the file that will be read

Type:

str

Notes

  • This method will check to make sure that the provided file_path is indeed a string and a valid file path.

  • Consider calling can_read() within __init__() for validating the provided file

Raises:

FileNotFoundError –

Methods

can_read

Tests whether or not the provided file has a .dm3 extension

read

Reads data from .sxm files into sidpy.Dataset objects Note that multiple channels are treated as separate dataset objects, Thus returning a list of length N where N is the number of channels.

can_read()[source]#

Tests whether or not the provided file has a .dm3 extension

read()[source]#

Reads data from .sxm files into sidpy.Dataset objects Note that multiple channels are treated as separate dataset objects, Thus returning a list of length N where N is the number of channels.

Returns:

dataset_list

Return type:

(list) of sidpy.Dataset objects