SciFiReaders.readers.microscopy.spm.stm.nanonis_dat.NanonisDatReader

class SciFiReaders.readers.microscopy.spm.stm.nanonis_dat.NanonisDatReader(file_path, *args, **kwargs)[source]

Bases: sidpy.sid.reader.Reader

Reads files obtained via Nanonis controllers in .dat files. These are generally point spectroscopy measurements.

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 .asc extension

read

Reads the file given in file_path into a sidpy dataset

can_read()[source]

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

read(verbose=False)[source]

Reads the file given in file_path into a sidpy dataset

Parameters

verbose (Boolean (Optional)) – Whether or not to show print statements for debugging

Returns

sidpy.Dataset – Multi-channel inputs are separated into individual dataset objects

Return type

List of sidpy.Dataset objects.