SciFiReaders.readers.microscopy.spm.afm.gwyddion.GwyddionReader

SciFiReaders.readers.microscopy.spm.afm.gwyddion.GwyddionReader#

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

Bases: Reader

Extracts data and metadata from Igor Binary Wave (.ibw) files containing images or force curves

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

gsf_read

Read a Gwyddion Simple Field 1.0 file format http://gwyddion.net/documentation/user-guide-en/gsf.html

gwy_read

read

Reads the file given in file_path into a sidpy dataset
gsf_read()[source]#

Read a Gwyddion Simple Field 1.0 file format http://gwyddion.net/documentation/user-guide-en/gsf.html

Parameters:

file_name (string) – path to the file

Returns:

  • metadata (dict)) – Additional metadata to be included in the file

  • data (numpy.ndarray) – An arbitrarily sized 2D array of arbitrary numeric type

gwy_read()[source]#
Parameters:

  • file_path

  • meas_grp

  • - (For more information on the .gwy file format visit the link below)

  • http (//gwyddion.net/documentation/user-guide-en/gwyfile-format.html)

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

Returns:

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

Return type:

List of sidpy.Dataset objects.

Contents