io

Functions for reading and writing data.

topostats.io.load_scan(img_path: Union[str, pathlib.Path]) pySPM.Bruker.Bruker[source]

Load the image from file.

Parameters

img_path (Union[str, Path]) – Path to image that needs loading.

Return type

Bruker

Examples

FIXME: Add docs.

topostats.io.read_yaml(filename: Union[str, pathlib.Path]) Dict[source]

Read a YAML file.

Parameters

filename (Union[str, Path]) – YAML file to read.

Returns

Dictionary of the file.

Return type

Dict