image attr - HackMD

--- tags: ohif --- # image attr <ul> <li><code>imageId</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank">string</a> The imageId associated with this image object</li> <li><code>minPixelValue</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> the minimum stored pixel value in the image</li> <li><code>maxPixelValue</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> the maximum stored pixel value in the image</li> <li><code>slope</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> the rescale slope to convert stored pixel values to modality pixel values or 1 if not specified</li> <li><code>intercept</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> the rescale intercept used to convert stored pixel values to modality values or 0 if not specified</li> <li><code>windowCenter</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> the default windowCenter to apply to the image</li> <li><code>windowWidth</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> the default windowWidth to apply to the image</li> <li><code>getPixelData</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function" target="_blank">function</a> a function that returns the underlying pixel data. An array of integers for grayscale and an array of RGBA for color</li> <li><code>getImageData</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function" target="_blank">function</a> a function that returns a canvas imageData object for the image. This is only needed for color images</li> <li><code>getCanvas</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function" target="_blank">function</a> a function that returns a canvas element with the image loaded into it. This is only needed for color images.</li> <li><code>getImage</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function" target="_blank">function</a> a function that returns a JavaScript Image object with the image data. This is optional and typically used for images encoded in standard web JPEG and PNG formats</li> <li><code>rows</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> number of rows in the image. This is the same as height but duplicated for convenience</li> <li><code>columns</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> number of columns in the image. This is the same as width but duplicated for convenience</li> <li><code>height</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> the height of the image. This is the same as rows but duplicated for convenience</li> <li><code>width</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> the width of the image. This is the same as columns but duplicated for convenience</li> <li><code>color</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank">Boolean</a> true if pixel data is RGB, false if grayscale</li> <li><code>lut</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank">Object</a> The Lookup Table</li> <li><code>rgba</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank">Boolean</a> Is the color pixel data stored in RGBA?</li> <li><code>columnPixelSpacing</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> horizontal distance between the middle of each pixel (or width of each pixel) in mm or undefined if not known</li> <li><code>rowPixelSpacing</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> vertical distance between the middle of each pixel (or height of each pixel) in mm or undefined if not known</li> <li><code>invert</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank">Boolean</a> true if the the image should initially be displayed be inverted, false if not. This is here mainly to support DICOM images with a photometric interpretation of MONOCHROME1</li> <li><code>sizeInBytes</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number" target="_blank">Number</a> the number of bytes used to store the pixels for this image.</li> <li><code>falseColor</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank">Boolean</a>? Whether or not the image has undergone false color mapping</li> <li><code>origPixelData</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array" target="_blank">Array</a>? Original pixel data for an image after it has undergone false color mapping</li> <li><code>stats</code> ImageStats? Statistics for the last redraw of the image</li> <li><code>cachedLut</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object" target="_blank">Object</a> Cached Lookup Table for this image.</li> <li><code>colormap</code> (<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String" target="_blank">String</a> | Colormap)? an optional colormap ID or colormap object (from colors/colormap.js). This will be applied during rendering to convert the image to pseudocolor</li> <li><code>labelmap</code> <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean" target="_blank">Boolean</a>? whether or not to render this image as a label map (i.e. skip modality and VOI LUT pipelines and use only a color lookup table)</li> </ul>