SciFiReaders.readers.microscopy.spm.afm.wsxm

Author: Pranav Sudersan Date: February 2025

This module provides classes and functions for reading and processing WSxM/Nanotec AFM controller files. It includes SID readers for 1D, 2D, and 3D data formats as three separate classes:

Classes:

WSxM2DReader(Reader)

A reader class for extracting 2D WSxM data and metadata (e.g., topography, phase, adhesion, etc.) and converting them into a dictionary of SID Dataset objects for all channels and directions of the measurement.

WSxM1DReader(Reader)

A reader class for extracting 1D WSxM data and metadata (e.g., force spectroscopy, tune, etc.) and converting them into a dictionary of SID Dataset objects for all channels and directions of the measurement.

WSxM3DReader(Reader)

A reader class for extracting 3D WSxM data and metadata (e.g., force volume, video, etc.) and converting them into a dictionary of SID Dataset objects for all channels and directions of the measurement.

WSxMFuncs

A class containing optional static methods to directly read WSxM files, including reading headers, image data, and spectroscopy curves without the SID format. These methods are used by the above WSxM reader classes but can also be used independently for reading WSxM files, and they offer additional input parameters.

Usage:

To use the readers, instantiate the appropriate reader class with the file path and call the read method to extract the data and metadata.

Example:

data_file_path = ‘/path/to/wsxm/file’ reader = WSxM2DReader(data_file_path) data = reader.read() for channel, dataset in data.items():

print(channel, dataset.quantity, dataset.direction) dataset.plot()

Classes

WSxM1DReader	A reader class for extracting 1 dimensional WSxM data and metadata (e.g. force spectroscopy, tune etc) and converting them into a dictionary of SID Dataset objects for all channels and directions of the measurement.
WSxM2DReader	A reader class for extracting 2 dimensional WSxM data and metadata (e.g. topography, phase, adhesion etc) and converting them into a dictionary of SID Dataset objects for all channels and directions of the measurement.
WSxM3DReader	A reader class for extracting 3 dimensional WSxM data and metadata (e.g. Force volume, video etc) and converting them into a dictionary of SID Dataset objects for all channels and directions of the measurement.
WSxMFuncs	A class containing static methods for handling WSxM files, including reading headers, image data, and spectroscopy curves.