fix: fixed unused functions and fix updateImageIds (#401)

* fix: fixed unused functions and fix updateImageIds

* fix: version

* fix: rebuild

* Update docs

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

README.md

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

dist/imaging/tools/main.d.ts

@@ -20,13 +20,13 @@ declare const initializeCSTools: (settings?: ToolSettings, style?: ToolStyle) =>
  * @param {String} currentImageId - The current image id.
  */
 declare const csToolsCreateStack: (element: HTMLElement, imageIds?: string[], currentImageIndex?: number) => void;
-export declare function csToolsUpdateImageIds(elementId: string, imageIds: string[], imageIdIndex: number): void;
 /**
- * Update currentImageIdIndex in cs tools stack
- * @param {String} elementId - The target html element id
- * @param {String} imageId - The imageId in the form xxxxxx//:imageIndex
+ * Update stack object to sync stack tools
+ * @function csToolsUpdateImageIds
+ * @param {String} elementId - The target html element id.
+ * @param {Array} imageIds - Stack image ids.
  */
-export declare function csToolsUpdateImageIndex(elementId: string, imageId: string): void;
+export declare function csToolsUpdateImageIds(elementId: string, imageIds: string[]): void;
 /**
  * Add a cornerstone tool (grab it from original library or dvision custom tools)
  * @param {*} toolName

dist/index.d.ts

@@ -23,7 +23,7 @@ import { readFile, readFiles, parseDataSet, clearImageParsing } from "./imaging/
 import { clearImageCache, loadAndCacheImages, renderFileImage, renderDICOMPDF, renderWebImage, disableViewport, unloadViewport, resizeViewport, renderImage, updateImage, redrawImage, resetViewports, updateViewportData, storeViewportData, invertImage, flipImageHorizontal, flipImageVertical, rotateImageLeft, rotateImageRight, updateTemporalViewportData } from "./imaging/imageRendering";
 import { resliceSeries } from "./imaging/imageReslice";
 import { addDiameterTool, addContoursTool, addMaskEditingTool, getCurrentMaskData, addStackStateToElement, addSeedsTool, clearMeasurements, getToolState, clearToolStateByName, updateDiameterTool, addToolStateSingleSlice, clearCornerstoneElements, syncToolStack, updateStackToolState, setSegmentationConfig } from "./imaging/imageTools";
-import { csToolsCreateStack, csToolsUpdateImageIds, csToolsUpdateImageIndex, initializeCSTools, setToolsStyle, addDefaultTools, addTool, setToolActive, setToolDisabled, setToolEnabled, setToolPassive, exportAnnotations } from "./imaging/tools/main";
+import { csToolsCreateStack, csToolsUpdateImageIds, initializeCSTools, setToolsStyle, addDefaultTools, addTool, setToolActive, setToolDisabled, setToolEnabled, setToolPassive, exportAnnotations } from "./imaging/tools/main";
 import { DEFAULT_TOOLS, dvTools, getDefaultToolsByType, setDefaultToolsProps, registerExternalTool } from "./imaging/tools/default";
 import { initSegmentationModule, addSegmentationMask, clearSegmentationState, deleteMask, setActiveLabelmap, setActiveSegment, enableBrushTool, disableBrushTool, undoLastStroke, redoLastStroke, setBrushProps, toggleContourMode, toggleVisibility, hexToRgb, rgbToHex, getActiveLabelmapBuffer } from "./imaging/tools/segmentation";
 import { updateLarvitarManager, populateLarvitarManager, populateInstanceGSPSDict, getLarvitarManager, getInstanceGSPSDict, getLarvitarImageTracker, resetLarvitarManager, resetInstanceGSPSDict, removeSeriesFromLarvitarManager, getSeriesDataFromLarvitarManager, getImageFrame, getSopInstanceUIDFromLarvitarManager } from "./imaging/loaders/commonLoader";
@@ -37,4 +37,4 @@ import { getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB }
 import { applyDSAShift } from "./imaging/postProcessing/applyDSA";
 import { saveAnnotations, loadAnnotations } from "./imaging/tools/io";
 import { addMouseKeyHandlers, removeMouseKeyHandlers, toggleMouseToolsListeners } from "./imaging/tools/interaction";
-export { VERSION, cornerstone, cornerstoneTools, parseDicom, cornerstoneFileImageLoader, segModule, cornerstoneDICOMImageLoader, checkAndClearMemory, checkMemoryAllocation, getUsedMemory, getAvailableMemory, getPerformanceMonitor, activatePerformanceMonitor, deactivatePerformanceMonitor, store, parseECG, renderECG, unrenderECG, syncECGFrame, updateECGMarker, updateECGTotalTime, getDefaultECGLayout, getImagePresets, setImagePreset, setImageCustomPreset, getNormalOrientation, getMinPixelValue, getMaxPixelValue, getPixelRepresentation, getTypedArrayFromDataType, getSortedStack, randomId, getMeanValue, getReslicedMetadata, getReslicedPixeldata, getDistanceBetweenSlices, getImageMetadata, buildHeader, getCachedPixelData, buildData, buildDataAsync, importNRRDImage, exportImageToBase64, exportImageToBase64OriginalSizes, anonymize, customizeByteArray, buildLayer, updateLayer, getActiveLayer, setActiveLayer, initializeImageLoader, initializeWebImageLoader, initializeFileImageLoader, registerNRRDImageLoader, registerResliceLoader, registerMultiFrameImageLoader, registerDsaImageLoader, updateLoadedStack, reset, readFile, readFiles, parseDataSet, clearImageParsing, clearImageCache, loadAndCacheImages, renderFileImage, renderDICOMPDF, renderWebImage, disableViewport, unloadViewport, resizeViewport, renderImage, updateImage, redrawImage, resetViewports, updateViewportData, toggleMouseToolsListeners, storeViewportData, invertImage, flipImageHorizontal, flipImageVertical, rotateImageLeft, rotateImageRight, resliceSeries, getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB, parseContours, updateLarvitarManager, populateLarvitarManager, populateInstanceGSPSDict, getLarvitarManager, getInstanceGSPSDict, getLarvitarImageTracker, resetLarvitarManager, resetInstanceGSPSDict, removeSeriesFromLarvitarManager, getSeriesDataFromLarvitarManager, getImageFrame, getSopInstanceUIDFromLarvitarManager, buildNrrdImage, getNrrdImageId, loadNrrdImage, getImageIdFromSlice, getSliceNumberFromImageId, getNrrdSerieDimensions, loadReslicedImage, getDicomImageId, cacheImage, cacheImages, loadAndCacheImageStack, loadAndCacheDsaImageStack, loadMultiFrameImage, buildMultiFrameImage, getMultiFrameImageId, clearMultiFrameCache, populateDsaImageIds, getFileManager, resetFileLoader, resetFileManager, populateFileManager, getFileImageId, applyDSAShift, 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, updateTemporalViewportData };
+export { VERSION, cornerstone, cornerstoneTools, parseDicom, cornerstoneFileImageLoader, segModule, cornerstoneDICOMImageLoader, checkAndClearMemory, checkMemoryAllocation, getUsedMemory, getAvailableMemory, getPerformanceMonitor, activatePerformanceMonitor, deactivatePerformanceMonitor, store, parseECG, renderECG, unrenderECG, syncECGFrame, updateECGMarker, updateECGTotalTime, getDefaultECGLayout, getImagePresets, setImagePreset, setImageCustomPreset, getNormalOrientation, getMinPixelValue, getMaxPixelValue, getPixelRepresentation, getTypedArrayFromDataType, getSortedStack, randomId, getMeanValue, getReslicedMetadata, getReslicedPixeldata, getDistanceBetweenSlices, getImageMetadata, buildHeader, getCachedPixelData, buildData, buildDataAsync, importNRRDImage, exportImageToBase64, exportImageToBase64OriginalSizes, anonymize, customizeByteArray, buildLayer, updateLayer, getActiveLayer, setActiveLayer, initializeImageLoader, initializeWebImageLoader, initializeFileImageLoader, registerNRRDImageLoader, registerResliceLoader, registerMultiFrameImageLoader, registerDsaImageLoader, updateLoadedStack, reset, readFile, readFiles, parseDataSet, clearImageParsing, clearImageCache, loadAndCacheImages, renderFileImage, renderDICOMPDF, renderWebImage, disableViewport, unloadViewport, resizeViewport, renderImage, updateImage, redrawImage, resetViewports, updateViewportData, toggleMouseToolsListeners, storeViewportData, invertImage, flipImageHorizontal, flipImageVertical, rotateImageLeft, rotateImageRight, resliceSeries, getColormapsList, applyColorMap, addColorMap, fillPixelData, HSVToRGB, parseContours, updateLarvitarManager, populateLarvitarManager, populateInstanceGSPSDict, getLarvitarManager, getInstanceGSPSDict, getLarvitarImageTracker, resetLarvitarManager, resetInstanceGSPSDict, removeSeriesFromLarvitarManager, getSeriesDataFromLarvitarManager, getImageFrame, getSopInstanceUIDFromLarvitarManager, buildNrrdImage, getNrrdImageId, loadNrrdImage, getImageIdFromSlice, getSliceNumberFromImageId, getNrrdSerieDimensions, loadReslicedImage, getDicomImageId, cacheImage, cacheImages, loadAndCacheImageStack, loadAndCacheDsaImageStack, loadMultiFrameImage, buildMultiFrameImage, getMultiFrameImageId, clearMultiFrameCache, populateDsaImageIds, getFileManager, resetFileLoader, resetFileManager, populateFileManager, getFileImageId, applyDSAShift, addDiameterTool, addContoursTool, addMaskEditingTool, getCurrentMaskData, addStackStateToElement, addSeedsTool, clearMeasurements, getToolState, clearToolStateByName, updateDiameterTool, addToolStateSingleSlice, clearCornerstoneElements, syncToolStack, updateStackToolState, setSegmentationConfig, csToolsCreateStack, csToolsUpdateImageIds, 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, updateTemporalViewportData };

docs/documentation/index.html

@@ -74,8 +74,8 @@ <h3> </h3>
 <h1 id="larvitar">Larvitar</h1>
 <p><a href="https://github.com/dvisionlab/Larvitar"><img src="https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&amp;prefix=%E2%89%A5&amp;suffix=%25&amp;query=$.typeCoverage.atLeast&amp;uri=https%3A%2F%2Fraw.githubusercontent.com%2Fplantain-00%2Ftype-coverage%2Fmaster%2Fpackage.json" alt="type-coverage"></a></p>
 <h2 id="dicom-image-toolkit-for-cornerstonejs">Dicom Image Toolkit for CornerstoneJS</h2>
-<h3 id="current-version%3A-2.7.1">Current version: 2.7.1</h3>
-<h3 id="latest-published-release%3A-2.7.1">Latest Published Release: 2.7.1</h3>
+<h3 id="current-version%3A-2.7.2">Current version: 2.7.2</h3>
+<h3 id="latest-published-release%3A-2.7.2">Latest Published Release: 2.7.2</h3>
 <p>This library provides common DICOM functionalities to be used in web-applications: it's wrapper that simplifies the use of cornerstone-js environment.</p>
 <h2 id="features%3A">Features:</h2>
 <ul>

imaging/tools/main.ts

@@ -85,36 +85,22 @@ const csToolsCreateStack = function (
   cornerstoneTools.addToolState(element, "stack", stack);
 };
 
-export function csToolsUpdateImageIds(
-  elementId: string,
-  imageIds: string[],
-  imageIdIndex: number
-) {
+/**
+ * Update stack object to sync stack tools
+ * @function csToolsUpdateImageIds
+ * @param {String} elementId - The target html element id.
+ * @param {Array} imageIds - Stack image ids.
+ */
+
+export function csToolsUpdateImageIds(elementId: string, imageIds: string[]) {
   const element = document.getElementById(elementId);
   if (element) {
     const stackState = cornerstoneTools.getToolState(element, "stack");
     const stackData = stackState.data[0];
     stackData.imageIds = imageIds;
-    stackData.currentImageIdIndex =
-      stackData.currentImageIdIndex < imageIdIndex
-        ? stackData.currentImageIdIndex
-        : (stackData.currentImageIdIndex += 1);
   }
 }
 
-/**
- * Update currentImageIdIndex in cs tools stack
- * @param {String} elementId - The target html element id
- * @param {String} imageId - The imageId in the form xxxxxx//:imageIndex
- */
-export function csToolsUpdateImageIndex(elementId: string, imageId: string) {
-  let currentImageIdIndex = parseInt(imageId.split(":")[1]);
-  const element = document.getElementById(elementId);
-  const stackState = cornerstoneTools.getToolState(element, "stack");
-  const stackData = stackState.data[0];
-  stackData.currentImageIdIndex = currentImageIdIndex;
-}
-
 /**
  *
  * @param {*} toolName

index.ts

@@ -151,7 +151,6 @@ import {
 import {
   csToolsCreateStack,
   csToolsUpdateImageIds,
-  csToolsUpdateImageIndex,
   initializeCSTools,
   setToolsStyle,
   addDefaultTools,
@@ -431,7 +430,6 @@ export {
   // tools/main
   csToolsCreateStack,
   csToolsUpdateImageIds,
-  csToolsUpdateImageIndex,
   initializeCSTools,
   setToolsStyle,
   addDefaultTools,

package.json

@@ -6,7 +6,7 @@
     "medical",
     "cornerstone"
   ],
-  "version": "2.7.1",
+  "version": "2.7.2",
   "description": "typescript library for parsing, loading, rendering and interacting with DICOM images",
   "repository": {
     "url": "https://github.com/dvisionlab/Larvitar.git",
@@ -82,4 +82,4 @@
     "webpack-cli": "^5.0.1",
     "webpack-dev-server": "^4.13.1"
   }
-}
+}