All files / tools/src/stateManagement/segmentation removeSegmentationRepresentations.ts

50% Statements 12/24
30% Branches 3/10
45.45% Functions 5/11
50% Lines 12/24

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                                                          4x                                                                       4x   4x     4x                                                                                         4x                                                                                                                       4x         4x 4x 4x                                         4x 4x 4x                        
import SegmentationRepresentations from '../../enums/SegmentationRepresentations';
import labelmapDisplay from '../../tools/displayTools/Labelmap/labelmapDisplay';
import contourDisplay from '../../tools/displayTools/Contour/contourDisplay';
 
import { getSegmentationRepresentations } from './getSegmentationRepresentation';
import { getEnabledElementByViewportId } from '@cornerstonejs/core';
import { defaultSegmentationStateManager } from './SegmentationStateManager';
import { surfaceDisplay } from '../../tools/displayTools/Surface';
 
/**
 * Removes a segmentation representation from a viewport.
 *
 * @param viewportId - The ID of the viewport.
 * @param segmentationId - The ID of the segmentation.
 * @param type - Optional. The type of segmentation representation to remove.
 * @param immediate - Optional. If true, the removal is performed immediately.
 *
 * @remarks
 * If a specific type is provided, only that representation type is removed.
 * If no type is specified, all representations for the segmentation are removed.
 */
function removeSegmentationRepresentation(
  viewportId: string,
  specifier: {
    segmentationId: string;
    type: SegmentationRepresentations;
  },
  immediate?: boolean
): Array<{ segmentationId: string; type: SegmentationRepresentations }> {
  return _removeSegmentationRepresentations(viewportId, specifier, immediate);
}
 
/**
 * Removes all segmentation representations from a viewport.
 *
 * @param viewportId - The ID of the viewport.
 * @param segmentationId - The ID of the segmentation.
 * @param type - Optional. The type of segmentation representation to remove.
 * @param immediate - Optional. If true, the removal is performed immediately.
 *
 * @remarks
 * If no specifier is provided, all segmentation representations for the viewport are removed.
 * If a segmentationId specifier is provided, only the segmentation representation with the specified segmentationId and type are removed.
 * If a type specifier is provided, only the segmentation representation with the specified type are removed.
 * If both a segmentationId and type specifier are provided, only the segmentation representation with the specified segmentationId and type are removed.
 */
function removeSegmentationRepresentations(
  viewportId: string,
  specifier: {
    segmentationId?: string;
    type?: SegmentationRepresentations;
  },
  immediate?: boolean
): Array<{ segmentationId: string; type: SegmentationRepresentations }> {
  return _removeSegmentationRepresentations(viewportId, specifier, immediate);
}
 
function _removeSegmentationRepresentations(
  viewportId: string,
  specifier: {
    segmentationId?: string;
    type?: SegmentationRepresentations;
  },
  immediate?: boolean
): Array<{ segmentationId: string; type: SegmentationRepresentations }> {
  const { segmentationId, type } = specifier;
 
  _removeRepresentationObject(viewportId, segmentationId, type, immediate);
 
  // Remove representation from state
  return defaultSegmentationStateManager.removeSegmentationRepresentations(
    viewportId,
    {
      segmentationId,
      type,
    }
  );
}
 
/**
 * Removes all segmentation representations from all viewports and resets the segmentation state.
 *
 * @remarks
 * This function iterates through all viewport segmentation representations,
 * removes each representation, and then resets the segmentation state.
 * It effectively clears all segmentation data from the application.
 *
 */
function removeAllSegmentationRepresentations(): void {
  const state =
    defaultSegmentationStateManager.getAllViewportSegmentationRepresentations();
 
  state.forEach(({ viewportId, representations }) => {
    representations.forEach(({ segmentationId, type }) => {
      removeSegmentationRepresentation(viewportId, {
        segmentationId,
        type,
      });
    });
  });
  defaultSegmentationStateManager.resetState();
}
 
/**
 * Removes a labelmap representation from a viewport.
 *
 * @param viewportId - The ID of the viewport.
 * @param segmentationId - The ID of the segmentation.
 * @param immediate - Optional. If true, the removal is performed immediately.
 */
function removeLabelmapRepresentation(
  viewportId: string,
  segmentationId: string,
  immediate?: boolean
): void {
  removeSegmentationRepresentation(
    viewportId,
    {
      segmentationId,
      type: SegmentationRepresentations.Labelmap,
    },
    immediate
  );
}
 
/**
 * Removes a contour representation from a viewport.
 *
 * @param viewportId - The ID of the viewport.
 * @param segmentationId - The ID of the segmentation.
 * @param immediate - Optional. If true, the removal is performed immediately.
 */
function removeContourRepresentation(
  viewportId: string,
  segmentationId: string,
  immediate?: boolean
): void {
  removeSegmentationRepresentation(
    viewportId,
    {
      segmentationId,
      type: SegmentationRepresentations.Contour,
    },
    immediate
  );
}
 
/**
 * Removes a surface representation from a viewport.
 *
 * @param viewportId - The ID of the viewport.
 * @param segmentationId - The ID of the segmentation.
 * @param immediate - Optional. If true, the removal is performed immediately.
 */
function removeSurfaceRepresentation(
  viewportId: string,
  segmentationId: string,
  immediate?: boolean
): void {
  removeSegmentationRepresentation(
    viewportId,
    {
      segmentationId,
      type: SegmentationRepresentations.Surface,
    },
    immediate
  );
}
 
function _removeRepresentationObject(
  viewportId: string,
  segmentationId: string,
  type?: SegmentationRepresentations,
  immediate?: boolean
): void {
  const representations = getSegmentationRepresentations(viewportId, {
    segmentationId,
    type,
  });
 
  representations.forEach((representation) => {
    if (representation.type === SegmentationRepresentations.Labelmap) {
      labelmapDisplay.removeRepresentation(
        viewportId,
        representation.segmentationId,
        immediate
      );
    } else Eif (representation.type === SegmentationRepresentations.Contour) {
      contourDisplay.removeRepresentation(
        viewportId,
        representation.segmentationId,
        immediate
      );
    } else if (representation.type === SegmentationRepresentations.Surface) {
      surfaceDisplay.removeRepresentation(
        viewportId,
        representation.segmentationId,
        immediate
      );
    }
  });
 
  // trigger render for viewport
  const { viewport } = getEnabledElementByViewportId(viewportId) || {};
  Eif (viewport) {
    viewport.render();
  }
}
 
export {
  removeSegmentationRepresentation,
  removeSegmentationRepresentations,
  removeAllSegmentationRepresentations,
  removeLabelmapRepresentation,
  removeContourRepresentation,
  removeSurfaceRepresentation,
};