Convert .plux files to image formats and compute surface heterogeneity metrics.
Project description
PLUXTools
PLUXTools – A utility for converting .plux surface metrology archives and calculating quantitative heterogeneity metrics
A Python-based module for automated conversion of Sensofar .plux topography data into usable image formats (PNG and TIFF), followed by optional surface texture analysis using image-derived metrics.
- Basic usage
- Heterogeneity metrics
- Installation instructions
- Dependencies
- Output and structure
- Notes
- License
Basic usage
PLUXTools supports .plux files containing metrology information and structured surface maps. It extracts the core data using index.xml and .raw layers, and converts it into common image formats for downstream analysis or publication.
Conversion only
python -m pluxtools.convert [input_file.plux]
This will:
- Extract the .plux archive
- Parse image dimensions from
index.xml - Convert the raw topography (
LAYER_0_stack.raw) to.pngand.tiffformats
Heterogeneity metrics
PLUXTools can calculate basic surface texture metrics from extracted images. These metrics provide a summary of spatial heterogeneity and surface roughness. Metrics calculated
- Laplacian Variance – measure of surface sharpness and detail
- Shannon Entropy – texture randomness and complexity
- Sobel Mean Gradient – average spatial edge strength
Metric calculation usage
python -m pluxtools.metrics [directory_of_images]
All supported image formats in the specified directory will be processed, including: .png, .jpg, .jpeg, .tif, and .tiff
Example output
| filename | laplacian_variance | entropy | sobel_mean |
|---|---|---|---|
| sample_1.png | 54.23 | 6.22 | 0.0452 |
| sample_2.tiff | 48.14 | 6.12 | 0.0385 |
Installation instructions
We recommend using a virtual environment.
Install via PyPI
pip3 install pluxtools
Install from source
git clone https://github.com/yourgroup/pluxtools.git
cd pluxtools
pip install -e .
Dependencies
PLUXTools requires the following packages:
numpypillowopencv-pythonscikit-imagepandastqdm
Output and structure
All converted image files are saved to the same directory as the input .plux archive. Metric outputs are saved as a single .csv file summarising calculated features per image.
Notes
.pluxfiles are ZIP-compressed archives with metadata and binary topography data- Image dimensions are parsed from
index.xml - Bit depth and format are inferred from the size of the
.rawfile - Only
LAYER_0_stack.rawis processed - No manual configuration of dimensions is required
License
MIT License © DrATedder 2025
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pluxtools-0.1.0.tar.gz.
File metadata
- Download URL: pluxtools-0.1.0.tar.gz
- Upload date:
- Size: 4.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
82e82118142d75da4e7ea03f978e0c70c79bc71a536fcc8c4138e84cbbf2a7bf
|
|
| MD5 |
877be421cc9401c1a8f979baeff6ba79
|
|
| BLAKE2b-256 |
a1a85dcc870cbd73b51b04591eab7b131d1b1b79ecf7fd2d1722805e68bf1cd7
|
File details
Details for the file pluxtools-0.1.0-py3-none-any.whl.
File metadata
- Download URL: pluxtools-0.1.0-py3-none-any.whl
- Upload date:
- Size: 4.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
61b6160bb4600446715851e62f0f9fd0b975d0bccb2546fa4c043187e828d5ed
|
|
| MD5 |
56429123c272bb444dc3031fcc4f91ad
|
|
| BLAKE2b-256 |
a045efcd085421e5fff1d2cc6d737c0fa591612255962c9c2fdaddf6246947e3
|