{"name":"brainglobe-napari-io","display_name":"brainglobe-napari-io","visibility":"public","icon":"","categories":[],"schema_version":"0.1.0","on_activate":null,"on_deactivate":null,"contributions":{"commands":[{"id":"brainglobe-napari-io.brainreg_read_dir","title":"Brainreg Read Directory","python_name":"brainglobe_napari_io.brainreg.reader_dir:brainreg_read_dir","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"brainglobe-napari-io.brainreg_read_dir_atlas_space","title":"Brainreg Read Directory Atlas Space","python_name":"brainglobe_napari_io.brainreg.reader_dir_atlas_space:brainreg_read_dir_atlas_space","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"brainglobe-napari-io.cellfinder_read_dir","title":"Cellfinder Read Directory","python_name":"brainglobe_napari_io.cellfinder.reader_dir:cellfinder_read_dir","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"brainglobe-napari-io.cellfinder_read_xml","title":"Cellfinder Read XML","python_name":"brainglobe_napari_io.cellfinder.reader_xml:cellfinder_read_xml","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"brainglobe-napari-io.cellfinder_write_multiple_xml","title":"Write Points","python_name":"brainglobe_napari_io.cellfinder.writer_xml:write_multiple_points_to_xml","short_title":null,"category":null,"icon":null,"enablement":null}],"readers":[{"command":"brainglobe-napari-io.brainreg_read_dir","filename_patterns":["*.tiff"],"accepts_directories":true},{"command":"brainglobe-napari-io.brainreg_read_dir_atlas_space","filename_patterns":["*.tiff"],"accepts_directories":true},{"command":"brainglobe-napari-io.cellfinder_read_dir","filename_patterns":["*.tif"],"accepts_directories":true},{"command":"brainglobe-napari-io.cellfinder_read_xml","filename_patterns":["*.xml"],"accepts_directories":false}],"writers":[{"command":"brainglobe-napari-io.cellfinder_write_multiple_xml","layer_types":["points+"],"filename_extensions":[".xml"],"display_name":"multiple_points"}],"widgets":null,"sample_data":null,"themes":null,"menus":{},"submenus":null,"keybindings":null,"configuration":[]},"package_metadata":{"metadata_version":"2.1","name":"brainglobe-napari-io","version":"0.3.0","dynamic":null,"platform":null,"supported_platform":null,"summary":"Read and write files from the BrainGlobe neuroanatomy suite","description":"# napari-brainglobe-io\n\n[![License](https://img.shields.io/pypi/l/brainglobe-napari-io.svg?color=green)](https://github.com/brainglobe/brainglobe-napari-io/blob/main/LICENSE)\n[![PyPI](https://img.shields.io/pypi/v/brainglobe-napari-io.svg?color=green)](https://pypi.org/project/brainglobe-napari-io)\n[![Python Version](https://img.shields.io/pypi/pyversions/brainglobe-napari-io.svg?color=green)](https://python.org)\n[![tests](https://github.com/brainglobe/brainglobe-napari-io/workflows/tests/badge.svg)](https://github.com/brainglobe/brainglobe-napari-io/actions)\n[![codecov](https://codecov.io/gh/brainglobe/brainglobe-napari-io/branch/master/graph/badge.svg)](https://codecov.io/gh/brainglobe/brainglobe-napari-io)\n\nVisualise cellfinder and brainreg results with napari\n\n\n----------------------------------\n\n\n## Installation\nThis package is likely already installed\n(e.g. with cellfinder, brainreg or another napari plugin), but if you want to\ninstall it again, either use the napari plugin install GUI or you can\ninstall `brainglobe-napari-io` via [pip]:\n\n pip install brainglobe-napari-io\n\n## Usage\n* Open napari (however you normally do it, but typically just type `napari` into your terminal, or click on your desktop icon)\n\n### brainreg\n#### Sample space\nDrag your [brainreg](https://github.com/brainglobe/brainreg) output directory (the one with the log file) onto the napari window.\n\nVarious images should then open, including:\n* `Registered image` - the image used for registration, downsampled to atlas resolution\n* `atlas_name` - e.g. `allen_mouse_25um` the atlas labels, warped to your sample brain\n* `Boundaries` - the boundaries of the atlas regions\n\nIf you downsampled additional channels, these will also be loaded.\n\nMost of these images will not be visible by default. Click the little eye icon to toggle visibility.\n\n_N.B. If you use a high resolution atlas (such as `allen_mouse_10um`), then the files can take a little while to load._\n\n![sample_space](https://raw.githubusercontent.com/brainglobe/brainglobe-napari-io/master/resources/sample_space.gif)\n\n\n#### Atlas space\n`napari-brainreg` also comes with an additional plugin, for visualising your data\nin atlas space.\n\nThis is typically only used in other software, but you can enable it yourself:\n* Open napari\n* Navigate to `Plugins` -> `Plugin Call Order`\n* In the `Plugin Sorter` window, select `napari_get_reader` from the `select hook...` dropdown box\n* Drag `brainreg_read_dir_atlas_space` (the atlas space viewer plugin) above `brainreg_read_dir` (the normal plugin) to ensure that the atlas space plugin is used preferentially.\n\n\n### cellfinder\n#### Load cellfinder XML file\n* Load your raw data (drag and drop the data directories into napari, one at a time)\n* Drag and drop your cellfinder XML file (e.g. `cell_classification.xml`) into napari.\n\n#### Load cellfinder directory\n* Load your raw data (drag and drop the data directories into napari, one at a time)\n* Drag and drop your cellfinder output directory into napari.\n\nThe plugin will then load your detected cells (in yellow) and the rejected cell\ncandidates (in blue). If you carried out registration, then these results will be\noverlaid (similarly to the loading brainreg data, but transformed to the\ncoordinate space of your raw data).\n\n![load_data](https://raw.githubusercontent.com/brainglobe/brainglobe-napari-io/master/resources/load_data.gif)\n**Loading raw data**\n\n![load_data](https://raw.githubusercontent.com/brainglobe/brainglobe-napari-io/master/resources/load_results.gif)\n**Loading cellfinder results**\n\n\n\n## Contributing\nPlease see the [developers guide](https://brainglobe.info/developers/index.html).\n\n## License\n\nDistributed under the terms of the [MIT] license,\n\"brainglobe-napari-io\" is free and open source software\n\n## Issues\n\nIf you encounter any problems, please [file an issue] along with a detailed description.\n\n[napari]: https://github.com/napari/napari\n[Cookiecutter]: https://github.com/audreyr/cookiecutter\n[@napari]: https://github.com/napari\n[MIT]: http://opensource.org/licenses/MIT\n[BSD-3]: http://opensource.org/licenses/BSD-3-Clause\n[GNU GPL v3.0]: http://www.gnu.org/licenses/gpl-3.0.txt\n[GNU LGPL v3.0]: http://www.gnu.org/licenses/lgpl-3.0.txt\n[Apache Software License 2.0]: http://www.apache.org/licenses/LICENSE-2.0\n[Mozilla Public License 2.0]: https://www.mozilla.org/media/MPL/2.0/index.txt\n[cookiecutter-napari-plugin]: https://github.com/napari/cookiecutter-napari-plugin\n[file an issue]: https://github.com/brainglobe/brainglobe-napari-io/issues\n[napari]: https://github.com/napari/napari\n[tox]: https://tox.readthedocs.io/en/latest/\n[pip]: https://pypi.org/project/pip/\n[PyPI]: https://pypi.org/\n","description_content_type":"text/markdown","keywords":null,"home_page":null,"download_url":null,"author":null,"author_email":"Adam Tyson ","maintainer":null,"maintainer_email":null,"license":"BSD-3-Clause","classifier":["Development Status :: 4 - Beta","Framework :: napari","Intended Audience :: Developers","Intended Audience :: Science/Research","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Topic :: Scientific/Engineering :: Image Recognition"],"requires_dist":["bg-atlasapi","bg-space","brainglobe-utils","napari","tifffile >=2020.8.13","numpy","pandas","black ; extra == 'dev'","pre-commit ; extra == 'dev'","pytest ; extra == 'dev'","pytest-cov ; extra == 'dev'"],"requires_python":">=3.8","requires_external":null,"project_url":["Homepage, https://brainglobe.info","Source Code, https://github.com/brainglobe/brainglobe-napari-io","Bug Tracker, https://github.com/brainglobe/brainglobe-napari-io/issues","Documentation, https://docs.brainglobe.info","User Support, https://forum.image.sc/tag/brainglobe","Twitter, https://twitter.com/brain_globe"],"provides_extra":["dev"],"provides_dist":null,"obsoletes_dist":null},"npe1_shim":false}