{"name":"napari-multi-channel-surface","display_name":"Multi Channel Surface","visibility":"public","icon":"","categories":[],"schema_version":"0.2.1","on_activate":null,"on_deactivate":null,"contributions":{"commands":[{"id":"napari-multi-channel-surface.get_reader","title":"Open data with Multi Channel Surface","python_name":"napari_multi_channel_surface._reader:napari_get_reader","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"napari-multi-channel-surface.write_multiple","title":"Save multi-layer data with Multi Channel Surface","python_name":"napari_multi_channel_surface._writer:write_multiple","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"napari-multi-channel-surface.write_single_surface","title":"Save image data with Multi Channel Surface","python_name":"napari_multi_channel_surface._writer:write_single_surface","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"napari-multi-channel-surface.stanford_bunny","title":"Load sample data from Multi Channel Surface","python_name":"napari_multi_channel_surface._sample_data:stanford_bunny","short_title":null,"category":null,"icon":null,"enablement":null},{"id":"napari-multi-channel-surface.make_container_widget","title":"Make Surface Channel Change widget","python_name":"napari_multi_channel_surface:SurfaceChannelChange","short_title":null,"category":null,"icon":null,"enablement":null}],"readers":[{"command":"napari-multi-channel-surface.get_reader","filename_patterns":["*.ply","*.vtk","*.vtu","*.xdmf","*.xmf","*.h5m","*.avs","*.hmf","*.med","*.dat","*.tec"],"accepts_directories":false}],"writers":[{"command":"napari-multi-channel-surface.write_multiple","layer_types":["surface*"],"filename_extensions":[],"display_name":""},{"command":"napari-multi-channel-surface.write_single_surface","layer_types":["surface"],"filename_extensions":[".ply",".vtk",".vtu",".xdmf",".xmf",".h5m",".avs",".hmf",".med",".dat",".tec"],"display_name":""}],"widgets":[{"command":"napari-multi-channel-surface.make_container_widget","display_name":"Channel Select","autogenerate":false}],"sample_data":[{"command":"napari-multi-channel-surface.stanford_bunny","key":"napari-multi-channel-surface.data.stanford_bunny","display_name":"Bunny xyz"}],"themes":null,"menus":{},"submenus":null,"keybindings":null,"configuration":[]},"package_metadata":{"metadata_version":"2.4","name":"napari-multi-channel-surface","version":"0.0.3","dynamic":["license-file"],"platform":null,"supported_platform":null,"summary":"A simple plugin to enable easy interaction with multi-channel surfaces","description":"# napari-multi-channel-surface\n\n[![License MIT](https://img.shields.io/pypi/l/napari-multi-channel-surface.svg?color=green)](https://github.com/judithlutton/napari-multi-channel-surface/raw/main/LICENSE)\n[![PyPI](https://img.shields.io/pypi/v/napari-multi-channel-surface.svg?color=green)](https://pypi.org/project/napari-multi-channel-surface)\n[![Python Version](https://img.shields.io/pypi/pyversions/napari-multi-channel-surface.svg?color=green)](https://python.org)\n[![tests](https://github.com/judithlutton/napari-multi-channel-surface/workflows/tests/badge.svg)](https://github.com/judithlutton/napari-multi-channel-surface/actions)\n\n[![napari hub](https://img.shields.io/endpoint?url=https://api.napari-hub.org/shields/napari-multi-channel-surface)](https://napari-hub.org/plugins/napari-multi-channel-surface)\n[![npe2](https://img.shields.io/badge/plugin-npe2-blue?link=https://napari.org/stable/plugins/index.html)](https://napari.org/stable/plugins/index.html)\n[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-purple.json)](https://github.com/copier-org/copier)\n\nA [napari] plugin to enable easy interaction with multi-channel surfaces\n\n----------------------------------\n\n## Overview\n\nThe goal of this plugin is to provide a means for reading, writing, and interacting with surfaces containing\nmultiple color channels in [napari]. When reading, color channel data is imported into the `napari.layers.Surface` metadata dictionary under the key `'point_data'`. \nDifferent channels can be used to color the surface in [napari] using the `Channel Select` widget supplied with this plugin. \nMulti-channel surfaces are saved using the `point_data` metadata key to save each named channel.\n\nVisualization of single channel vertex data is made possible in [napari] through the `vertex_values` Surface Layer property,\nwhile the `vertex_colors` property enables RGB and RGBA representations.\nSurface file formats such as `'.vtu'` provide the option of storing a variable number of features recorded at each vertex, \nand `napari-multi-channel-surface` provides functionality to utilise data in these formats.\n\n## Installation\n\n### In napari\nThis plugin was developed for use in the [napari] app. To install the plugin, go to\n\n`Plugins` > `Install/Uninstall Plugins...`\n\nType `napari-multi-channel-surface` in the search box and click install next to the\nentry `napari-multi-channel-surface` in the search results.\n\n### With pip\n\nYou can install `napari-multi-channel-surface` via [pip]:\n\n```\npip install napari-multi-channel-surface\n```\n\nIf napari is not already installed, you can install `napari-multi-channel-surface` with napari and Qt via:\n\n```\npip install \"napari-multi-channel-surface[all]\"\n```\n\n\nTo install latest development version :\n\n```\npip install git+https://github.com/judithlutton/napari-multi-channel-surface.git\n```\n\n## Usage\n\n### Reading and writing\nReading and writing mesh files can be performed in [napari] using the read and save functions in the `File` menu.\n\n#### File formats\n\n`napari-multi-channel-surface` uses [meshio] to read and write mesh files, and supports files with the following extensions:\n```\n['.ply', '.vtk', '.vtu', '.xdmf', '.xmf', '.h5m', '.avs', '.e', '.exo', '.ex2', '.hmf', '.med', '.dat', '.tec']\n```\nThis subset of file types supported by [meshio] can store color channel data.\n\n### Channel Select Widget\nYou can use the `Channel Select` widget with any data loaded with `napari-multi-channel-surface`. Simply load the surface(s) and open the widget with\n\n`Plugins` > `Channel Select (Multi Channel Surface)`\n\nThe widget allows you to select the surface you wish to interact with, (`Surface` dropdown) and and which channel you wish to view (`Channel` dropdown).\n\n### Helpful hints for using the widget:\n* If your channels have widely varying ranges, set auto-contrast to `continuous`\n* Popular choices of colormaps include `viridis`, `plasma`, and `turbo`.\n\n## Contributing\n\nContributions are very welcome. Tests can be run with [tox], please ensure\nthe coverage at least stays the same before you submit a pull request.\n\n## License\n\nDistributed under the terms of the [MIT] license,\n\"napari-multi-channel-surface\" 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----------------------------------\n\nThis [napari] plugin was generated with [copier] using the [napari-plugin-template].\n\n[napari]: https://github.com/napari/napari\n[copier]: https://copier.readthedocs.io/en/stable/\n[MIT]: http://opensource.org/licenses/MIT\n[napari-plugin-template]: https://github.com/napari/napari-plugin-template\n\n[file an issue]: https://github.com/judithlutton/napari-multi-channel-surface/issues\n\n[tox]: https://tox.readthedocs.io/en/latest/\n[pip]: https://pypi.org/project/pip/\n[PyPI]: https://pypi.org/\n[meshio]: https://github.com/nschloe/meshio\n","description_content_type":"text/markdown","keywords":null,"home_page":null,"download_url":null,"author":"Judith Lutton","author_email":"judith.e.lutton@gmail.com","maintainer":null,"maintainer_email":null,"license":"The MIT License (MIT)\n\nCopyright (c) 2025 University of Warwick\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n","classifier":["Development Status :: 2 - Pre-Alpha","Framework :: napari","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 3","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Topic :: Scientific/Engineering :: Image Processing"],"requires_dist":["h5py","napari","numpy","magicgui","meshio","pandas","qtpy","scikit-image","napari[all]; extra == \"all\""],"requires_python":">=3.10","requires_external":null,"project_url":["Bug Tracker, https://github.com/judithlutton/napari-multi-channel-surface/issues","Documentation, https://github.com/judithlutton/napari-multi-channel-surface#README.md","Source Code, https://github.com/judithlutton/napari-multi-channel-surface","User Support, https://github.com/judithlutton/napari-multi-channel-surface/issues"],"provides_extra":["all"],"provides_dist":null,"obsoletes_dist":null},"npe1_shim":false}