Variable: default
constdefault:object
Type declaration
constants
constants:
constants
convertColorSpace()
convertColorSpace: (
imageFrame,colorBuffer,useRGBA) =>void
Parameters
• imageFrame: any
• colorBuffer: any
• useRGBA: any
Returns
void
convertPaletteColor()
convertPaletteColor: (
imageFrame,colorBuffer,useRGBA) =>void
Convert pixel data with PALETTE COLOR Photometric Interpretation to RGB/RGBA Note: Palette bulkdata must be loaded on the imageFrame before calling this function
Parameters
• imageFrame: ImageFrame
The ImageFrame to convert (must have palette data loaded)
• colorBuffer: ByteArray
The buffer to write the converted pixel data to
• useRGBA: boolean
Whether to output RGBA (true) or RGB (false)
Returns
void
convertPaletteColorWithFetch()
convertPaletteColorWithFetch: (
imageFrame,colorBuffer,useRGBA) =>Promise<void>
Convert pixel data with PALETTE COLOR Photometric Interpretation to RGB/RGBA with automatic fetching of palette color lookup tables if not already loaded. This is useful for users who want to convert palette color frames without manually fetching the palette data first.
Parameters
• imageFrame: ImageFrame
The ImageFrame to convert
• colorBuffer: ByteArray
The buffer to write the converted pixel data to
• useRGBA: boolean
Whether to output RGBA (true) or RGB (false)
Returns
Promise<void>
Promise that resolves when conversion is complete
convertRGBColorByPixel()
convertRGBColorByPixel: (
imageFrame,colorBuffer,useRGBA) =>void
Parameters
• imageFrame: ByteArray
• colorBuffer: ByteArray
• useRGBA: boolean
Returns
void
convertRGBColorByPlane()
convertRGBColorByPlane: (
imageFrame,colorBuffer,useRGBA) =>void
Parameters
• imageFrame: ByteArray
• colorBuffer: ByteArray
• useRGBA: boolean
Returns
void
convertYBRFullByPixel()
convertYBRFullByPixel: (
imageFrame,colorBuffer,useRGBA) =>void
Parameters
• imageFrame: ByteArray
• colorBuffer: ByteArray
• useRGBA: boolean
Returns
void
convertYBRFullByPlane()
convertYBRFullByPlane: (
imageFrame,colorBuffer,useRGBA) =>void
Parameters
• imageFrame: ByteArray
• colorBuffer: ByteArray
• useRGBA: boolean
Returns
void
createImage()
createImage: (
imageId,pixelData,transferSyntax,options) =>Promise<DICOMLoaderIImage|Types.IImageFrame>
Parameters
• imageId: string
• pixelData: ByteArray
• transferSyntax: string
• options: DICOMLoaderImageOptions = {}
Returns
Promise<DICOMLoaderIImage | Types.IImageFrame>
decodeImageFrame()
decodeImageFrame: (
imageFrame,transferSyntax,pixelData,decodeConfig,options,callbackFn) =>Promise<any>
Decodes the provided image frame. This is an async function return the result, or you can provide an optional callbackFn that is called with the results.
Parameters
• imageFrame: any
• transferSyntax: any
• pixelData: any
• decodeConfig: any
• options: any
• callbackFn: any
Returns
Promise<any>
decodeJPEGBaseline8BitColor()
decodeJPEGBaseline8BitColor: (
imageFrame,pixelData,canvas) =>Promise<Types.IImageFrame>
Parameters
• imageFrame: ImageFrame
• pixelData: ByteArray
• canvas: HTMLCanvasElement
Returns
Promise<Types.IImageFrame>
decoders
decoders:
object
decoders.BigEndian()
BigEndian: (
imageFrame,pixelData) =>Promise<Types.IImageFrame> =decodeBigEndian
Parameters
• imageFrame: ImageFrame
• pixelData: ByteArray
Returns
Promise<Types.IImageFrame>
decoders.HTJ2K()
HTJ2K: (
compressedImageFrame,imageInfo) =>Promise<any> =decodeHTJ2K
Parameters
• compressedImageFrame: ByteArray
• imageInfo: any
Returns
Promise<any>
decoders.JPEG2000()
JPEG2000: (
compressedImageFrame,imageInfo) =>Promise<Types.IImageFrame> =decodeJPEG2000
Parameters
• compressedImageFrame: any
• imageInfo: any
Returns
Promise<Types.IImageFrame>
decoders.JPEGBaseline12Bit()
JPEGBaseline12Bit: (
imageFrame,pixelData) =>Promise<Types.IImageFrame> =decodeJPEGBaseline12Bit
Parameters
• imageFrame: ImageFrame
• pixelData: ByteArray
Returns
Promise<Types.IImageFrame>
decoders.JPEGBaseline8Bit()
JPEGBaseline8Bit: (
compressedImageFrame,imageInfo) =>Promise<Types.IImageFrame> =decodeJPEGBaseline8Bit
Parameters
• compressedImageFrame: any
• imageInfo: any
Returns
Promise<Types.IImageFrame>
decoders.JPEGLossless()
JPEGLossless: (
imageFrame,pixelData) =>Promise<Types.IImageFrame> =decodeJPEGLossless
Parameters
• imageFrame: ImageFrame
• pixelData: ByteArray
Returns
Promise<Types.IImageFrame>
decoders.JPEGLS()
JPEGLS: (
compressedImageFrame,imageInfo) =>Promise<Types.IImageFrame> =decodeJPEGLS
Parameters
• compressedImageFrame: any
• imageInfo: any
Returns
Promise<Types.IImageFrame>
decoders.LittleEndian()
LittleEndian: (
imageFrame,pixelData) =>Promise<Types.IImageFrame> =decodeLittleEndian
Parameters
• imageFrame: ImageFrame
• pixelData: ByteArray
Returns
Promise<Types.IImageFrame>
decoders.RLE()
RLE: (
imageFrame,pixelData) =>Promise<Types.IImageFrame> =decodeRLE
Parameters
• imageFrame: ImageFrame
• pixelData: ByteArray
Returns
Promise<Types.IImageFrame>
getImageFrame()
getImageFrame: (
imageId) =>Types.IImageFrame
Parameters
• imageId: string
Returns
Types.IImageFrame
getMinMax()
getMinMax: (
storedPixelData) =>object
Calculate the minimum and maximum values in an Array
Parameters
• storedPixelData: PixelDataTypedArray
Returns
object
max
max:
number
min
min:
number
getPixelData()
getPixelData: (
uri,imageId,mediaType,options?) =>LoaderXhrRequestPromise<object> |PromiseIterator<unknown> |Promise<object|object>
Parameters
• uri: string
• imageId: string
• mediaType: string = 'application/octet-stream'
• options?: CornerstoneWadoRsLoaderOptions
Returns
LoaderXhrRequestPromise<object> | PromiseIterator<unknown> | Promise<object | object>
init()
init: (
options) =>void
Parameters
• options: LoaderOptions = {}
Returns
void
initializers
initializers:
object
initializers.HTJ2K()
HTJ2K: (
decodeConfig?) =>Promise<void> =initializeHTJ2K
Parameters
• decodeConfig?: LoaderDecodeOptions
Returns
Promise<void>
initializers.JPEG2000()
JPEG2000: (
decodeConfig?) =>Promise<void> =initializeJPEG2000
Parameters
• decodeConfig?: WebWorkerDecodeConfig
Returns
Promise<void>
initializers.JPEGBaseline12Bit()
JPEGBaseline12Bit: (
decodeConfig?) =>Promise<void> =initializeJPEGBaseline12Bit
Parameters
• decodeConfig?: WebWorkerDecodeConfig
Returns
Promise<void>
initializers.JPEGBaseline8Bit()
JPEGBaseline8Bit: (
decodeConfig?) =>Promise<void> =initLibjpegTurbo
Parameters
• decodeConfig?: LoaderDecodeOptions
Returns
Promise<void>
initializers.JPEGLossless()
JPEGLossless: (
decodeConfig?) =>Promise<void> =initializeJPEGLossless
Parameters
• decodeConfig?: WebWorkerDecodeConfig
Returns
Promise<void>
initializers.JPEGLS()
JPEGLS: (
decodeConfig?) =>Promise<void> =initializeJPEGLS
Parameters
• decodeConfig?: WebWorkerDecodeConfig
Returns
Promise<void>
internal
internal:
object
internal.getOptions()
getOptions: () =>
LoaderOptions
Returns
internal.setOptions()
setOptions: (
newOptions) =>void
Parameters
• newOptions: LoaderOptions
Returns
void
internal.streamRequest()
streamRequest: (
url,imageId,defaultHeaders,options) =>PromiseIterator<unknown>
This function does a streaming parse from an http request, delivering combined/subsequent parts of the result as iterations on a ProgressiveIterator instance.
Parameters
• url: string
to request and parse as either multipart or singlepart.
• imageId: string
the imageId to be used in the returned detail object
• defaultHeaders: Record<string, string> = {}
• options: CornerstoneWadoRsLoaderOptions = {}
Returns
PromiseIterator<unknown>
internal.xhrRequest()
xhrRequest: (
url,imageId,defaultHeaders,params) =>LoaderXhrRequestPromise<ArrayBuffer>
Parameters
• url: string
• imageId: string
• defaultHeaders: Record<string, string> = {}
• params: LoaderXhrRequestParams = {}
Returns
LoaderXhrRequestPromise<ArrayBuffer>
isColorImage()
isColorImage: (
photoMetricInterpretation) =>boolean
Parameters
• photoMetricInterpretation: string
Returns
boolean
isJPEGBaseline8BitColor()
isJPEGBaseline8BitColor: (
imageFrame,transferSyntax) =>boolean
Parameters
• imageFrame: ImageFrame
• transferSyntax: string
Returns
boolean
postProcessDecodedPixels()
postProcessDecodedPixels: (
imageFrame,options,start,decodeConfig) =>any
Parameters
• imageFrame: any
• options: any
• start: any
• decodeConfig: any
Returns
any
prefetchPart10Instance()
prefetchPart10Instance: (
baseImageId,part10) =>Promise<never>
Registers a full Part 10 multiframe instance into the NATURALIZED metadata
registry (the single uniform frame registry) so that subsequent per-frame
image loads — WADO-RS (loadImageFromCompressedFrameRegistry) and WADO-URI
(loadImageFromNaturalizedMetadata) — are served from the registry's
compressed frame data instead of issuing one network request per frame.
Parsing is done by addDicomPart10Instance, which uses the dcmjs
AsyncDicomReader; the decode path for each frame is unchanged.
Parameters
• baseImageId: string
The instance imageId. Frame qualifiers (/frames/N,
?frame=N, &frame=N) are normalized away by the registry, so passing a
base or a frame imageId resolves to the same instance key.
• part10: Part10Input
The Part 10 ArrayBuffer/Uint8Array, or a (possibly async)
resolver returning it. A resolver lets the fetch start lazily and be
raced against a deadline by the caller.
Returns
Promise<never>
A promise that resolves once the instance is parsed and registered.
wadors
wadors:
object
wadors.findIndexOfString()
findIndexOfString: (
data,str,offset?) =>number
Parameters
• data: Uint8Array
• str: string
• offset?: number
Returns
number
wadors.getPixelData()
getPixelData: (
uri,imageId,mediaType,options?) =>LoaderXhrRequestPromise<object> |PromiseIterator<unknown> |Promise<object|object>
Parameters
• uri: string
• imageId: string
• mediaType: string = 'application/octet-stream'
• options?: CornerstoneWadoRsLoaderOptions
Returns
LoaderXhrRequestPromise<object> | PromiseIterator<unknown> | Promise<object | object>
wadors.loadImage()
loadImage: (
imageId,options) =>Types.IImageLoadObject
Parameters
• imageId: string
• options: CornerstoneWadoRsLoaderOptions = {}
Returns
Types.IImageLoadObject
wadors.metaData
metaData:
object
wadors.metaData.getNumberString()
getNumberString: (
element,index?,defaultValue?) =>number
Returns the first string value as a Javascript number
Parameters
• element: WADORSMetaDataElement<boolean | number[] | string[]>
The javascript object for the specified element in the metadata
• index?: number
the index of the value in a multi-valued element, default is 0
• defaultValue?: number
The default value to return if the element does not exist
Returns
number
wadors.metaData.getNumberValue()
getNumberValue: (
element,index?) =>number
Parameters
• element: WADORSMetaDataElement<boolean | number[] | string[]>
• index?: number
Returns
number
wadors.metaData.getNumberValues()
getNumberValues: (
element,minimumLength?) =>number[]
Returns the values as an array of javascript numbers
Parameters
• element: WADORSMetaDataElement<boolean | number[] | string[]>
The javascript object for the specified element in the metadata
• minimumLength?: number
the minimum number of values
Returns
number[]
wadors.metaData.getValue()
getValue: <
ReturnType>(element,index?,defaultValue?) =>ReturnType
Returns the raw value
Type Parameters
• ReturnType = unknown
Parameters
• element: WADORSMetaDataElement<boolean | number[] | string[]>
The javascript object for the specified element in the metadata
• index?: number
the index of the value in a multi-valued element, default is 0
• defaultValue?: ReturnType
The default value to return if the element does not exist
Returns
ReturnType
wadors.metaData.metaDataProvider()
metaDataProvider: (
type,imageId) =>object
Parameters
• type: any
• imageId: any
Returns
object
Deprecated
Use addDicomWebInstance from @cornerstonejs/metadata instead.
wadors.metaDataManager
metaDataManager:
object
wadors.metaDataManager.add()
add: (
imageId,metadata) =>void
Parameters
• imageId: string
• metadata: WADORSMetaData
Returns
void
wadors.metaDataManager.get()
get: (
imageId) =>WADORSMetaData
Parameters
• imageId: string
Returns
wadors.metaDataManager.purge()
purge: () =>
void
Returns
void
wadors.metaDataManager.remove()
remove: (
imageId) =>void
Parameters
• imageId: any
Returns
void
wadors.register()
register: (
options?) =>void
Registers the wadors scheme image loader, and either the default metadata providers to use those, or the legacy metadata providers when options?.useLegacyMetadataProvider is true.
Parameters
• options?
• options.useLegacyMetadataProvider?: boolean
Returns
void
wadouri
wadouri:
object
wadouri.dataSetCacheManager
dataSetCacheManager:
object
wadouri.dataSetCacheManager.get()
get: (
uri) =>DataSet
Parameters
• uri: string
Returns
DataSet
wadouri.dataSetCacheManager.getInfo()
getInfo: () =>
CornerstoneWadoLoaderCacheManagerInfoResponse
Returns
CornerstoneWadoLoaderCacheManagerInfoResponse
wadouri.dataSetCacheManager.isLoaded()
isLoaded: (
uri) =>boolean
Parameters
• uri: string
Returns
boolean
wadouri.dataSetCacheManager.load()
load: (
uri,loadRequest,imageId) =>CornerstoneWadoLoaderCachedPromise
Parameters
• uri: string
• loadRequest: LoadRequestFunction = ...
• imageId: string
Returns
CornerstoneWadoLoaderCachedPromise
wadouri.dataSetCacheManager.purge()
purge: () =>
void
Returns
void
wadouri.dataSetCacheManager.unload()
unload: (
uri) =>void
Parameters
• uri: string
Returns
void
wadouri.dataSetCacheManager.update()
update: (
uri,dataSet) =>void
Parameters
• uri: string
• dataSet: DataSet
Returns
void
wadouri.fileManager
fileManager:
object
wadouri.fileManager.add()
add: (
file) =>string
Parameters
• file: Blob
Returns
string
wadouri.fileManager.get()
get: (
index) =>Blob
Parameters
• index: number
Returns
Blob
wadouri.fileManager.purge()
purge: () =>
void
Returns
void
wadouri.fileManager.remove()
remove: (
index) =>void
Parameters
• index: number
Returns
void
wadouri.getEncapsulatedImageFrame()
getEncapsulatedImageFrame: (
dataSet,frameIndex) =>ByteArray
Parameters
• dataSet: DataSet
• frameIndex: number
Returns
ByteArray
wadouri.getLoaderForScheme()
getLoaderForScheme: (
scheme) =>LoadRequestFunction
Parameters
• scheme: string
Returns
wadouri.getPixelData()
getPixelData: (
dataSet,frameIndex) =>ByteArray
Parameters
• dataSet: DataSet
• frameIndex: number = 0
Returns
ByteArray
wadouri.getUncompressedImageFrame()
getUncompressedImageFrame: (
dataSet,frameIndex) =>Uint8Array
Function to deal with extracting an image frame from an encapsulated data set.
Parameters
• dataSet: DataSet
• frameIndex: number
Returns
Uint8Array
wadouri.loadFileRequest()
loadFileRequest: (
uri) =>Promise<ArrayBuffer>
Parameters
• uri: string
Returns
Promise<ArrayBuffer>
wadouri.loadImage()
loadImage: (
imageId,options) =>IImageLoadObject
Legacy image loader entry point used when useLegacyMetadataProvider is true.
This conforms to Types.ImageLoaderFn (imageId, options) and internally
uses dataSetCacheManager.load plus loadImageFromPromise.
Parameters
• imageId: string
• options: DICOMLoaderImageOptions = {}
Returns
IImageLoadObject
Deprecated
This loads images using the legacy URI loader, not the newer @cornerstonejs/metadata framework
wadouri.loadImageFromNaturalizedMetadata()
loadImageFromNaturalizedMetadata: (
imageId,options) =>Types.IImageLoadObject
Loads an image from the NATURALIZED path: ensures NATURALIZED is populated (fetch +
addDicomPart10Instance when needed), gets frame pixel data via getMetaData(MetadataModules.COMPRESSED_FRAME_DATA, imageId, { frameIndex }),
then creates IImage. Does not use dataSetCacheManager.
Parameters
• imageId: string
• options: DICOMLoaderImageOptions = {}
Returns
Types.IImageLoadObject
wadouri.loadImageFromPromise()
loadImageFromPromise: (
dataSetPromise,imageId,frame,sharedCacheKey,options,callbacks?) =>Types.IImageLoadObject
Given the dataSetPromise and imageId this will return a promise to be resolved with an image object containing the loaded image.
Parameters
• dataSetPromise: Promise<DataSet>
A promise that resolves to a DataSet object.
• imageId: string
The imageId of the image to be loaded.
• frame: number = 0
The frame number to be loaded in case of multiframe. it should be noted that this is used to extract the pixelData from dicomParser and dicomParser is 0-based index (the first pixelData is frame 0); however, in metadata and imageId frame is 1-based index (the first frame is frame 1).
• sharedCacheKey: string
A key to be used to cache the loaded image.
• options: DICOMLoaderImageOptions
Options to be used when loading the image.
• callbacks?
Callbacks to be called when the image is loaded.
• callbacks.imageDoneCallback?
Returns
Types.IImageLoadObject
An object containing a promise to be resolved with the loaded image
wadouri.metaData
metaData:
object
wadouri.metaData.getImagePixelModule()
getImagePixelModule: (
dataSet) =>Types.ImagePixelModuleMetadata
Parameters
• dataSet: DataSet
Returns
Types.ImagePixelModuleMetadata
wadouri.metaData.getLUTs()
getLUTs: (
pixelRepresentation,lutSequence) =>LutType[]
Parameters
• pixelRepresentation: number
• lutSequence: Element
Returns
LutType[]
wadouri.metaData.getModalityLUTOutputPixelRepresentation()
getModalityLUTOutputPixelRepresentation: (
dataSet) =>number
Parameters
• dataSet: DataSet
Returns
number
wadouri.metaData.getNumberValues()
getNumberValues: (
dataSet,tag,minimumLength) =>number[]
Parameters
• dataSet: DataSet
• tag: string
• minimumLength: number
Returns
number[]
wadouri.metaData.metadataForDataset()
metadataForDataset: (
type,imageId,dataSet) =>any
Parameters
• type: any
• imageId: any
• dataSet: DataSet
Returns
any
wadouri.metaData.metaDataProvider()
metaDataProvider: (
type,imageId) =>any
Parameters
• type: any
• imageId: any
Returns
any
Deprecated
Use addDicomPart10Instance from @cornerstonejs/metadata instead.
wadouri.parseImageId()
parseImageId: (
imageId) =>CornerstoneImageUrl
Parameters
• imageId: string
Returns
CornerstoneImageUrl
wadouri.register()
register: (
options?) =>void
Registers the image loaders for Part 10 DICOM files, and either the default metadata providers to use those, or the legacy metadata providers when options?.useLegacyMetadataProvider is true.
Parameters
• options?
• options.useLegacyMetadataProvider?: boolean
Returns
void
wadouri.unpackBinaryFrame()
unpackBinaryFrame: (
byteArray,frameOffset,pixelsPerFrame) =>Uint8Array
Function to deal with unpacking a binary frame
Parameters
• byteArray: ByteArray
• frameOffset: number
• pixelsPerFrame: number
Returns
Uint8Array