SciFiReaders.readers.microscopy.spm.afm.bruker_nano.BrukerAFMReader

SciFiReaders.readers.microscopy.spm.afm.bruker_nano.BrukerAFMReader#

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

Bases: Reader

Extracts data and metadata from Bruker AFM (.nnn) files containing images or force curves where n is an integer

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 suitable extension :rtype: not used for now...

read

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

Tests whether or not the provided file has a suitable extension :rtype: not used for now…

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 sidpy dataset objects

Return type:

List of sidpy.Dataset objects.

Contents