feat(segmentation): Add polymorph segmentation and representation conversion capabilities

common/reviews/api/core.api.md

@@ -91,6 +91,11 @@ number
 // @public (undocumented)
 function applyPreset(actor: VolumeActor, preset: ViewportPreset): void;
 
+// @public (undocumented)
+const backgroundColors: {
+    slicer3D: number[];
+};
+
 // @public (undocumented)
 export abstract class BaseVolumeViewport extends Viewport implements IVolumeViewport {
     constructor(props: ViewportInput);
@@ -278,7 +283,8 @@ declare namespace CONSTANTS {
         RENDERING_DEFAULTS,
         mprCameraValues as MPR_CAMERA_VALUES,
         EPSILON,
-        presets as VIEWPORT_PRESETS
+        presets as VIEWPORT_PRESETS,
+        backgroundColors as BACKGROUND_COLORS
     }
 }
 export { CONSTANTS }
@@ -603,7 +609,7 @@ function createAndCacheDerivedSegmentationImage(referencedImageId: string, optio
 function createAndCacheDerivedSegmentationImages(referencedImageIds: Array<string>, options?: DerivedImageOptions): DerivedImages;
 
 // @public (undocumented)
-function createAndCacheDerivedSegmentationVolume(referencedVolumeId: string, options: DerivedVolumeOptions): Promise<IImageVolume>;
+function createAndCacheDerivedSegmentationVolume(referencedVolumeId: string, options?: DerivedVolumeOptions): Promise<IImageVolume>;
 
 // @public (undocumented)
 function createAndCacheDerivedVolume(referencedVolumeId: string, options: DerivedVolumeOptions): Promise<IImageVolume>;
@@ -632,6 +638,9 @@ function createInt16SharedArray(length: number): Int16Array;
 // @public (undocumented)
 function createLinearRGBTransferFunction(voiRange: VOIRange): vtkColorTransferFunction;
 
+// @public (undocumented)
+function createLocalSegmentationVolume(options: LocalVolumeOptions, volumeId: string, preventCache?: boolean): Promise<IImageVolume>;
+
 // @public (undocumented)
 function createLocalVolume(options: LocalVolumeOptions, volumeId: string, preventCache?: boolean): IImageVolume;
 
@@ -808,7 +817,9 @@ export enum EVENTS {
     // (undocumented)
     VOLUME_SCROLL_OUT_OF_BOUNDS = "CORNERSTONE_VOLUME_SCROLL_OUT_OF_BOUNDS",
     // (undocumented)
-    VOLUME_VIEWPORT_NEW_VOLUME = "CORNERSTONE_VOLUME_VIEWPORT_NEW_VOLUME"
+    VOLUME_VIEWPORT_NEW_VOLUME = "CORNERSTONE_VOLUME_VIEWPORT_NEW_VOLUME",
+    // (undocumented)
+    WEB_WORKER_PROGRESS = "CORNERSTONE_WEB_WORKER_PROGRESS"
 }
 
 // @public (undocumented)
@@ -994,6 +1005,9 @@ function getUnknownVolumeLoaderSchema(): string;
 // @public (undocumented)
 function getViewportImageCornersInWorld(viewport: IStackViewport | IVolumeViewport): Point3[];
 
+// @public (undocumented)
+function getViewportImageIds(viewport: IViewport): string[];
+
 // @public (undocumented)
 function getViewportModality(viewport: IViewport, volumeId?: string): string;
 
@@ -1221,7 +1235,7 @@ interface IEnabledElement {
 // @public (undocumented)
 interface IGeometry {
     // (undocumented)
-    data: IContourSet | Surface;
+    data: IContourSet | ISurface;
     // (undocumented)
     id: string;
     // (undocumented)
@@ -1437,7 +1451,7 @@ interface IImageVolume {
     // (undocumented)
     convertToImageSlicesAndCache(): string[];
     // (undocumented)
-    decache?: () => void;
+    decache?: (completelyRemove?: boolean) => void;
     // (undocumented)
     destroy(): void;
     // (undocumented)
@@ -1467,6 +1481,8 @@ interface IImageVolume {
     // (undocumented)
     metadata: Metadata;
     // (undocumented)
+    modified(): void;
+    // (undocumented)
     numVoxels: number;
     // (undocumented)
     origin: Point3;
@@ -1762,6 +1778,8 @@ export class ImageVolume implements IImageVolume {
     // (undocumented)
     metadata: Metadata;
     // (undocumented)
+    modified(): void;
+    // (undocumented)
     protected numFrames: number;
     // (undocumented)
     numVoxels: number;
@@ -2029,6 +2047,30 @@ interface IStreamingVolumeProperties {
     };
 }
 
+// @public (undocumented)
+interface ISurface {
+    // (undocumented)
+    readonly frameOfReferenceUID: string;
+    // (undocumented)
+    getColor(): Point3;
+    // (undocumented)
+    getPoints(): number[];
+    // (undocumented)
+    getPolys(): number[];
+    // (undocumented)
+    getSizeInBytes(): number;
+    // (undocumented)
+    readonly id: string;
+    // (undocumented)
+    setColor(color: Point3): void;
+    // (undocumented)
+    setPoints(points: number[]): void;
+    // (undocumented)
+    setPolys(polys: number[]): void;
+    // (undocumented)
+    readonly sizeInBytes: number;
+}
+
 // @public (undocumented)
 function isValidVolume(imageIds: string[]): boolean;
 
@@ -3027,6 +3069,33 @@ type StreamingRetrieveOptions = BaseRetrieveOptions & {
     streaming: boolean;
 };
 
+// @public (undocumented)
+export class Surface implements ISurface {
+    constructor(props: SurfaceProps);
+    // (undocumented)
+    readonly frameOfReferenceUID: string;
+    // (undocumented)
+    getColor(): RGB;
+    // (undocumented)
+    getPoints(): number[];
+    // (undocumented)
+    getPolys(): number[];
+    // (undocumented)
+    getSizeInBytes(): number;
+    // (undocumented)
+    _getSizeInBytes(): number;
+    // (undocumented)
+    readonly id: string;
+    // (undocumented)
+    setColor(color: RGB): void;
+    // (undocumented)
+    setPoints(points: number[]): void;
+    // (undocumented)
+    setPolys(polys: number[]): void;
+    // (undocumented)
+    readonly sizeInBytes: number;
+}
+
 // @public (undocumented)
 type SurfaceData = {
     points: number[];
@@ -3183,6 +3252,7 @@ declare namespace Types {
         IContour,
         PublicSurfaceData,
         SurfaceData,
+        ISurface,
         RGB,
         ColormapPublic,
         ColormapRegistration,
@@ -3287,7 +3357,8 @@ declare namespace utilities {
         convertVolumeToStackViewport,
         cacheUtils,
         roundNumber,
-        roundToPrecision
+        roundToPrecision,
+        getViewportImageIds
     }
 }
 export { utilities }
@@ -3494,6 +3565,8 @@ export class Viewport implements IViewport {
     // (undocumented)
     getCanvas(): HTMLCanvasElement;
     // (undocumented)
+    getClippingPlanesForActor(actorEntry?: ActorEntry): vtkPlane[];
+    // (undocumented)
     _getCorners(bounds: Array<number>): Array<number>[];
     // (undocumented)
     getCurrentImageIdIndex(): number;
@@ -3541,12 +3614,8 @@ export class Viewport implements IViewport {
     // (undocumented)
     _isInBounds(point: Point3, bounds: number[]): boolean;
     // (undocumented)
-    protected newActorAdded: boolean;
-    // (undocumented)
     options: ViewportInputOptions;
     // (undocumented)
-    protected posProcessNewActors(): void;
-    // (undocumented)
     _removeActor(actorUID: string): void;
     // (undocumented)
     removeActors(actorUIDs: Array<string>): void;
@@ -3771,7 +3840,8 @@ declare namespace volumeLoader {
         getVolumeLoaderSchemes,
         registerUnknownVolumeLoader,
         getUnknownVolumeLoaderSchema,
-        createAndCacheDerivedSegmentationVolume
+        createAndCacheDerivedSegmentationVolume,
+        createLocalSegmentationVolume
     }
 }
 export { volumeLoader }
@@ -3841,13 +3911,28 @@ export class VolumeViewport extends BaseVolumeViewport {
     // (undocumented)
     getNumberOfSlices: () => number;
     // (undocumented)
+    getSliceIndex: () => number;
+    // (undocumented)
+    getSlicePlaneCoordinates: () => Array<{
+        sliceIndex: number;
+        point: Point3;
+    }>;
+    // (undocumented)
+    getSlicesClippingPlanes(): Array<{
+        sliceIndex: number;
+        planes: Array<{
+            normal: Point3;
+            origin: Point3;
+        }>;
+    }>;
+    // (undocumented)
     resetCamera(resetPan?: boolean, resetZoom?: boolean, resetToCenter?: boolean, resetRotation?: boolean): boolean;
     // (undocumented)
     resetProperties(volumeId?: string): void;
     // (undocumented)
     setBlendMode(blendMode: BlendModes, filterActorUIDs?: any[], immediate?: boolean): void;
     // (undocumented)
-    setOrientation(orientation: OrientationAxis, immediate?: boolean): void;
+    setOrientation(orientation: OrientationAxis | OrientationVectors, immediate?: boolean): void;
     // (undocumented)
     setSlabThickness(slabThickness: number, filterActorUIDs?: any[]): void;
     // (undocumented)
@@ -3864,8 +3949,6 @@ export class VolumeViewport3D extends BaseVolumeViewport {
     // (undocumented)
     getRotation: () => number;
     // (undocumented)
-    posProcessNewActors(): void;
-    // (undocumented)
     resetCamera(resetPan?: boolean, resetZoom?: boolean, resetToCenter?: boolean): boolean;
     // (undocumented)
     resetProperties(volumeId?: string): void;
@@ -3936,7 +4019,7 @@ class VoxelManager<T> {
     // (undocumented)
     setAtIJK: (i: number, j: number, k: number, v: any) => void;
     // (undocumented)
-    setAtIJKPoint: ([i, j, k]: [any, any, any], v: any) => void;
+    setAtIJKPoint: ([i, j, k]: Point3, v: any) => void;
     // (undocumented)
     setAtIndex: (index: any, v: any) => void;
     // (undocumented)