Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop #1

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,20 @@ const result = library(args);
// result is ...
```

## Findings

I found multiple sources of knowledge about this file format, but not enough to use the data that we have.

[ForceVolume AFM Format](https://www.nanophys.kth.se/nanolab/afm/icon/bruker-help/Content/ForceVolume/ForceVolImgFileFormat.htm) Gives some information about the header for version 0x41XXXXXX

[Nanoscope repository](https://github.com/jmarini/nanoscope) Python implementation for versions 0x05120130 and 0x09300201 only

[pySPM repository](https://github.com/scholi/pySPM) Python implementation of multiple file format parsers, needed some tinkering to work with our data and still didn't provide acceptable results

[afmr repository](https://github.com/will-r-chase/afmr/) R implementation for AFM maps, didn't look too much into it because it didn't seem relevant

[Prof. Srin Manne's AFM lab](http://www.physics.arizona.edu/~smanne/DI/software/v43header.html) Provides informations as to how the data should be parsed, the most useful source so far

## [API Documentation](https://image-js.github.io/bruker-afm/)

## License
Expand Down
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,9 @@
"jest": "^28.1.3",
"prettier": "^2.7.1",
"rollup": "^2.77.0"
},
"dependencies": {
"image-js": "^0.35.0",
"iobuffer": "^5.1.0"
}
}
Loading