Skip to content

Commit 3131efc

Browse files
committed
Update README with .topostats documentation
1 parent 25041a2 commit 3131efc

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Supported file formats
2525
| `.ibw` | [WaveMetrics](https://www.wavemetrics.com/) |
2626
| `.spm` | [Bruker's Format](https://www.bruker.com/) |
2727
| `.jpk` | [Bruker](https://www.bruker.com/) |
28+
| `.topostats`| [TopoStats](https://github.com/AFM-SPM/TopoStats) |
2829

2930
Support for the following additional formats is planned. Some of these are already supported in TopoStats and are
3031
awaiting refactoring to move their functionality into AFMReader these are denoted in bold below.
@@ -41,6 +42,16 @@ awaiting refactoring to move their functionality into AFMReader these are denote
4142
If you wish to process AFM images supported by `AFMReader` it is recommend you use
4243
[TopoStats](https://github.com/AFM-SPM/TopoStats) to do so, however the library can be used on its own.
4344

45+
### .topostats
46+
47+
You can open `.topostats` files using the `load_topostats` function. Just pass in the path to the file.
48+
49+
```python
50+
from AFMReader.topostats import load_topostats
51+
52+
image, pixel_to_nanometre_scaling_factor, metadata = load_topostats(file_path="./my_topostats_file.topostats")
53+
```
54+
4455
### .spm
4556

4657
You can open `.spm` files using the `load_spm` function. Just pass in the path to the file and the

0 commit comments

Comments
 (0)