larvitar 0.20.0 → 1.1.2

package/MIGRATION.md

@@ -0,0 +1,25 @@
+# Introduction
+
+This guide is primarily for user with prior Larvitar v0.x experience who want to learn about the new features and changes in Larvitar v1.x. While it looks like a lot has changed, a lot of what you know and love about Larvitar is still the same; but we wanted to be as thorough as possibile and provide detailed explanations or examples for every documented change.
+
+# Notable new features
+
+We chose to migrate all functions using callback to promise. Promises are JavaScript objects that represent an eventual completion or failure of an asynchronous operation. A promise is a returned object where you attach callbacks, instead of passing callbacks into a function. the place where you attach the callback after a successful completion of a task is called, .then(). inside this you pass a callback through.
+
+# Breaking changes
+
+- imageIo module:
+  -  *getCachedPixelData* now returns a promise which will resolve to a pixel data array or fail if an error occurs
+- imageParsing module
+  - *readFiles* now returns a promise which will resolve to an image object list or fail if an error occurs
+  - *readFile* now returns a promise which will resolve to an image object or fail if an error occurs
+  - *dumpDataset* has been renamed to parseDataset [internal API]
+  - *dumpFiles* has been renamed to parseFiles [internal API]
+  - *dumpFile* has been renamed to parseFile [internal API]
+-  imageRendering module
+   -  *renderImage* now returns a promise which will resolve when image is displayed
+-  imageReslice module
+   -  *resliceImage* now returns a promise which will resolve when reslice data is available
+-  tools/segmentation module
+   -  *addSegmentationMask* now returns a promise which will resolve when segmentation mask is added
+   -  *getActivelabelmapBuffer* now needs elementId (or its DOM HTMLElement) as param and returns the buffer parent object"

package/README.md

@@ -6,28 +6,29 @@
 
 ## Dicom Image Toolkit for CornestoneJS
 
-### Current version: 0.20.0
+### Current version: 1.1.2
 
-### Latest Stable version: 0.20.0
+### Latest Stable version: 1.1.2
 
-### Latest Published Release: 0.20.0
+### Latest Published Release: 1.1.2
 
-This library provides common dicom functionalities to be used in web-applications. Multiplanar reformat on axial, sagittal and coronal viewports is included as well as custom loader/exporter for nrrd files and orthogonal reslice.
+This library provides common DICOM functionalities to be used in web-applications: it's wrapper that simplifies the use of cornestone-js environment.
+Orthogonal multiplanar reformat is included as well as custom loader/exporter for nrrd files and [Vuex](https://vuex.vuejs.org/) custom integration.
 
 - `index` main file
 - `dataDictionary` json file for dicom tags
-- `image_colormaps` provides color maps functionalities
-- `image_contours` using to populate cornerstone tool for segmentation contours on 2D images
-- `image_io` import a dicom image in .nrrd format and build contiguous array for exporting data as volume
-- `image_layers` provide support for multi-layer cornerstone fusion renderer
-- `image_loading` initialize loader and custom loaders
-- `image_parsing` parse dicom files and return a cornestone data structure ready to be used for rendering
-- `image_presets` provides default image CT presets and set functionality
-- `image_rendering` provides rendering functionalities
-- `image_reslice` provides reslice functionalities
-- `image_store` provides data storage functionalities, vuex support is integrated
-- `image_tools` using to handle standard and custom cornerstone tools
-- `image_utils` utility functions on pixels and metadata tags
+- `imageColormaps` provides color maps functionalities
+- `imageContours` using to populate cornerstone tool for segmentation contours on 2D images
+- `imageIo` import a dicom image in .nrrd format and build contiguous array for exporting data as volume
+- `imageLayers` provide support for multi-layer cornerstone fusion renderer
+- `imageLoading` initialize loader and custom loaders
+- `imageParsing` parse dicom files and return a cornestone data structure ready to be used for rendering
+- `imagePresets` provides default image CT presets and set functionality
+- `imageRendering` provides rendering functionalities
+- `imageReslice` provides reslice functionalities
+- `imageStore` provides data storage functionalities, vuex support is integrated
+- `imageTools` using to handle standard and custom cornerstone tools
+- `imageUtils` utility functions on pixels and metadata tags
 - `loaders/commonLoader` common functionalities for custom loaders
 - `loaders/dicomLoader` custom loader for DICOM files with support for multiplanar reformat (axial, sagittal and coronal planes)
 - `loaders/fileLoader` custom loader for png/jpg files
@@ -35,16 +36,16 @@ This library provides common dicom functionalities to be used in web-application
 - `loaders/resliceLoader` custom loader for resliced data
 - `loaders/multiFrameLoader` custom loader for multiFrame data
 - `parsers/nrrd` custom parser for nrrd data
-- `tools/contourTool` is a custom cornerstone tool for 2D visualization of segmented images
-- `tools/diameterTool` is a custom cornerstone tool for 2D visualization of diameter widgets
-- `tools/editMaskTool` is a custom cornerstone tool for 2D visualization of segmentation masks with brush functionalities
-- `tools/seedTool` is a custom cornerstone tool for 2D interactive seeding with custom colors and labels
-- `tools/thresholdsBrushTool` is a custom cornerstone tool for handling thresholds in a brush tool
-- `tools/tools.default` default tools map and configuration
-- `tools/tools.io` import and export functionalities for tools
-- `tools/tools.main` tools main functionalities
-- `tools/tools.state` tools state management
-- `tools/tools.segmentation` segmentation masks management
+- `tools/custom/contourTool` is a custom cornerstone tool for 2D visualization of segmented images
+- `tools/custom/diameterTool` is a custom cornerstone tool for 2D visualization of diameter widgets
+- `tools/custom/editMaskTool` is a custom cornerstone tool for 2D visualization of segmentation masks with brush functionalities
+- `tools/custom/seedTool` is a custom cornerstone tool for 2D interactive seeding with custom colors and labels
+- `tools/custom/thresholdsBrushTool` is a custom cornerstone tool for handling thresholds in a brush tool
+- `tools/default` default tools map and configuration
+- `tools/io` import and export functionalities for tools
+- `tools/main` tools main functionalities
+- `tools/state` tools state management
+- `tools/segmentation` segmentation masks management
 - `modules/vuex/larvitar.js` optional vuex state module
 
 <br>
@@ -58,7 +59,7 @@ import store from "@/store/index";
 initLarvitarStore(store); // Calling this without parameters makes Larvitar use its internal store.
 ```
 
-Full documentation is available at http://www.dvisionlab.com/Larvitar/.
+Full documentation and examples are available at http://www.dvisionlab.com/Larvitar/.
 
 <br>