/napari-hsafm-browser

a napari plugin for viewing high-speed AFM movies

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

napari-hsafm-browser

License PyPI Python Version tests codecov napari hub

napari plugin for viewing high-speed AFM movies


This napari plugin was generated with Cookiecutter using @napari's cookiecutter-napari-plugin template.

Installation

After download the plugin code and change to the plugin directory napari-hsafm-browser/, you can install napari-hsafm-browser via the command:

    pip install -e .

Usage

This plugin is used for reading and viewing high-speed AFM .asd files in vim style.

First, open the directory which contains .asd files as the work directory. All .asd files in the work directory will be listed.

When one of the .asd files is selected, the corresponding movie will show up in the viewer window and the meta data will show up in the side bar.

The movie or frame will be saved in tiff format in the directory named by the value of save to when the key y or <Shift-z> are pressed. If no name is provided, the default directory name imagej-tiff will be used.

key map

j: move to the next .asd file

k: move to the previous .asd file

l: step one slice of the movie forward

h: step one slice of the movie backward

w: step 10% slices of the movie forward

b: step 10% slices of the movie backward

d: move to the next 25% .asd file

u: move to the previous 25% .asd file

^: go to the begining of the movie

$: go to the end of the movie

x: delete the current slice

<Space>: toggle play

]: double the fps (max: 160)

[: half the fps (min: 10)

y: save the current frame of the movie into a tiff file

<Shift-z>: copy the current .asd file to save_dir

<Alt-c>: reset contrast limit according to the current frame

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

License

Distributed under the terms of the BSD-3 license, "napari-hsafm-browser" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

To do

  1. continuous h and l keybinding functions.
  2. visual selection & sliderbar
  3. ignore .filename generated in MacOS