feat(4d): replace timepoint with dimensionGroupNumber for 4D handling with backward compatibility #1764
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In our 4D handling, we previously used
timePoint
(starting at 0) andnumberOfTimePoints
. However:positionIdentifier
). Here is the relevant part of standardThis PR introduces
dimensionGroupNumber
in a backward-compatible way to prevent breaking changes.If you see a warning in your console, follow the instructions to update accordingly. In Cornerstone3D 3.0, all references to
timePointIndex
will be removed in the future.Note on 0-based and 1-based Indexing:
timePointIndex
(property/setter inIDynamicImageVolume
,StreamingDynamicImageVolume
)dimensionGroupNumber
(property/setter inIDynamicImageVolume
,StreamingDynamicImageVolume
)numTimePoints
(property inIDynamicImageVolume
,StreamingDynamicImageVolume
,ImageVolume
,VoxelManager.createScalarDynamicVolumeVoxelManager
)numDimensionGroups
(property inIDynamicImageVolume
,StreamingDynamicImageVolume
)getCurrentTimePointImageIds
getCurrentDimensionGroupImageIds
StreamingDynamicImageVolume
)flatImageIdIndexToTimePointIndex
flatImageIdIndexToDimensionGroupNumber
StreamingDynamicImageVolume
)isTimePointLoaded
isDimensionGroupLoaded
StreamingDynamicImageVolume
)markTimePointAsLoaded
markDimensionGroupAsLoaded
StreamingDynamicImageVolume
)DYNAMIC_VOLUME_TIME_POINT_INDEX_CHANGED
DYNAMIC_VOLUME_DIMENSION_GROUP_CHANGED
EVENTS
)DYNAMIC_VOLUME_TIME_POINT_LOADED
DYNAMIC_VOLUME_DIMENSION_GROUP_LOADED
EVENTS
)checkTimePointCompletion
checkDimensionGroupCompletion
StreamingDynamicImageVolume
,BaseStreamingImageVolume
)timePoint
(parameter inVoxelManager.createScalarDynamicVolumeVoxelManager
)dimensionGroupNumber
(parameter inVoxelManager.createScalarDynamicVolumeVoxelManager
)setTimePoint
setDimensionGroupNumber
VoxelManager
)getAtIndexAndTimePoint
getAtIndexAndDimensionGroup
VoxelManager
)getTimePointScalarData
getDimensionGroupScalarData
VoxelManager
)getCurrentTimePointScalarData
getCurrentDimensionGroupScalarData
VoxelManager
)getCurrentTimePoint
getCurrentDimensionGroupNumber
VoxelManager
)