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 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 | 832x 132x 132x 20x 20x 20x 20x 20x 295x 295x 44x 44x 44x 44x 44x 44x 24x 24x 24x 24x 44x 33x 33x 2x 2x 2x 2x 2x 2x 2x 2x 20x 20x 20x 20x 30x 30x 33x 33x 20x 20x 20x 42x 42x 20x 20x 20x 20x | import type { Types } from '@cornerstonejs/core';
import type {
RepresentationConfig,
Segmentation,
SegmentationPublicInput,
SegmentationRepresentationConfig,
SegmentSpecificRepresentationConfig,
ToolGroupSpecificRepresentation,
ToolGroupSpecificRepresentations,
} from '../../types/SegmentationStateTypes';
import { defaultSegmentationStateManager } from './SegmentationStateManager';
import {
triggerSegmentationModified,
triggerSegmentationRemoved,
triggerSegmentationRepresentationModified,
triggerSegmentationRepresentationRemoved,
} from './triggerSegmentationEvents';
import normalizeSegmentationInput from './helpers/normalizeSegmentationInput';
/**
* It returns the defaultSegmentationStateManager.
*/
function getDefaultSegmentationStateManager() {
return defaultSegmentationStateManager;
}
/*************************
*
* Segmentation State
*
**************************/
/**
* Get the segmentation for the given segmentationId
* @param segmentationId - The Id of the segmentation
* @returns A GlobalSegmentationData object
*/
function getSegmentation(segmentationId: string): Segmentation | undefined {
const segmentationStateManager = getDefaultSegmentationStateManager();
return segmentationStateManager.getSegmentation(segmentationId);
}
/**
* Get the segmentations inside the state
* @returns Segmentation array
*/
function getSegmentations(): Segmentation[] | [] {
const segmentationStateManager = getDefaultSegmentationStateManager();
const state = segmentationStateManager.getState();
return state.segmentations;
}
/**
* It takes a segmentation input and adds it to the segmentation state manager
* @param segmentationInput - The segmentation to add.
* @param suppressEvents - If true, the event will not be triggered.
*/
function addSegmentation(
segmentationInput: SegmentationPublicInput,
suppressEvents?: boolean
): void {
const segmentationStateManager = getDefaultSegmentationStateManager();
const segmentation = normalizeSegmentationInput(segmentationInput);
segmentationStateManager.addSegmentation(segmentation);
Eif (!suppressEvents) {
triggerSegmentationModified(segmentation.segmentationId);
}
}
/**
* Get the segmentation state for a tool group. It will return an array of
* segmentation representation objects.
* @param toolGroupId - The unique identifier of the tool group.
* @returns An array of segmentation representation objects.
*/
function getSegmentationRepresentations(
toolGroupId: string
): ToolGroupSpecificRepresentations | [] {
const segmentationStateManager = getDefaultSegmentationStateManager();
return segmentationStateManager.getSegmentationRepresentations(toolGroupId);
}
/**
* Get all segmentation representations in the state
* @returns An array of segmentation representation objects.
*/
function getAllSegmentationRepresentations(): Record<
string,
ToolGroupSpecificRepresentation[]
> {
const segmentationStateManager = getDefaultSegmentationStateManager();
return segmentationStateManager.getAllSegmentationRepresentations();
}
/**
* Finds all segmentation representations with the given segmentationId.
* @param segmentationId - The ID of the segmentation.
* @returns An array of found segmentation representations.
*/
function getSegmentationIdRepresentations(segmentationId) {
const allRepresentations = getAllSegmentationRepresentations() || {};
const foundRepresentations = [];
for (const toolGroupId in allRepresentations) {
const toolGroupRepresentations = allRepresentations[toolGroupId];
const foundRepresentation = toolGroupRepresentations.find(
(representation) => representation.segmentationId === segmentationId
);
if (foundRepresentation) {
foundRepresentations.push(foundRepresentation);
}
}
return foundRepresentations;
}
/**
* Finds a segmentation representation by its UID.
*
* @param segmentationRepresentationUID - The UID of the segmentation representation to find.
* @returns The found segmentation representation, or undefined if not found.
*/
function findSegmentationRepresentationByUID(
segmentationRepresentationUID: string
): {
toolGroupId: string;
segmentationRepresentation: ToolGroupSpecificRepresentation;
} {
const allToolGroupRepresentations = getAllSegmentationRepresentations() || [];
const toolGroupIds = Object.keys(allToolGroupRepresentations);
for (const toolGroupId of toolGroupIds) {
const toolGroupRepresentations =
getAllSegmentationRepresentations()[toolGroupId];
const foundRepresentation = toolGroupRepresentations.find(
(representation) =>
representation.segmentationRepresentationUID ===
segmentationRepresentationUID
);
if (foundRepresentation) {
return {
segmentationRepresentation: foundRepresentation,
toolGroupId,
};
}
}
}
/**
* Get the tool group IDs that have a segmentation representation with the given
* segmentationId
* @param segmentationId - The id of the segmentation
* @returns An array of tool group IDs.
*/
function getToolGroupIdsWithSegmentation(segmentationId: string): string[] {
Iif (!segmentationId) {
throw new Error('getToolGroupIdsWithSegmentation: segmentationId is empty');
}
const segmentationStateManager = getDefaultSegmentationStateManager();
const state = segmentationStateManager.getState();
const toolGroupIds = Object.keys(state.toolGroups);
const foundToolGroupIds = [];
toolGroupIds.forEach((toolGroupId) => {
const toolGroupSegmentationRepresentations =
segmentationStateManager.getSegmentationRepresentations(toolGroupId);
toolGroupSegmentationRepresentations.forEach((representation) => {
Eif (representation.segmentationId === segmentationId) {
foundToolGroupIds.push(toolGroupId);
}
});
});
return foundToolGroupIds;
}
/**
* Get the segmentation representations config for a given tool group
* @param toolGroupId - The Id of the tool group that the segmentation
* config belongs to.
* @returns A SegmentationConfig object.
*/
function getToolGroupSpecificConfig(
toolGroupId: string
): SegmentationRepresentationConfig {
const segmentationStateManager = getDefaultSegmentationStateManager();
return segmentationStateManager.getToolGroupSpecificConfig(toolGroupId);
}
/**
* Set the segmentation representation config for the provided toolGroup. ToolGroup specific
* configuration overwrites the global configuration for each representation.
* It fires SEGMENTATION_REPRESENTATION_MODIFIED event if not suppressed.
*
* @triggers SEGMENTATION_REPRESENTATION_MODIFIED
* @param toolGroupId - The Id of the tool group that the segmentation
* config is being set for.
* @param config - The new configuration for the tool group.
* @param suppressEvents - If true, the event will not be triggered.
*/
function setToolGroupSpecificConfig(
toolGroupId: string,
config: SegmentationRepresentationConfig,
suppressEvents?: boolean
): void {
const segmentationStateManager = getDefaultSegmentationStateManager();
segmentationStateManager.setSegmentationRepresentationConfig(
toolGroupId,
config
);
Eif (!suppressEvents) {
triggerSegmentationRepresentationModified(toolGroupId);
}
}
/**
* It sets the segmentation representation specific config for all the segments
* inside the segmentation.
* @param segmentationRepresentationUID - The unique identifier of the segmentation representation.
* @param config - The new configuration for the segmentation representation it is an object with keys of
* different representation types, and values of the configuration for each representation type.
*/
function setSegmentationRepresentationSpecificConfig(
toolGroupId: string,
segmentationRepresentationUID: string,
config: RepresentationConfig,
suppressEvents = false
): void {
const segmentationStateManager = getDefaultSegmentationStateManager();
segmentationStateManager.setSegmentationRepresentationSpecificConfig(
toolGroupId,
segmentationRepresentationUID,
config
);
if (!suppressEvents) {
triggerSegmentationRepresentationModified(
toolGroupId,
segmentationRepresentationUID
);
}
}
/**
* It returns the segmentation representation specific config which is the same for all the segments
* @param segmentationRepresentationUID - The unique identifier of the segmentation representation.
* @returns - The segmentation representation specific config.
*/
function getSegmentationRepresentationSpecificConfig(
toolGroupId: string,
segmentationRepresentationUID: string
): RepresentationConfig {
const segmentationStateManager = getDefaultSegmentationStateManager();
return segmentationStateManager.getSegmentationRepresentationSpecificConfig(
toolGroupId,
segmentationRepresentationUID
);
}
function getSegmentSpecificRepresentationConfig(
toolGroupId: string,
segmentationRepresentationUID: string,
segmentIndex: number
): RepresentationConfig {
const segmentationStateManager = getDefaultSegmentationStateManager();
return segmentationStateManager.getSegmentSpecificConfig(
toolGroupId,
segmentationRepresentationUID,
segmentIndex
);
}
function setSegmentSpecificRepresentationConfig(
toolGroupId: string,
segmentationRepresentationUID: string,
config: SegmentSpecificRepresentationConfig,
suppressEvents = false
): void {
const segmentationStateManager = getDefaultSegmentationStateManager();
segmentationStateManager.setSegmentSpecificConfig(
toolGroupId,
segmentationRepresentationUID,
config
);
// Todo: this can be even more performant if we create a new event for
// triggering a specific segment config change.
if (!suppressEvents) {
triggerSegmentationRepresentationModified(
toolGroupId,
segmentationRepresentationUID
);
}
}
function getToolGroupIdFromSegmentationRepresentationUID(
segmentationRepresentationUID: string
): string {
const allToolGroupRepresentations = getAllSegmentationRepresentations() || [];
const toolGroupIds = Object.keys(allToolGroupRepresentations);
for (const toolGroupId of toolGroupIds) {
const toolGroupRepresentations =
getAllSegmentationRepresentations()[toolGroupId];
const foundRepresentation = toolGroupRepresentations.find(
(representation) =>
representation.segmentationRepresentationUID ===
segmentationRepresentationUID
);
if (foundRepresentation) {
return toolGroupId;
}
}
}
/**
* Add the given segmentation representation data to the given tool group state. It fires
* SEGMENTATION_REPRESENTATION_MODIFIED event if not suppressed.
*
* @triggers SEGMENTATION_REPRESENTATION_MODIFIED
*
* @param toolGroupId - The Id of the tool group that the segmentation representation is for.
* @param segmentationData - The data to add to the segmentation state.
* @param suppressEvents - boolean
*/
function addSegmentationRepresentation(
toolGroupId: string,
segmentationRepresentation: ToolGroupSpecificRepresentation,
suppressEvents?: boolean
): void {
const segmentationStateManager = getDefaultSegmentationStateManager();
segmentationStateManager.addSegmentationRepresentation(
toolGroupId,
segmentationRepresentation
);
Eif (!suppressEvents) {
triggerSegmentationRepresentationModified(
toolGroupId,
segmentationRepresentation.segmentationRepresentationUID
);
}
}
/**
* It returns the global segmentation config. Note that the toolGroup-specific
* configuration has higher priority than the global configuration and overwrites
* the global configuration for each representation.
* @returns The global segmentation configuration for all segmentations.
*/
function getGlobalConfig(): SegmentationRepresentationConfig {
const segmentationStateManager = getDefaultSegmentationStateManager();
return segmentationStateManager.getGlobalConfig();
}
/**
* Set the global segmentation configuration. It fires SEGMENTATION_MODIFIED
* event if not suppressed.
*
* @triggers SEGMENTATION_MODIFIED
* @param config - The new global segmentation config.
* @param suppressEvents - If true, the `segmentationGlobalStateModified` event will not be triggered.
*/
function setGlobalConfig(
config: SegmentationRepresentationConfig,
suppressEvents?: boolean
): void {
const segmentationStateManager = getDefaultSegmentationStateManager();
segmentationStateManager.setGlobalConfig(config);
if (!suppressEvents) {
triggerSegmentationModified();
}
}
/**
* Get the segmentation data object for a given tool group and
* segmentation data UID. It searches all the toolGroup specific segmentation
* data objects and returns the first one that matches the UID.
* @param toolGroupId - The Id of the tool group that the segmentation
* data belongs to.
* @param segmentationRepresentationUID - The uid of the segmentation representation
* @returns Segmentation Data object.
*/
function getSegmentationRepresentationByUID(
toolGroupId: string,
segmentationRepresentationUID: string
): ToolGroupSpecificRepresentation | undefined {
const segmentationStateManager = getDefaultSegmentationStateManager();
return segmentationStateManager.getSegmentationRepresentationByUID(
toolGroupId,
segmentationRepresentationUID
);
}
/**
* It removes the segmentation from the segmentation state manager
*
* @triggers SEGMENTATION_REMOVED
*
* @param segmentationId - The id of the segmentation
*/
function removeSegmentation(segmentationId: string): void {
const segmentationStateManager = getDefaultSegmentationStateManager();
segmentationStateManager.removeSegmentation(segmentationId);
triggerSegmentationRemoved(segmentationId);
}
/**
* Remove a segmentation representation from the segmentation state manager for a toolGroup.
* It fires SEGMENTATION_REPRESENTATION_MODIFIED event.
*
* @triggers SEGMENTATION_REPRESENTATION_REMOVED
*
* @param toolGroupId - The Id of the tool group that the segmentation
* data belongs to.
* @param segmentationRepresentationUID - The uid of the segmentation representation to remove.
* remove.
* @param - immediate - If true, the viewports will be updated immediately.
*/
function removeSegmentationRepresentation(
toolGroupId: string,
segmentationRepresentationUID: string
): void {
const segmentationStateManager = getDefaultSegmentationStateManager();
segmentationStateManager.removeSegmentationRepresentation(
toolGroupId,
segmentationRepresentationUID
);
triggerSegmentationRepresentationRemoved(
toolGroupId,
segmentationRepresentationUID
);
}
/**
* Removes all segmentation representations associated with a tool group.
* @param toolGroupId - The ID of the tool group.
*/
function removeSegmentationRepresentations(toolGroupId: string): void {
const segmentationRepresentations =
getSegmentationRepresentations(toolGroupId) || [];
segmentationRepresentations.forEach((representation) => {
removeSegmentationRepresentation(
toolGroupId,
representation.segmentationRepresentationUID
);
});
}
/**
* Add a color LUT to the segmentation state manager
* @param colorLUT - The color LUT array to add.
* @param index - The index of the color LUT to add.
*/
function removeColorLUT(colorLUTIndex: number): void {
const segmentationStateManager = getDefaultSegmentationStateManager();
segmentationStateManager.removeColorLUT(colorLUTIndex);
}
/**
* Get the color lut for a given index
* @param index - The index of the color lut to retrieve.
* @returns A ColorLUT array.
*/
function getColorLUT(index: number): Types.ColorLUT | undefined {
const segmentationStateManager = getDefaultSegmentationStateManager();
return segmentationStateManager.getColorLUT(index);
}
function getNextColorLUTIndex(): number {
const segmentationStateManager = getDefaultSegmentationStateManager();
return segmentationStateManager.getNextColorLUTIndex();
}
/**
* Add a color LUT to the segmentation state manager
* @param colorLUT - The color LUT array to add.
* @param index - The index of the color LUT to add.
*/
function addColorLUT(colorLUT: Types.ColorLUT, index: number): void {
const segmentationStateManager = getDefaultSegmentationStateManager();
segmentationStateManager.addColorLUT(colorLUT, index);
// Todo: trigger event color LUT added
}
export {
getDefaultSegmentationStateManager,
// Segmentation
getSegmentation,
getSegmentations,
addSegmentation,
removeSegmentation,
// ToolGroup specific Segmentation Representation
getSegmentationRepresentations,
addSegmentationRepresentation,
removeSegmentationRepresentation,
removeSegmentationRepresentations,
// config
getToolGroupSpecificConfig,
setToolGroupSpecificConfig,
getGlobalConfig,
setGlobalConfig,
getSegmentationRepresentationSpecificConfig,
setSegmentationRepresentationSpecificConfig,
getSegmentSpecificRepresentationConfig,
setSegmentSpecificRepresentationConfig,
// helpers s
getToolGroupIdsWithSegmentation,
getAllSegmentationRepresentations,
getSegmentationRepresentationByUID,
getSegmentationIdRepresentations,
// color
addColorLUT,
getColorLUT,
getNextColorLUTIndex,
removeColorLUT,
//
findSegmentationRepresentationByUID,
getToolGroupIdFromSegmentationRepresentationUID,
};
|