Skip to main content

Interface: IImage

Cornerstone Image interface, it is used for both CPU and GPU rendering

Properties​

bufferView?​

optional bufferView: object

buffer​

buffer: ArrayBuffer

offset​

offset: number

Defined in​

packages/core/src/types/IImage.ts:144

cachedLut?​

optional cachedLut: object

CPU: image cached LUT

invert?​

optional invert: boolean

lutArray?​

optional lutArray: Uint8ClampedArray

modalityLUT?​

optional modalityLUT: CPUFallbackLUT

voiLUT?​

optional voiLUT: CPUFallbackLUT

windowCenter?​

optional windowCenter: number | number[]

windowWidth?​

optional windowWidth: number | number[]

Defined in​

packages/core/src/types/IImage.ts:126

calibration?​

optional calibration: IImageCalibration

Defined in​

packages/core/src/types/IImage.ts:136

color​

color: boolean

is image a color image

Defined in​

packages/core/src/types/IImage.ts:75

colormap?​

optional colormap: CPUFallbackColormap

CPU: custom color map for image

Defined in​

packages/core/src/types/IImage.ts:102

columnPixelSpacing​

columnPixelSpacing: number

column pixel spacing

Defined in​

packages/core/src/types/IImage.ts:86

columns​

columns: number

image number of columns

Defined in​

packages/core/src/types/IImage.ts:69

dataType​

dataType: PixelDataTypedArrayString

Defined in​

packages/core/src/types/IImage.ts:140

decodeTimeInMS?​

optional decodeTimeInMS: number

Defined in​

packages/core/src/types/IImage.ts:115

FrameOfReferenceUID?​

optional FrameOfReferenceUID: string

Defined in​

packages/core/src/types/IImage.ts:139

getCanvas()​

getCanvas: () => HTMLCanvasElement

Returns​

HTMLCanvasElement

Defined in​

packages/core/src/types/IImage.ts:65

getPixelData()​

getPixelData: () => PixelDataTypedArray

function that returns the pixelData as an array

Returns​

PixelDataTypedArray

Defined in​

packages/core/src/types/IImage.ts:64

height​

height: number

image height

Defined in​

packages/core/src/types/IImage.ts:71

imageFrame?​

optional imageFrame: IImageFrame

Defined in​

packages/core/src/types/IImage.ts:137

imageId​

imageId: string

Image Id

Defined in​

packages/core/src/types/IImage.ts:26

imageQualityStatus?​

optional imageQualityStatus: ImageQualityStatus

Defined in​

packages/core/src/types/IImage.ts:135

intercept​

intercept: number

intercept from metadata for scaling

Defined in​

packages/core/src/types/IImage.ts:56

invert​

invert: boolean

whether image pixels are inverted in color

Defined in​

packages/core/src/types/IImage.ts:92

isPreScaled?​

optional isPreScaled: boolean

Whether the image is Pre-scaled during loading

Defined in​

packages/core/src/types/IImage.ts:31

loadTimeInMS?​

optional loadTimeInMS: number

Defined in​

packages/core/src/types/IImage.ts:114

maxPixelValue​

maxPixelValue: number

Defined in​

packages/core/src/types/IImage.ts:52

minPixelValue​

minPixelValue: number

minimum pixel value of the image

Defined in​

packages/core/src/types/IImage.ts:50

modalityLUT?​

optional modalityLUT: CPUFallbackLUT

CPU: custom modality LUT for image

Defined in​

packages/core/src/types/IImage.ts:98

numberOfComponents​

numberOfComponents: number

number of components in the image

Defined in​

packages/core/src/types/IImage.ts:79

photometricInterpretation?​

optional photometricInterpretation: string

image photometric interpretation

Defined in​

packages/core/src/types/IImage.ts:94

preScale?​

optional preScale: object

preScale object

enabled​

enabled: boolean

scaled?​

optional scaled: boolean

boolean flag to indicate whether the image has been scaled

scalingParameters?​

optional scalingParameters: object

scaling parameters

scalingParameters.modality?​

optional modality: string

modality of the image

scalingParameters.rescaleIntercept?​

optional rescaleIntercept: number

rescale intercept

scalingParameters.rescaleSlope?​

optional rescaleSlope: number

rescale slop

scalingParameters.suvbw?​

optional suvbw: number

PT suvbw

Defined in​

packages/core/src/types/IImage.ts:33

referencedImageId?​

optional referencedImageId: string

referenced imageId if this image is derived from

Defined in​

packages/core/src/types/IImage.ts:28

render()?​

optional render: (enabledElement, invalidated) => unknown

CPU: custom render method for the image

Parameters​

• enabledElement: CPUFallbackEnabledElement

• invalidated: boolean

Returns​

unknown

Defined in​

packages/core/src/types/IImage.ts:81

rgba​

rgba: boolean

is image rgb and alpha

Defined in​

packages/core/src/types/IImage.ts:77

rowPixelSpacing​

rowPixelSpacing: number

row pixel spacing

Defined in​

packages/core/src/types/IImage.ts:88

rows​

rows: number

image number of rows

Defined in​

packages/core/src/types/IImage.ts:67

scaling?​

optional scaling: object

image scaling metadata - including PT suv values

PT?​

optional PT: object

PT.SUVbsaFactor?​

optional SUVbsaFactor: number

PT.suvbwToSuvbsa?​

optional suvbwToSuvbsa: number

PT.suvbwToSuvlbm?​

optional suvbwToSuvlbm: number

PT.SUVlbmFactor?​

optional SUVlbmFactor: number

Defined in​

packages/core/src/types/IImage.ts:104

sharedCacheKey?​

optional sharedCacheKey: string

Defined in​

packages/core/src/types/IImage.ts:29

sizeInBytes​

sizeInBytes: number

image size in number of bytes

Defined in​

packages/core/src/types/IImage.ts:96

sliceThickness?​

optional sliceThickness: number

slice thickness

Defined in​

packages/core/src/types/IImage.ts:90

slope​

slope: number

slope from metadata for scaling

Defined in​

packages/core/src/types/IImage.ts:54

stats?​

optional stats: object

CPU: image statistics for rendering

lastGetPixelDataTime?​

optional lastGetPixelDataTime: number

lastLutGenerateTime?​

optional lastLutGenerateTime: number

lastPutImageDataTime?​

optional lastPutImageDataTime: number

lastRenderedViewport?​

optional lastRenderedViewport: unknown

lastRenderTime?​

optional lastRenderTime: number

lastStoredPixelDataToCanvasImageDataTime?​

optional lastStoredPixelDataToCanvasImageDataTime: number

Defined in​

packages/core/src/types/IImage.ts:117

voiLUT?​

optional voiLUT: CPUFallbackLUT

CPU: custom VOI LUT for image

Defined in​

packages/core/src/types/IImage.ts:100

voiLUTFunction​

voiLUTFunction: VOILUTFunctionType

voiLUTFunction from metadata

Defined in​

packages/core/src/types/IImage.ts:62

voxelManager?​

optional voxelManager: IVoxelManager<number> | IVoxelManager<RGB>

Defined in​

packages/core/src/types/IImage.ts:142

width​

width: number

image width

Defined in​

packages/core/src/types/IImage.ts:73

windowCenter​

windowCenter: number | number[]

windowCenter from metadata

Defined in​

packages/core/src/types/IImage.ts:58

windowWidth​

windowWidth: number | number[]

windowWidth from metadata

Defined in​

packages/core/src/types/IImage.ts:60