Skip to main content

Variable: metadataProvider

const metadataProvider: object

Contains a metadata provider which knows how to generate different types of referenced metadata for things like creation a reference to an existing image, creating a new DICOM object entirely etc.

There are also specific study/series/instance level attribute getters which can be used to get the attributes at a given level in the Normalized format instead of the lowerCamelCase format. This assists in creating new DICOM objects.

For example, this module provides a ImageSopInstanceReference implementation based on 'sopCommonModule' and 'frameModule' which references an image correctly

Type declaration

get()

get: (type, imageId, options) => any

Parameters

type: string

imageId: string

options: any

Returns

any

ImageData()

ImageData: (imageId) => object

Returns a Study header instance data for a given image.

Parameters

imageId: any

Returns

object

ImageSopInstanceReference()

ImageSopInstanceReference: (imageId) => object | object

Returns an image sop instance reference for the given image, based on the frame module metadata. Note: UpperCamelCase for normalized response.

Parameters

imageId: string

Returns

object | object

metaRTSSContour()

metaRTSSContour: () => object

Returns

object

FileMetaInformationVersion

FileMetaInformationVersion: object

FileMetaInformationVersion.Value

Value: ArrayBufferLike[]

FileMetaInformationVersion.vr

vr: string = 'OB'

ImplementationClassUID

ImplementationClassUID: object

ImplementationClassUID.Value

Value: string[]

ImplementationClassUID.vr

vr: string = 'UI'

ImplementationVersionName

ImplementationVersionName: object

ImplementationVersionName.Value

Value: string[]

ImplementationVersionName.vr

vr: string = 'SH'

TransferSyntaxUID

TransferSyntaxUID: object

TransferSyntaxUID.Value

Value: string[]

TransferSyntaxUID.vr

vr: string = 'UI'

metaSrAnnotation()

metaSrAnnotation: () => object

Returns

object

FileMetaInformationVersion

FileMetaInformationVersion: object

FileMetaInformationVersion.Value

Value: ArrayBufferLike[]

FileMetaInformationVersion.vr

vr: string = 'OB'

ImplementationClassUID

ImplementationClassUID: object

ImplementationClassUID.Value

Value: string[]

ImplementationClassUID.vr

vr: string = 'UI'

ImplementationVersionName

ImplementationVersionName: object

ImplementationVersionName.Value

Value: string[]

ImplementationVersionName.vr

vr: string = 'SH'

TransferSyntaxUID

TransferSyntaxUID: object

TransferSyntaxUID.Value

Value: string[]

TransferSyntaxUID.vr

vr: string = 'UI'

NewInstanceData()

NewInstanceData: (imageId) => any

Parameters

imageId: any

Returns

any

PredecessorSequence()

PredecessorSequence: (imageId) => any

Returns a predecessor sequence and related information to apply to the generated object.

Parameters

imageId: any

Returns

any

ReferencedSeriesReference()

ReferencedSeriesReference: (imageId) => object

Returns a referenced series reference for the given image id NOTE: This will often not be unique, so it needs to get added appropriately to a full list object.

Parameters

imageId: any

Returns

object

ReferencedInstanceSequence

ReferencedInstanceSequence: object[]

SeriesInstanceUID

SeriesInstanceUID: any = seriesModule.seriesInstanceUID

RtssInstanceData()

RtssInstanceData: (imageId) => any

RTSS Instance metadata

Parameters

imageId: any

Returns

any

SeriesData()

SeriesData: (imageId) => object

Returns a Series only header instance data for a given image.

Parameters

imageId: any

Returns

object

StudyData()

StudyData: (imageId) => object

Returns a Study header instance data for a given image.

Parameters

imageId: any

Returns

object

Defined in

adapters/src/utilities/referencedMetadataProvider.ts:43