larvitar 2.1.0 → 2.1.1

package/README.md

@@ -8,9 +8,9 @@
 
 ## Dicom Image Toolkit for CornerstoneJS
 
-### Current version: 2.1.0
+### Current version: 2.1.1
 
-### Latest Published Release: 2.1.0
+### Latest Published Release: 2.1.1
 
 This library provides common DICOM functionalities to be used in web-applications: it's wrapper that simplifies the use of cornerstone-js environment.
 

package/dist/imaging/imageRendering.d.ts

@@ -40,9 +40,10 @@ export declare function loadAndCacheImages(series: Series, callback: (payload: {
  * @function renderDICOMPDF
  * @param {Object} seriesStack - The original series data object
  * @param {String} elementId - The html div id used for rendering or its DOM HTMLElement
+ * @param {Boolean} convertToImage - An optional flag to convert pdf to image, default is false
  * @returns {Promise} - Return a promise which will resolve when pdf is displayed
  */
-export declare const renderDICOMPDF: (seriesStack: Series, elementId: string | HTMLElement) => Promise<true>;
+export declare const renderDICOMPDF: (seriesStack: Series, elementId: string | HTMLElement, convertToImage?: boolean) => Promise<true>;
 /**
  * Render an image (png or jpg) from File on a html div using cornerstone
  * @instance
@@ -51,7 +52,7 @@ export declare const renderDICOMPDF: (seriesStack: Series, elementId: string | H
  * @param {String} elementId - The html div id used for rendering or its DOM HTMLElement
  * @returns {Promise} - Return a promise which will resolve when image is displayed
  */
-export declare const renderFileImage: (file: File, elementId: string | HTMLElement) => Promise<unknown> | undefined;
+export declare const renderFileImage: (file: File, elementId: string | HTMLElement) => Promise<true>;
 /**
  * Render an image (png or jpg) from web url on a html div using cornerstone
  * @instance

package/dist/imaging/loaders/fileLoader.d.ts

@@ -31,3 +31,12 @@ export declare const populateFileManager: (file: File) => void;
  * @return {String} current file image id
  */
 export declare const getFileImageId: (file: File) => string | null;
+/**
+ * Return the common data file manager
+ * @instance
+ * @function getFileManager
+ * @returns {Object} the file manager
+ */
+export declare const getFileManager: () => {
+    [key: string]: string;
+};

package/dist/imaging/parsers/pdf.d.ts

@@ -0,0 +1,27 @@
+/** @module imaging/parsers/pdf
+ *  @desc  This file provides functionalities for
+ *         managing pdf files using pdfjs-dist library
+ */
+import { pdfType } from "../types";
+/**
+ * This module provides the following functions to be exported:
+ * convertToPNG(pdf, pageNumber)
+ * generateFiles(fileURL)
+ */
+/**
+ * Convert a pdf page to a png image in base64 format
+ * @instance
+ * @function convertToPNG
+ * @param {pdfType} pdf - The pdf object
+ * @param {number} pageNumber - The page number to be converted
+ * @returns {string} The png image in base64 format
+ */
+export declare const convertToPNG: (pdf: pdfType, pageNumber: number) => Promise<string>;
+/**
+ * Generate an array of files from a pdf file
+ * @instance
+ * @function generateFiles
+ * @param {string} fileURL - The url of the pdf file
+ * @returns {File[]} An array of files
+ */
+export declare const generateFiles: (fileURL: string) => Promise<File[]>;

package/dist/imaging/tools/custom/contourTool.d.ts

@@ -380,15 +380,15 @@ export class ContoursTool {
      */
     fireModifiedEvent(element: any, measurementData: any): void;
     fireCompletedEvent(element: any, measurementData: any): void;
-    set spacing(arg: any);
+    set spacing(value: any);
     get spacing(): any;
-    set activeHandleRadius(arg: any);
+    set activeHandleRadius(value: any);
     get activeHandleRadius(): any;
-    set completeHandleRadius(arg: any);
+    set completeHandleRadius(value: any);
     get completeHandleRadius(): any;
-    set alwaysShowHandles(arg: any);
+    set alwaysShowHandles(value: any);
     get alwaysShowHandles(): any;
-    set invalidColor(arg: any);
+    set invalidColor(value: any);
     get invalidColor(): any;
     /**
      * Ends the active drawing loop and removes the polygon.

package/dist/imaging/tools/main.d.ts

@@ -15,7 +15,7 @@ declare const initializeCSTools: (settings?: ToolSettings, style?: ToolStyle) =>
 /**
  * Create stack object to sync stack tools
  * @function csToolsCreateStack
- * @param {HTMLElement} element - The target hmtl element.
+ * @param {HTMLElement} element - The target html element.
  * @param {Array?} imageIds - Stack image ids.
  * @param {String} currentImageId - The current image id.
  */

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference path="../decs.d.ts" />
 declare const VERSION: string;
 import cornerstone from "cornerstone-core";
 import cornerstoneTools from "cornerstone-tools";
@@ -28,8 +29,8 @@ import { buildNrrdImage, getNrrdImageId, loadNrrdImage, getImageIdFromSlice, get
 import { getDicomImageId, cacheImage, cacheImages } from "./imaging/loaders/dicomLoader";
 import { loadReslicedImage } from "./imaging/loaders/resliceLoader";
 import { loadMultiFrameImage, buildMultiFrameImage, getMultiFrameImageId, clearMultiFrameCache } from "./imaging/loaders/multiframeLoader";
-import { fileManager, resetFileLoader, resetFileManager, populateFileManager, getFileImageId } from "./imaging/loaders/fileLoader";
+import { getFileManager, resetFileLoader, resetFileManager, populateFileManager, getFileImageId } from "./imaging/loaders/fileLoader";
 import { getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB } from "./imaging/imageColormaps";
 import { saveAnnotations, loadAnnotations } from "./imaging/tools/io";
 import { addMouseKeyHandlers, removeMouseKeyHandlers, toggleMouseToolsListeners } from "./imaging/tools/interaction";
-export { VERSION, cornerstone, cornerstoneTools, parseDicom, segModule, cornerstoneDICOMImageLoader, checkAndClearMemory, checkMemoryAllocation, getUsedMemory, getAvailableMemory, getPerformanceMonitor, activatePerformanceMonitor, deactivatePerformanceMonitor, store, parseECG, renderECG, unrenderECG, syncECGFrame, updateECGFrame, getDefaultECGLayout, getImagePresets, setImagePreset, setImageCustomPreset, getNormalOrientation, getMinPixelValue, getMaxPixelValue, getPixelRepresentation, getTypedArrayFromDataType, getSortedStack, randomId, getMeanValue, getReslicedMetadata, getReslicedPixeldata, getDistanceBetweenSlices, getImageMetadata, buildHeader, getCachedPixelData, buildData, buildDataAsync, importNRRDImage, exportImageToBase64, anonymize, buildLayer, updateLayer, getActiveLayer, setActiveLayer, initializeImageLoader, initializeWebImageLoader, initializeFileImageLoader, registerNRRDImageLoader, registerResliceLoader, registerMultiFrameImageLoader, updateLoadedStack, readFile, readFiles, parseDataSet, clearImageParsing, clearImageCache, loadAndCacheImages, renderFileImage, renderDICOMPDF, renderWebImage, disableViewport, unloadViewport, resizeViewport, renderImage, updateImage, resetViewports, updateViewportData, toggleMouseToolsListeners, storeViewportData, invertImage, flipImageHorizontal, flipImageVertical, rotateImageLeft, rotateImageRight, resliceSeries, getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB, parseContours, updateLarvitarManager, populateLarvitarManager, getLarvitarManager, getLarvitarImageTracker, resetLarvitarManager, removeSeriesFromLarvitarManager, getSeriesDataFromLarvitarManager, getImageFrame, getSopInstanceUIDFromLarvitarManager, buildNrrdImage, getNrrdImageId, loadNrrdImage, getImageIdFromSlice, getSliceNumberFromImageId, getNrrdSerieDimensions, loadReslicedImage, getDicomImageId, cacheImage, cacheImages, loadMultiFrameImage, buildMultiFrameImage, getMultiFrameImageId, clearMultiFrameCache, fileManager, resetFileLoader, resetFileManager, populateFileManager, getFileImageId, addDiameterTool, addContoursTool, addMaskEditingTool, getCurrentMaskData, addStackStateToElement, addSeedsTool, clearMeasurements, getToolState, clearToolStateByName, updateDiameterTool, addToolStateSingleSlice, clearCornerstoneElements, syncToolStack, updateStackToolState, setSegmentationConfig, csToolsCreateStack, csToolsUpdateImageIds, csToolsUpdateImageIndex, initializeCSTools, setToolsStyle, addDefaultTools, addTool, setToolActive, setToolDisabled, setToolEnabled, setToolPassive, exportAnnotations, DEFAULT_TOOLS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool, saveAnnotations, loadAnnotations, addMouseKeyHandlers, removeMouseKeyHandlers, initSegmentationModule, addSegmentationMask, setActiveLabelmap, setActiveSegment, undoLastStroke, redoLastStroke, setBrushProps, hexToRgb, rgbToHex, clearSegmentationState, deleteMask, enableBrushTool, disableBrushTool, toggleContourMode, toggleVisibility, getActiveLabelmapBuffer };
+export { VERSION, cornerstone, cornerstoneTools, parseDicom, segModule, cornerstoneDICOMImageLoader, checkAndClearMemory, checkMemoryAllocation, getUsedMemory, getAvailableMemory, getPerformanceMonitor, activatePerformanceMonitor, deactivatePerformanceMonitor, store, parseECG, renderECG, unrenderECG, syncECGFrame, updateECGFrame, getDefaultECGLayout, getImagePresets, setImagePreset, setImageCustomPreset, getNormalOrientation, getMinPixelValue, getMaxPixelValue, getPixelRepresentation, getTypedArrayFromDataType, getSortedStack, randomId, getMeanValue, getReslicedMetadata, getReslicedPixeldata, getDistanceBetweenSlices, getImageMetadata, buildHeader, getCachedPixelData, buildData, buildDataAsync, importNRRDImage, exportImageToBase64, anonymize, buildLayer, updateLayer, getActiveLayer, setActiveLayer, initializeImageLoader, initializeWebImageLoader, initializeFileImageLoader, registerNRRDImageLoader, registerResliceLoader, registerMultiFrameImageLoader, updateLoadedStack, readFile, readFiles, parseDataSet, clearImageParsing, clearImageCache, loadAndCacheImages, renderFileImage, renderDICOMPDF, renderWebImage, disableViewport, unloadViewport, resizeViewport, renderImage, updateImage, resetViewports, updateViewportData, toggleMouseToolsListeners, storeViewportData, invertImage, flipImageHorizontal, flipImageVertical, rotateImageLeft, rotateImageRight, resliceSeries, getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB, parseContours, updateLarvitarManager, populateLarvitarManager, getLarvitarManager, getLarvitarImageTracker, resetLarvitarManager, removeSeriesFromLarvitarManager, getSeriesDataFromLarvitarManager, getImageFrame, getSopInstanceUIDFromLarvitarManager, buildNrrdImage, getNrrdImageId, loadNrrdImage, getImageIdFromSlice, getSliceNumberFromImageId, getNrrdSerieDimensions, loadReslicedImage, getDicomImageId, cacheImage, cacheImages, loadMultiFrameImage, buildMultiFrameImage, getMultiFrameImageId, clearMultiFrameCache, getFileManager, resetFileLoader, resetFileManager, populateFileManager, getFileImageId, addDiameterTool, addContoursTool, addMaskEditingTool, getCurrentMaskData, addStackStateToElement, addSeedsTool, clearMeasurements, getToolState, clearToolStateByName, updateDiameterTool, addToolStateSingleSlice, clearCornerstoneElements, syncToolStack, updateStackToolState, setSegmentationConfig, csToolsCreateStack, csToolsUpdateImageIds, csToolsUpdateImageIndex, initializeCSTools, setToolsStyle, addDefaultTools, addTool, setToolActive, setToolDisabled, setToolEnabled, setToolPassive, exportAnnotations, DEFAULT_TOOLS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool, saveAnnotations, loadAnnotations, addMouseKeyHandlers, removeMouseKeyHandlers, initSegmentationModule, addSegmentationMask, setActiveLabelmap, setActiveSegment, undoLastStroke, redoLastStroke, setBrushProps, hexToRgb, rgbToHex, clearSegmentationState, deleteMask, enableBrushTool, disableBrushTool, toggleContourMode, toggleVisibility, getActiveLabelmapBuffer };