All files / extensions/cornerstone/src/hooks useViewportDisplaySets.ts

82.75% Statements 144/174
76.19% Branches 128/168
100% Functions 11/11
94.44% Lines 102/108

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 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285                  247x 112446x 3708x   108738x                                                                                                                                                           531430x       53909x 53909x         53909x   53909x       53909x 53909x 53909x 53909x 53909x 53909x 58952x     53909x   63995x         53909x   53909x 69038x 53909x   53909x 5043x       5043x         10086x 29998x         5043x     2254x   122947x   53909x 53909x   53909x 53909x 19456x   109421x 53909x     81665x         53909x   63302x 53909x   53909x 53909x 9393x     82088x   53909x       53909x   53909x   53909x 53909x   53909x 53909x 5111x 9967x 14504x 72695x 53909x     63302x   53909x   53909x 53909x   53909x 53909x   27756x 116962x   57938x   114273x 53909x   53909x 53909x   53909x 53909x   9393x 45778x   18786x   72695x 53909x   53909x 53909x   53909x 53909x   30182x 153018x     120728x   174637x             53909x   30182x 58952x 63302x     30182x 30182x     30182x 30182x     30182x 30182x     30182x 30182x     30182x 30182x     30182x 30182x 476457x        
import { useEffect, useMemo, useState } from 'react';
import { useSystem, utils } from '@ohif/core';
import { useViewportGrid } from '@ohif/ui-next';
import {
  getEnhancedDisplaySets,
  sortByOverlayable,
  DERIVED_OVERLAY_MODALITIES,
} from '../components/ViewportDataOverlaySettingMenu/utils';
 
const sortByPriority = (a, b) => {
  if (utils.isLowPriorityModality(a.Modality)) {
    return 1;
  }
  return -1;
};
 
/**
 * Options for the useViewportDisplaySets hook
 */
export type UseViewportDisplaySetsOptions = {
  /**
   * Whether to include background display set
   */
  includeBackground?: boolean;
  /**
   * Whether to include foreground display sets
   */
  includeForeground?: boolean;
  /**
   * Whether to include overlay display sets
   */
  includeOverlay?: boolean;
  /**
   * Whether to include potential overlay display sets
   */
  includePotentialOverlay?: boolean;
  /**
   * Whether to include potential foreground display sets
   */
  includePotentialForeground?: boolean;
  /**
   * Whether to include potential background display sets
   */
  includePotentialBackground?: boolean;
};
 
/**
 * Return type for useViewportDisplaySets
 */
export type ViewportDisplaySets = {
  /**
   * All display sets for the viewport
   */
  allDisplaySets: AppTypes.DisplaySet[];
  /**
   * The viewport display sets for the viewport
   */
  viewportDisplaySets: AppTypes.DisplaySet[];
  /**
   * The primary display set for the viewport (base image)
   */
  backgroundDisplaySet?: AppTypes.DisplaySet;
  /**
   * Display sets currently shown with background (non-overlay layers)
   */
  foregroundDisplaySets?: AppTypes.DisplaySet[];
  /**
   * Segmentation display sets currently applied as overlays
   */
  overlayDisplaySets?: AppTypes.DisplaySet[];
  /**
   * Display sets that could be toggled on as overlays (derived modalities)
   */
  potentialOverlayDisplaySets?: AppTypes.DisplaySet[];
  /**
   * Display sets that could be added as foreground layers
   */
  potentialForegroundDisplaySets?: AppTypes.DisplaySet[];
  /**
   * Display sets that could replace the current background
   */
  potentialBackgroundDisplaySets?: AppTypes.DisplaySet[];
};
 
/**
 * Hook to provide display sets and overlay information for a viewport based on options.
 *
 * @param viewportId - The viewport ID to get display sets for
 * @param options - Options to control which display sets to compute
 * @returns Object containing requested display set collections based on options
 */
export function useViewportDisplaySets(
  viewportId?: string,
  options?: UseViewportDisplaySetsOptions
): ViewportDisplaySets {
  const { servicesManager } = useSystem();
  const { displaySetService, segmentationService } = servicesManager.services;
 
  // Note: this is very important we should use the useViewportGrid hook here,
  // since if the viewport displaySet is changed we should re-run this hook
  // to get the latest displaySets
  const [viewportGridState, viewportGridService] = useViewportGrid();
 
  const viewportIdToUse = viewportId || viewportGridState.activeViewportId;
 
  // Apply defaults - include everything if no options specified
  const {
    includeBackground = true,
    includeForeground = true,
    includeOverlay = true,
    includePotentialOverlay = true,
    includePotentialForeground = true,
    includePotentialBackground = true,
  } = options || {};
 
  // Get all available display sets (only if needed)
  const needsAllDisplaySets = includePotentialBackground;
  const allDisplaySets = useMemo(
    () => (needsAllDisplaySets ? displaySetService.getActiveDisplaySets() : []),
    [displaySetService, needsAllDisplaySets]
  );
 
  // Get all available segmentations (only if needed)
  const needsSegmentations = includeOverlay;
 
  const [segmentationRepresentations, setSegmentationRepresentations] = useState(
    needsSegmentations ? segmentationService.getSegmentationRepresentations(viewportIdToUse) : []
  );
 
  useEffect(() => {
    setSegmentationRepresentations(
      needsSegmentations ? segmentationService.getSegmentationRepresentations(viewportIdToUse) : []
    );
 
    const unsubscribeArr = needsSegmentations
      ? [
          segmentationService.EVENTS.SEGMENTATION_REPRESENTATION_MODIFIED,
          segmentationService.EVENTS.SEGMENTATION_REPRESENTATION_REMOVED,
        ].map(event =>
          segmentationService.subscribe(event, () => {
            setSegmentationRepresentations(
              segmentationService.getSegmentationRepresentations(viewportIdToUse)
            );
          })
        )
      : [];
 
    return () => {
      unsubscribeArr.forEach(item => item.unsubscribe());
    };
  }, [segmentationService, viewportIdToUse, needsSegmentations]);
 
  const overlayDisplaySets = useMemo(() => {
    Iif (!includeOverlay) {
      return [];
    }
    return segmentationRepresentations.map(repr => {
      const displaySet = displaySetService.getDisplaySetByUID(repr.segmentationId);
      return displaySet;
    });
  }, [includeOverlay, segmentationRepresentations, displaySetService]);
 
  const overlayDisplaySetUIDs = useMemo(() => {
    return overlayDisplaySets.map(ds => ds.displaySetInstanceUID);
  }, [overlayDisplaySets]);
 
  // Get enhanced display sets (only if needed)
  const needsEnhancedDisplaySets =
    includeBackground || includeForeground || includePotentialOverlay || includePotentialForeground;
 
  const { viewportDisplaySets = [], enhancedDisplaySets = [] } = useMemo(() => {
    Iif (!needsEnhancedDisplaySets) {
      return { viewportDisplaySets: [], enhancedDisplaySets: [] };
    }
    return (
      getEnhancedDisplaySets({
        viewportId: viewportIdToUse,
        services: { displaySetService, viewportGridService },
      }) || { viewportDisplaySets: [], enhancedDisplaySets: [] }
    );
  }, [viewportIdToUse, displaySetService, viewportGridService, needsEnhancedDisplaySets]);
 
  const backgroundDisplaySet = useMemo(
    () =>
      includeBackground && viewportDisplaySets.length > 0 ? viewportDisplaySets[0] : undefined,
    [includeBackground, viewportDisplaySets]
  );
 
  const foregroundDisplaySets = useMemo(() => {
    Iif (!includeForeground || !backgroundDisplaySet) {
      return [];
    }
    return viewportDisplaySets.filter(
      ds =>
        !DERIVED_OVERLAY_MODALITIES.includes(ds.Modality) &&
        ds.displaySetInstanceUID !== backgroundDisplaySet.displaySetInstanceUID
    );
  }, [includeForeground, viewportDisplaySets, backgroundDisplaySet]);
 
  const foregroundDisplaySetUIDs = useMemo(
    () => foregroundDisplaySets.map(ds => ds.displaySetInstanceUID),
    [foregroundDisplaySets]
  );
 
  const potentialOverlayDisplaySets = useMemo(() => {
    Iif (!includePotentialOverlay) {
      return [];
    }
    return enhancedDisplaySets
      .filter(
        ds =>
          DERIVED_OVERLAY_MODALITIES.includes(ds.Modality) &&
          !overlayDisplaySetUIDs.includes(ds.displaySetInstanceUID) &&
          ds.isOverlayable
      )
      .sort(sortByOverlayable);
  }, [includePotentialOverlay, enhancedDisplaySets, overlayDisplaySetUIDs]);
 
  const potentialForegroundDisplaySets = useMemo(() => {
    Iif (!includePotentialForeground) {
      return [];
    }
    return enhancedDisplaySets
      .filter(
        ds =>
          !DERIVED_OVERLAY_MODALITIES.includes(ds.Modality) &&
          !foregroundDisplaySetUIDs.includes(ds.displaySetInstanceUID) &&
          ds.isOverlayableE
      )
      .sort(sortByPriority);
  }, [includePotentialForeground, enhancedDisplaySets, foregroundDisplaySetUIDs]);
 
  const potentialBackgroundDisplaySets = useMemo(() => {
    Iif (!includePotentialBackground || !backgroundDisplaySet) {
      return [];
    }
    return allDisplaySets
      .filter(
        ds =>
          !DERIVED_OVERLAY_MODALITIES.includes(ds.Modality) &&
          ds.displaySetInstanceUID !== backgroundDisplaySet.displaySetInstanceUID &&
          !overlayDisplaySetUIDs.includes(ds.displaySetInstanceUID) &&
          !foregroundDisplaySetUIDs.includes(ds.displaySetInstanceUID)E
      )
      .sort(sortByPriority);
  }, [
    includePotentialBackground,
    allDisplaySets,
    backgroundDisplaySet,
    overlayDisplaySetUIDs,
    foregroundDisplaySetUIDs,
  ]);
 
  const result: ViewportDisplaySets = {
    allDisplaySets: allDisplaySets || [],
    viewportDisplaySets: viewportDisplaySets || [],
  };
 
  if (includeBackground) {
    result.backgroundDisplaySet = backgroundDisplaySet;
  }
 
  if (includeForeground) {
    result.foregroundDisplaySets = foregroundDisplaySets;
  }
 
  if (includeOverlay) {
    result.overlayDisplaySets = overlayDisplaySets;
  }
 
  if (includePotentialOverlay) {
    result.potentialOverlayDisplaySets = potentialOverlayDisplaySets;
  }
 
  if (includePotentialForeground) {
    result.potentialForegroundDisplaySets = potentialForegroundDisplaySets;
  }
 
  if (includePotentialBackground) {
    result.potentialBackgroundDisplaySets = potentialBackgroundDisplaySets;
  }
 
  return result;
}