@niivue/niivue 0.24.2 → 0.26.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/README.md +15 -17
  2. package/dist/niivue.es.js +2496 -540
  3. package/dist/niivue.umd.js +295 -125
  4. package/package.json +1 -1
  5. package/src/colortables.js +2 -2
  6. package/src/index.html +3 -2
  7. package/src/indexDraw.html +11 -4
  8. package/src/indexMM.html +229 -0
  9. package/src/indexModulate.html +223 -0
  10. package/src/niivue.js +2110 -616
  11. package/src/nvimage.js +132 -30
  12. package/src/nvmesh.js +33 -14
  13. package/src/shader-srcs.js +248 -67
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  NiiVue is a WebGL 2.0 medical image viewer. This repository contains the **core NiiVue package**. We have additional projects under development that will demonstrate a [web-based user interface implementation](https://github.com/niivue/niivue-ui), and a [desktop application](https://github.com/niivue/niivue-desktop) built using web technologies.
4
4
 
5
- The NiiVue package is intented to be used by individuals developing interactive web pages related to showing [nifti](https://nifti.nimh.nih.gov) and other formats popular in neuroimaging. NiiVue includes many mouse and keyboard interactions that enable browsing and manipulating images displayed in the canvas. This core package does not include a comprehensive user interface outside of the canvas (e.g. buttons, and other widgets). However, developers who wish to build custom user interfaces around the NiiVue canvas can manipulate the rendered images and change settings via the API. Our [web-based user interface implementation](https://github.com/niivue/niivue-ui) (under development) will demonstrate how to integrate NiiVue into a more comprehensive [VueJS](https://vuejs.org/) UI.
5
+ The NiiVue package is intented to be used by individuals developing interactive web pages related to showing [nifti](https://nifti.nimh.nih.gov) and other formats popular in neuroimaging. NiiVue includes many mouse and keyboard interactions that enable browsing and manipulating images displayed in the canvas. This core package does not include a comprehensive user interface outside of the canvas (e.g. buttons, and other widgets). However, developers who wish to build custom user interfaces around the NiiVue canvas can manipulate the rendered images and change settings via the API. Our [web-based user interface implementation](https://github.com/niivue/niivue-ui) (under development) will demonstrate how to integrate NiiVue into a more comprehensive [VueJS](https://vuejs.org/), React and Angular projects.
6
6
 
7
7
  # Getting started Docs and References
8
8
 
@@ -29,18 +29,15 @@ The primary aim of NiiVue is to translate the features of the widely used native
29
29
  - [Center for the Study of Aphasia Recovery](https://cstar.sc.edu/) (University of South Carolina)
30
30
  - [Wellcome Centre for Integrative Neuroimaging](https://www.win.ox.ac.uk/) (University of Oxford)
31
31
 
32
- # Live View
32
+ # Live View
33
33
 
34
34
  We host many NiiVue examples via github pages. These are updated and deployed automatically. All live views reflect the capabilities of the NiiVue version in the main branch.
35
35
 
36
36
  [See the examples here](https://niivue.github.io/niivue/)
37
37
 
38
- **Note**: macOS and iOS users that try to load the examples in Safari may need to enable WebGL 2.0 in their Safari settings.
39
-
40
38
  # Requirements for NiiVue to work
41
39
 
42
- - WebGL 2.0 enabled web browser (Chrome, FireFox or Safari Technology Preview).
43
- - macOS and iOS users/developers may need to enable WebGL 2.0 in their Safari settings.
40
+ - [WebGL 2.0 capable](https://caniuse.com/webgl2) web browser (Chrome, FireFox).
44
41
 
45
42
  # Usage
46
43
 
@@ -179,6 +176,7 @@ export class NiivueViewComponent implements OnInit {
179
176
  - [Daikon](https://github.com/rii-mango/Daikon)
180
177
  - [NIFTI-Reader-JS source](https://github.com/rii-mango/NIFTI-Reader-JS)
181
178
  - [glMatrix](https://glmatrix.net/)
179
+ - [fflate](https://github.com/101arrowz/fflate)
182
180
 
183
181
  # Funding
184
182
 
@@ -199,17 +197,17 @@ NiiVue can open several formats popular with brain imaging:
199
197
  There are several open source JavaScript NIfTI viewers. What makes NiiVue unique is its use of WebGL 2.0, MRIcroGL inspired shaders, and its minimal design. This makes it easy to integrate with existing web pages quicky in order to build powerful web-based viewers and support cloud-based analysis pipelines. Unlike many alternatives, NiiVue does **not** use [three.js](https://threejs.org). This means the WebGL calls are tuned for voxel display, and the screen is only refreshed when needed (preserving battery life and helping your computer do other tasks). On the other hand, niivue does not have access to the three.js user interface widgets, requiring developers to create their own custom widgets. However, there are popular UI frameworks such as [Vuetifyjs](https://vuetifyjs.com/en/) that greatly reduce this burden. Since there are numerous free alternatives, you can choose the optimal tool for your task.
200
198
  [Francesco Giorlando](https://f.giorlando.org/2018/07/web-viewers-for-fmri/) describes some of the differences between different tools.
201
199
 
202
- | Tool | Live Demos |
203
- | ------------------------------------------------------------------------ | ------------------------------------------------------------------ |
204
- | [AMI](https://github.com/FNNDSC/ami) | [live demo](https://fnndsc.github.io/ami/) |
205
- | [BioImage Suite Web Project](https://github.com/bioimagesuiteweb/bisweb) | [live demo](https://bioimagesuiteweb.github.io/webapp/viewer.html) |
206
- | [BrainBrowser](https://brainbrowser.cbrain.mcgill.ca/) | [live demo](https://brainbrowser.cbrain.mcgill.ca/volume-viewer) |
207
- | [nifti-drop](https://github.com/vsoch/nifti-drop) | [live demo](http://vsoch.github.io/nifti-drop) |
208
- | [Med3web](https://lifescience.opensource.epam.com/mri/) | [live demo](https://med3web.opensource.epam.com/) |
209
- | [MRIcroWeb](https://github.com/rordenlab/MRIcroWeb) | [live demo](https://rordenlab.github.io) |
210
- | [Papaya](https://github.com/rii-mango/Papaya) | [live demo](https://papaya.greenant.net/) |
211
- | [VTK.js](https://github.com/Kitware/vtk-js) | [live demo](https://kitware.github.io/paraview-glance/app/) |
212
- | [slicedrop](https://github.com/slicedrop/slicedrop.github.com) | [live demo](https://slicedrop.com/) |
200
+ | Tool | Live Demos |
201
+ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
202
+ | [AMI](https://github.com/FNNDSC/ami) | [live demo](https://fnndsc.github.io/ami/) |
203
+ | [BioImage Suite Web Project](https://github.com/bioimagesuiteweb/bisweb) | [live demo](https://bioimagesuiteweb.github.io/webapp/viewer.html) |
204
+ | [BrainBrowser](https://brainbrowser.cbrain.mcgill.ca/) | [live demo](https://brainbrowser.cbrain.mcgill.ca/volume-viewer) |
205
+ | [nifti-drop](https://github.com/vsoch/nifti-drop) | [live demo](http://vsoch.github.io/nifti-drop) |
206
+ | [Med3web](https://lifescience.opensource.epam.com/mri/) | [live demo](https://med3web.opensource.epam.com/) |
207
+ | [MRIcroWeb](https://github.com/rordenlab/MRIcroWeb) | [live demo](https://rordenlab.github.io) |
208
+ | [Papaya](https://github.com/rii-mango/Papaya) | [live demo](https://www.fmrib.ox.ac.uk/ukbiobank/group_means/index.html) |
209
+ | [VTK.js](https://github.com/Kitware/vtk-js) | [live demo](https://kitware.github.io/paraview-glance/app/) |
210
+ | [slicedrop](https://github.com/slicedrop/slicedrop.github.com) | [live demo](https://slicedrop.com/) |
213
211
 
214
212
  # Development
215
213