SciFiReaders.readers.microscopy.spm.afm.wsxm.WSxM2DReader

SciFiReaders.readers.microscopy.spm.afm.wsxm.WSxM2DReader#

class SciFiReaders.readers.microscopy.spm.afm.wsxm.WSxM2DReader(file_path, *args, **kwargs)[source]#

Bases: Reader

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.

Parameters:

  • file_path (str) – Path to the input file to be read.

  • *args (tuple, optional) – Additional arguments to pass to the parent sidpy Reader class.

  • **kwargs (dict, optional) – Additional keyword arguments to pass to the parent sidpy Reader class.

read()[source]#

Extracts the data and metadata from the input 2D data file and returns it as a dictionary of sidpy.Dataset objects.

Methods

can_read

read

Reads and processes 2D WSxM files.
read()[source]#

Reads and processes 2D WSxM files. :returns:

A dictionary where keys are channel identifiers (“Channel_xxx”) and values are

sidpy.Dataset objects containing the extracted data and metadata.

Return type:

dict

Contents