Skip to main content

Python library to read .mul and .flm files

Project description

Mulfile is a Python library for reading .mul and .flm files, acquired by the scanning tunneling microscopy (STM) software “SpecsProbe.exe”, which is used with the SPM 150 Aarhus by SPECS.

Installing

Installation via pip:

$ pip install mulfile

Example Usage

import mulfile as mul


# load a mul or flm file
stm_images = mul.load('path/to/mulfile.mul')

This returns all STM-images and their metadata as a list-like object. Thus, it is possible to access images by indexing and slicing.

# get the first STM-image
image_1 = stm_images[0]

# get images 1 to 5
images = stm_images[0:5]

Single STM-images are stored in objects with their image data (2D numpy array) and metadata as attributes.

# get the image data for image_1
image_1.img_data

# get the bias voltage for image_1
image_1.bias

It is also possible to save one or multiple images in the native file format of gwyddion (.gwy)

# save the complete mul-file as a gwyddion file
stm_images.save_gwy('output.gwy')

Status

STM-images, together with the corresponding metadata, are fully supported in both .mul and .flm files. Pointscans are not supported yet.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mulfile-0.4.0.tar.gz (6.4 kB view details)

Uploaded Source

Built Distribution

mulfile-0.4.0-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file mulfile-0.4.0.tar.gz.

File metadata

  • Download URL: mulfile-0.4.0.tar.gz
  • Upload date:
  • Size: 6.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.5 Darwin/23.6.0

File hashes

Hashes for mulfile-0.4.0.tar.gz
Algorithm Hash digest
SHA256 56a57c9be8c1aa15354f65df16ec5a4d1e7e01834942e496c978a685647a61f7
MD5 e7ddb822eed9d8c67c51be042941e858
BLAKE2b-256 43b0e98d2421277a4da56af3cbea4dd4576a951c0601420b229a44625ef1a724

See more details on using hashes here.

File details

Details for the file mulfile-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: mulfile-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 7.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.5 Darwin/23.6.0

File hashes

Hashes for mulfile-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 052913fc74f2ca28280a9b02166e5de90cbf4ba4c9630d76213b0826fd8b59cd
MD5 02de927cf869e1dbc08827524b847a22
BLAKE2b-256 516772ec43e5c112b0cc0b7b78c78c64675d2d37291682687c742f4afb4d2149

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page