SciFiReaders.readers.microscopy.spm.stm.omicron_asc.AscReader

SciFiReaders.readers.microscopy.spm.stm.omicron_asc.AscReader#

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

Bases: Reader

Reads Scanning Tunnelling Spectroscopy (STS) data in .asc files obtained from Omicron STMs. These are actually compatible with Nanonis controllers for Omicron microscopes, It seems they are probably NOT compatible with matrix controller outputs. See the group discussion at https://groups.google.com/g/pycroscopy/c/d7lcGnlPFpo/m/UEysliC8CAAJ

TODO: At this point this AscReader does not appear to work for non-Z spec files. Needs to be fixed!

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, parm_encoding='utf-8')[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

  • parm_encoding (str, optional) – Codec to be used to decode the bytestrings into Python strings if needed. Default ‘utf-8’

Returns:

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

Return type:

List of sidpy.Dataset objects.

Contents