All files / tools/src/utilities/voi/colorbar ViewportColorbar.ts

2.17% Statements 2/92
0% Branches 0/37
0% Functions 0/17
2.19% Lines 2/91

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248                            428x 428x                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
import type { Types } from '@cornerstonejs/core';
import {
  eventTarget,
  VolumeViewport,
  StackViewport,
  Enums,
  utilities,
  getEnabledElement,
  cache,
} from '@cornerstonejs/core';
import { Colorbar } from './Colorbar';
import type { ViewportColorbarProps, ColorbarVOIRange } from './types';
import { getVOIMultipliers } from '../../getVOIMultipliers';
 
const { Events } = Enums;
const defaultImageRange = { lower: -1000, upper: 1000 };
/**
 * A colorbar associated with a viewport that updates automatically when the
 * viewport VOI changes or when the stack/volume are updated..
 */
class ViewportColorbar extends Colorbar {
  private _element: HTMLDivElement;
  private _volumeId: string;
 
  private _hideTicksTime: number;
  private _hideTicksTimeoutId: number;
 
  constructor(props: ViewportColorbarProps) {
    const { element, volumeId } = props;
    const imageRange = ViewportColorbar._getImageRange(element, volumeId);
    const voiRange = ViewportColorbar._getVOIRange(element, volumeId);
    super({ ...props, imageRange, voiRange });
 
    this._element = element;
    this._volumeId = volumeId;
 
    this._addCornerstoneEventListener();
  }
 
  public get element() {
    return this._element;
  }
 
  public get enabledElement() {
    return getEnabledElement(this._element);
  }
 
  protected getVOIMultipliers(): [number, number] {
    const { viewport } = this.enabledElement;
    return getVOIMultipliers(viewport, this._volumeId);
  }
 
  protected onVoiChange(voiRange: ColorbarVOIRange) {
    super.onVoiChange(voiRange);
 
    const { viewport } = this.enabledElement;
 
    if (viewport instanceof StackViewport) {
      viewport.setProperties({
        voiRange: voiRange,
      });
      viewport.render();
    } else if (viewport instanceof VolumeViewport) {
      const { _volumeId: volumeId } = this;
      const viewportsContainingVolumeUID =
        utilities.getViewportsWithVolumeId(volumeId);
 
      viewport.setProperties({ voiRange }, volumeId);
      viewportsContainingVolumeUID.forEach((vp) => vp.render());
    }
  }
 
  private static _getImageRange(element, volumeId?) {
    const enabledElement = getEnabledElement(element);
    const { viewport } = enabledElement;
 
    const actor = viewport.getImageActor(volumeId);
 
    if (!actor) {
      return defaultImageRange;
    }
 
    const imageData = actor.getMapper().getInputData();
 
    const scalarData = imageData.getPointData().getScalars();
 
    let imageRange;
    if (!scalarData) {
      // use voxel manager instead
      if (!volumeId) {
        throw new Error(
          'volumeId is required when scalarData is not available'
        );
      }
 
      const volume = cache.getVolume(volumeId);
      const [minValue, maxValue] = volume.voxelManager.getRange();
      imageRange = [minValue, maxValue];
    } else {
      imageRange = scalarData.getRange();
    }
 
    return imageRange[0] === 0 && imageRange[1] === 0
      ? defaultImageRange
      : { lower: imageRange[0], upper: imageRange[1] };
  }
 
  private static _getVOIRange(element, volumeId) {
    const enabledElement = getEnabledElement(element);
    const { viewport } = enabledElement;
 
    const actor = viewport.getImageActor(volumeId);
    if (!actor) {
      return defaultImageRange;
    }
 
    const voiRange = actor.getProperty().getRGBTransferFunction(0).getRange();
 
    return voiRange[0] === 0 && voiRange[1] === 0
      ? defaultImageRange
      : { lower: voiRange[0], upper: voiRange[1] };
  }
 
  private autoHideTicks = () => {
    // Avoiding calling setTimeout multiple times when manipulating the VOI
    // via WindowLevel tool for better performance
    if (this._hideTicksTimeoutId) {
      return;
    }
 
    const timeLeft = this._hideTicksTime - Date.now();
 
    if (timeLeft <= 0) {
      this.hideTicks();
    } else {
      this._hideTicksTimeoutId = window.setTimeout(() => {
        // Recursive call until there is no more time left
        this._hideTicksTimeoutId = 0;
        this.autoHideTicks();
      }, timeLeft);
    }
  };
 
  private showAndAutoHideTicks(interval = 1000) {
    this._hideTicksTime = Date.now() + interval;
    this.showTicks();
    this.autoHideTicks();
  }
 
  private _stackNewImageCallback = () => {
    this.imageRange = ViewportColorbar._getImageRange(this._element);
  };
 
  private _imageVolumeModifiedCallback = (
    evt: Types.EventTypes.ImageVolumeModifiedEvent
  ) => {
    const { volumeId } = evt.detail;
 
    if (volumeId !== this._volumeId) {
      return;
    }
 
    const { _element: element } = this;
    this.imageRange = ViewportColorbar._getImageRange(element, volumeId);
  };
 
  private _viewportVOIModifiedCallback = (
    evt: Types.EventTypes.VoiModifiedEvent
  ) => {
    const { viewportId, volumeId, range: voiRange, colormap } = evt.detail;
    const { viewport } = this.enabledElement;
    if (viewportId !== viewport.id || volumeId !== this._volumeId) {
      return;
    }
 
    this.voiRange = voiRange;
 
    if (colormap) {
      this.activeColormapName = colormap.name;
    }
    this.showAndAutoHideTicks();
  };
 
  private _viewportColormapModifiedCallback = (
    evt: Types.EventTypes.ColormapModifiedEvent
  ) => {
    const { viewportId, colormap, volumeId } = evt.detail;
    const { viewport } = this.enabledElement;
 
    if (viewportId !== viewport.id || volumeId !== this._volumeId) {
      return;
    }
 
    this.activeColormapName = colormap.name;
  };
 
  private _addCornerstoneEventListener() {
    const { _element: element } = this;
 
    eventTarget.addEventListener(
      Events.IMAGE_VOLUME_MODIFIED,
      this._imageVolumeModifiedCallback
    );
 
    element.addEventListener(
      Events.STACK_NEW_IMAGE,
      this._stackNewImageCallback
    );
 
    element.addEventListener(
      Events.VOI_MODIFIED,
      this._viewportVOIModifiedCallback as EventListener
    );
 
    element.addEventListener(
      Events.COLORMAP_MODIFIED,
      this._viewportColormapModifiedCallback as EventListener
    );
  }
 
  public destroy(): void {
    super.destroy();
    const { _element: element } = this;
 
    eventTarget.removeEventListener(
      Events.IMAGE_VOLUME_MODIFIED,
      this._imageVolumeModifiedCallback
    );
 
    element.removeEventListener(
      Events.STACK_NEW_IMAGE,
      this._stackNewImageCallback
    );
 
    element.removeEventListener(
      Events.VOI_MODIFIED,
      this._viewportVOIModifiedCallback as EventListener
    );
 
    element.removeEventListener(
      Events.COLORMAP_MODIFIED,
      this._viewportColormapModifiedCallback as EventListener
    );
  }
}
 
export { ViewportColorbar as default, ViewportColorbar };