Skip to main content

Type Alias: MeasurementTargetCandidate

MeasurementTargetCandidate: object

The display set related parameters for one candidate measurement target of a viewport - the information a MeasurementTargetsFilter decides on.

On a volume viewport there is one candidate per (non-segmentation) volume being displayed, so a fusion viewport (eg PT/CT) produces one candidate for each of the fused volumes. On other viewport types there is a single candidate for the currently displayed data.

The display set fields are populated where they are known: displaySet, displaySetUID and the exemplar instance come from the registered display set metadata (or from the instance metadata of the backing volume/image ids). When the display set is unknown - for example a stack viewport using the legacy set image ids - those fields are absent, and a filter can choose whether to include the candidate based on that.

Type declaration​

displaySet?​

optional displaySet: unknown

The display set being shown, where registered - an IDisplaySet from @cornerstonejs/metadata (via the displaySetModule metadata module), or the display set registered with the generic viewports.

displaySetUID?​

optional displaySetUID: string

The uid of the display set, where known.

imageIds?​

optional imageIds: string[]

The image ids of the display set, when a known display set (or volume) backs the candidate.

index​

index: number

The index of this display set within the viewport.

instance?​

optional instance: any

An exemplar (first) instance of the display set - naturalized DICOM instance metadata (eg with Modality, Rows, SeriesInstanceUID) - if available.

modality?​

optional modality: string

The modality of the display set where available - from the exemplar instance or the backing volume metadata. Absent when the display set is unknown.

referencedId?​

optional referencedId: string

The volume/image id backing this display set, when available.

representationUID?​

optional representationUID: string

The uid of the segmentation representation backing this candidate, when the actor is a segmentation representation (labelmap etc) rather than a plain image/volume. Filters use this to include or exclude segmentations; the default allPixelData filter excludes them.

targetId​

targetId: string

The target id used to key the annotation cachedStats for this display set. Internal to the measurement pipeline - filters normally decide on the display set fields instead.

Defined in​

tools/src/types/IBaseTool.ts:21