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

Update docstring for load_topostats.py #81

Open
ns-rse opened this issue Dec 2, 2024 · 0 comments
Open

Update docstring for load_topostats.py #81

ns-rse opened this issue Dec 2, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation v0.0.4

Comments

@ns-rse
Copy link
Collaborator

ns-rse commented Dec 2, 2024

The Returns and Example
for load_toposats.py do not reflect what is returned by the function which is image, pixel_to_nm_scaling, data.

I.e. the data is not included.

This looks like a change in the .topostats file specification and the way things are structured perhaps and has had a knock-on effect when working on Expand usage of AFMReader for all file formats.... The changes are in refactor(io): Load .spm with AFMReader but as of writing the tests/test_run_modules.py::test_run_topostats_process_all() and tests/test_run_modules.py::test_run_topostats_process_debug() are failing because process_scan() is now being passed a np.ndarray() rather than the expected dictionary.

What should be returned, image, pixel_to_nm_scaling or should it it include data? 🤔

@ns-rse ns-rse added documentation Improvements or additions to documentation v0.0.4 labels Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v0.0.4
Projects
None yet
Development

No branches or pull requests

1 participant