diff --git a/README.md b/README.md index 39575a6e0..721af5e25 100644 --- a/README.md +++ b/README.md @@ -6,32 +6,38 @@ ## Dicom Image Toolkit for CornestoneJS -### Current version: 0.9.4 +### Current version: 0.9.5 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. - `index` main file -- `image_parsing` parse dicom files and return a cornestone data structure ready to be used for rendering +- `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_contours` using to populate cornerstone tool for segmentation contours on 2D images -- `image_tools` using to handle standard and custom cornerstone tools +- `image_parsing` parse dicom files and return a cornestone data structure ready to be used for rendering - `image_rendering` provides rendering 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 -- `image_colormaps` provides color maps functionalities -- `dataDictionary` json file for dicom 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 - `loaders/nrrdLoader`custom loader for nrrd files with support for multiplanar reformat (axial, sagittal and coronal planes) - `loaders/resliceLoader` custom loader for resliced data -- `tools/customTool` is a the main file used to initialize custom cornerstone tools +- `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/default` default tools map and configuration +- `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 + Full documentation is available at http://www.dvisionlab.com/Larvitar/. @@ -46,10 +52,14 @@ Full documentation is available at http://www.dvisionlab.com/Larvitar/. # Dependencies - `cornerstone` +- `cornerstone-tools` - `dicomParser` - `wadoImageLoader` +- `webImageLoader` +- `fileImageLoader` - `lodash` -- `nrrd-js` +- `pako` +- `papaparse` # Installation diff --git a/docs/index.html b/docs/index.html index 13c0cf78d..9eb124684 100644 --- a/docs/index.html +++ b/docs/index.html @@ -70,31 +70,36 @@
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.
index
main fileimage_parsing
parse dicom files and return a cornestone data structure ready to be used for renderingdataDictionary
json file for dicom tagsimage_colormaps
provides color maps functionalitiesimage_contours
using to populate cornerstone tool for segmentation contours on 2D imagesimage_io
import a dicom image in .nrrd format and build contiguous array for exporting data as volumeimage_layers
provide support for multi-layer cornerstone fusion rendererimage_loading
initialize loader and custom loadersimage_contours
using to populate cornerstone tool for segmentation contours on 2D imagesimage_tools
using to handle standard and custom cornerstone toolsimage_parsing
parse dicom files and return a cornestone data structure ready to be used for renderingimage_rendering
provides rendering functionalitiesimage_store
provides data storage functionalities, vuex support is integratedimage_tools
using to handle standard and custom cornerstone toolsimage_utils
utility functions on pixels and metadata tagsimage_colormaps
provides color maps functionalitiesdataDictionary
json file for dicom tagsloaders/commonLoader
common functionalities for custom loadersloaders/dicomLoader
custom loader for DICOM files with support for multiplanar reformat (axial, sagittal and coronal planes)loaders/fileLoader
custom loader for png/jpg filesloaders/nrrdLoader
custom loader for nrrd files with support for multiplanar reformat (axial, sagittal and coronal planes)loaders/resliceLoader
custom loader for resliced datatools/customTool
is a the main file used to initialize custom cornerstone toolsparsers/nrrd
custom parser for nrrd datatools/contourTool
is a custom cornerstone tool for 2D visualization of segmented imagestools/diameterTool
is a custom cornerstone tool for 2D visualization of diameter widgetstools/editMaskTool
is a custom cornerstone tool for 2D visualization of segmentation masks with brush functionalitiestools/seedTool
is a custom cornerstone tool for 2D interactive seeding with custom colors and labelstools/default
default tools map and configurationtools/thresholdsBrushTool
is a custom cornerstone tool for handling thresholds in a brush tooltools/tools.default
default tools map and configurationtools/tools.io
import and export functionalities for toolstools/tools.main
tools main functionalitiestools/tools.state
tools state managementFull documentation is available at http://www.dvisionlab.com/Larvitar/.
cornerstone
cornerstone-tools
dicomParser
wadoImageLoader
webImageLoader
fileImageLoader
lodash
nrrd-js
pako
papaparse
yarn add larvitar