api

Author: sedghi

common/reviews/api/core.api.md

@@ -1044,6 +1044,10 @@ export enum EVENTS {
     // (undocumented)
     DISPLAY_AREA_MODIFIED = "CORNERSTONE_DISPLAY_AREA_MODIFIED",
     // (undocumented)
+    DYNAMIC_VOLUME_FRAME_NUMBER_CHANGED = "DYNAMIC_VOLUME_FRAME_NUMBER_CHANGED",
+    // (undocumented)
+    DYNAMIC_VOLUME_FRAME_NUMBER_LOADED = "DYNAMIC_VOLUME_FRAME_NUMBER_LOADED",
+    // (undocumented)
     DYNAMIC_VOLUME_TIME_POINT_INDEX_CHANGED = "DYNAMIC_VOLUME_TIME_POINT_INDEX_CHANGED",
     // (undocumented)
     DYNAMIC_VOLUME_TIME_POINT_LOADED = "DYNAMIC_VOLUME_TIME_POINT_LOADED",
@@ -1566,13 +1570,16 @@ type IContourSet = ContourSet;
 
 // @public (undocumented)
 interface IDynamicImageVolume extends IImageVolume {
+    // (undocumented)
+    get frameNumber(): number;
+    set frameNumber(frameNumber: number);
     // (undocumented)
     get numTimePoints(): number;
     // (undocumented)
     scroll(delta: number): void;
     // (undocumented)
     get timePointIndex(): number;
-    set timePointIndex(newTimePointIndex: number);
+    set timePointIndex(timePointIndex: number);
 }
 
 // @public (undocumented)
@@ -2272,7 +2279,7 @@ export class ImageVolume {
     // (undocumented)
     modified(): void;
     // (undocumented)
-    protected numFrames: number;
+    numFrames?: number;
     // (undocumented)
     numTimePoints?: number;
     // (undocumented)
@@ -3588,12 +3595,21 @@ export class StreamingDynamicImageVolume extends BaseStreamingImageVolume implem
         imageIdGroups: string[][];
     }, streamingProperties: IStreamingVolumeProperties);
     // (undocumented)
+    protected checkFrameCompletion(imageIdIndex: number): void;
+    // (undocumented)
     protected checkTimePointCompletion(imageIdIndex: number): void;
     // (undocumented)
+    flatImageIdIndexToFrameNumber(flatImageIdIndex: number): number;
+    // (undocumented)
     flatImageIdIndexToImageIdIndex(flatImageIdIndex: number): number;
     // (undocumented)
     flatImageIdIndexToTimePointIndex(flatImageIdIndex: number): number;
     // (undocumented)
+    get frameNumber(): number;
+    set frameNumber(frameNumber: number);
+    // (undocumented)
+    getCurrentFrameImageIds(): string[];
+    // (undocumented)
     getCurrentTimePointImageIds(): string[];
     // (undocumented)
     getImageIdsToLoad(): string[];
@@ -3629,8 +3645,12 @@ export class StreamingDynamicImageVolume extends BaseStreamingImageVolume implem
         };
     }[];
     // (undocumented)
+    isFrameLoaded(frameNumber: number): boolean;
+    // (undocumented)
     isTimePointLoaded(timePointIndex: number): boolean;
     // (undocumented)
+    numFrames: number;
+    // (undocumented)
     numTimePoints: number;
     // (undocumented)
     scroll(delta: number): void;
@@ -4951,10 +4971,11 @@ class VoxelManager<T> {
         dimensions: Point3;
     }): VoxelManager<T>;
     // (undocumented)
-    static createScalarDynamicVolumeVoxelManager({ imageIdGroups, dimensions, timePoint, numberOfComponents, }: {
+    static createScalarDynamicVolumeVoxelManager({ imageIdGroups, dimensions, timePoint, frameNumber, numberOfComponents, }: {
         imageIdGroups: string[][];
         dimensions: Point3;
-        timePoint: number;
+        timePoint?: number;
+        frameNumber?: number;
         numberOfComponents?: number;
     }): IVoxelManager<number> | IVoxelManager<RGB>;
     // (undocumented)

packages/core/src/cache/classes/ImageVolume.ts

@@ -29,7 +29,6 @@ export class ImageVolume {
   private _imageIdsIndexMap = new Map();
   private _imageURIsIndexMap = new Map();
   /** volume scalar data 3D or 4D */
-  protected numFrames: number;
   protected totalNumFrames: number;
   protected cornerstoneImageMetaData = null;
 
@@ -85,6 +84,7 @@ export class ImageVolume {
   dataType?: PixelDataTypedArrayString;
 
   numTimePoints? = null as number;
+  numFrames? = null as number;
 
   constructor(props: ImageVolumeProps) {
     const {

packages/core/src/types/IDynamicImageVolume.ts

@@ -1,25 +1,39 @@
 import type IImageVolume from './IImageVolume';
 
 /**
- * Cornerstone ImageVolume interface. Todo: we should define new IVolume class
- * with appropriate typings for the other types of volume that don't have images (nrrd, nifti)
+ * Interface for 4D Dynamic Image Volume that supports frame-based operations
  */
 interface IDynamicImageVolume extends IImageVolume {
   /**
-   * Returns the active time point index
-   * The first index starts at 1
+   * Returns the active frame number (1-based)
+   */
+  get frameNumber(): number;
+
+  /**
+   * Set the active frame number which also updates the active scalar data
+   * Frame numbers are 1-based
+   */
+  set frameNumber(frameNumber: number);
+
+  /**
+   * @deprecated Use frameNumber instead. timePointIndex is zero-based while frameNumber starts at 1.
    */
   get timePointIndex(): number;
+
   /**
-   * Set the active time point index which also updates the active scalar data
-   * The first index starts at 1
+   * @deprecated Use frameNumber instead. timePointIndex is zero-based while frameNumber starts at 1.
    */
-  set timePointIndex(newTimePointIndex: number);
+  set timePointIndex(timePointIndex: number);
+
   /**
-   * Returns the number of time points
+   * @deprecated Use numFrames instead
    */
   get numTimePoints(): number;
 
+  /**
+   * Scroll through frames, handling wrapping at start/end
+   * @param delta - The number of frames to scroll by (positive or negative)
+   */
   scroll(delta: number): void;
 }