cornerstone-wado-image-loader
Version:
Cornerstone Image Loader for DICOM WADO-URI and WADO-RS
4,163 lines (958 loc) • 71.1 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Global - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
<script src="scripts/nav.js" defer></script>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav >
<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.html#addTask">addTask</a></li><li><a href="global.html#arrayBufferToString">arrayBufferToString</a></li><li><a href="global.html#cacheSizeInBytes">cacheSizeInBytes</a></li><li><a href="global.html#cancelTask">cancelTask</a></li><li><a href="global.html#decodeAsync">decodeAsync</a></li><li><a href="global.html#decodeImageFrame">decodeImageFrame</a></li><li><a href="global.html#extractOrientationFromDataset">extractOrientationFromDataset</a></li><li><a href="global.html#extractOrientationFromMetadata">extractOrientationFromMetadata</a></li><li><a href="global.html#extractOrientationFromNMMultiframeDataset">extractOrientationFromNMMultiframeDataset</a></li><li><a href="global.html#extractOrientationFromNMMultiframeMetadata">extractOrientationFromNMMultiframeMetadata</a></li><li><a href="global.html#extractPositionFromDataset">extractPositionFromDataset</a></li><li><a href="global.html#extractPositionFromMetadata">extractPositionFromMetadata</a></li><li><a href="global.html#extractPositionFromNMMultiframeDataset">extractPositionFromNMMultiframeDataset</a></li><li><a href="global.html#extractPositionFromNMMultiframeMetadata">extractPositionFromNMMultiframeMetadata</a></li><li><a href="global.html#extractSliceThicknessFromDataset">extractSliceThicknessFromDataset</a></li><li><a href="global.html#extractSpacingFromDataset">extractSpacingFromDataset</a></li><li><a href="global.html#framesAreFragmented">framesAreFragmented</a></li><li><a href="global.html#getImageTypeSubItemFromDataset">getImageTypeSubItemFromDataset</a></li><li><a href="global.html#getImageTypeSubItemFromMetadata">getImageTypeSubItemFromMetadata</a></li><li><a href="global.html#getMinMax">getMinMax</a></li><li><a href="global.html#getNumberString">getNumberString</a></li><li><a href="global.html#getNumberValues">getNumberValues</a></li><li><a href="global.html#getStatistics">getStatistics</a></li><li><a href="global.html#getTransferSyntaxForContentType">getTransferSyntaxForContentType</a></li><li><a href="global.html#getUncompressedImageFrame">getUncompressedImageFrame</a></li><li><a href="global.html#getValue">getValue</a></li><li><a href="global.html#handleMessageFromWorker">handleMessageFromWorker</a></li><li><a href="global.html#handler">handler</a></li><li><a href="global.html#initialize">initialize</a></li><li><a href="global.html#loadCodecs">loadCodecs</a></li><li><a href="global.html#loadWebWorkerTask">loadWebWorkerTask</a></li><li><a href="global.html#registerLoaders">registerLoaders</a></li><li><a href="global.html#registerTaskHandler">registerTaskHandler</a></li><li><a href="global.html#removeAFromRGBA">removeAFromRGBA</a></li><li><a href="global.html#setPixelDataType">setPixelDataType</a></li><li><a href="global.html#setTaskPriority">setTaskPriority</a></li><li><a href="global.html#spawnWebWorker">spawnWebWorker</a></li><li><a href="global.html#startTaskOnWebWorker">startTaskOnWebWorker</a></li><li><a href="global.html#terminate">terminate</a></li><li><a href="global.html#unpackBinaryFrame">unpackBinaryFrame</a></li></ul>
</nav>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2>
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="cacheSizeInBytes"><span class="type-signature"></span>cacheSizeInBytes<span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadouri_dataSetCacheManager.js.html">imageLoader/wadouri/dataSetCacheManager.js</a>, <a href="imageLoader_wadouri_dataSetCacheManager.js.html#line13">line 13</a>
</li></ul></dd>
</dl>
<div class="description usertext">
This object supports loading of DICOM P10 dataset from a uri and caching it so it can be accessed
by the caller. This allows a caller to access the datasets without having to go through cornerstone's
image loader mechanism. One reason a caller may need to do this is to determine the number of frames
in a multiframe sop instance so it can create the imageId's correctly.
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="addTask"><span class="type-signature"></span>addTask<span class="signature">(taskType, data, priority, transferList)</span><span class="type-signature"> → {*}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_webWorkerManager.js.html">imageLoader/webWorkerManager.js</a>, <a href="imageLoader_webWorkerManager.js.html#line246">line 246</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Function to add a decode task to be performed
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>taskType</code></td>
<td class="type">
</td>
<td class="default">
</td>
<td class="description last">the taskType for this task</td>
</tr>
<tr>
<td class="name"><code>data</code></td>
<td class="type">
</td>
<td class="default">
</td>
<td class="description last">data specific to the task</td>
</tr>
<tr>
<td class="name"><code>priority</code></td>
<td class="type">
</td>
<td class="default">
<code>0</code>
</td>
<td class="description last">optional priority of the task (defaults to 0), > 0 is higher, < 0 is lower</td>
</tr>
<tr>
<td class="name"><code>transferList</code></td>
<td class="type">
</td>
<td class="default">
</td>
<td class="description last">optional array of data to transfer to web worker</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
<h4 class="name" id="arrayBufferToString"><span class="type-signature"></span>arrayBufferToString<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_decodeJPEGBaseline8BitColor.js.html">imageLoader/decodeJPEGBaseline8BitColor.js</a>, <a href="imageLoader_decodeJPEGBaseline8BitColor.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Special decoder for 8 bit jpeg that leverages the browser's built in JPEG decoder for increased performance
</div>
<h4 class="name" id="cancelTask"><span class="type-signature"></span>cancelTask<span class="signature">(taskId, reason)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_webWorkerManager.js.html">imageLoader/webWorkerManager.js</a>, <a href="imageLoader_webWorkerManager.js.html#line330">line 330</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Cancels a queued task and rejects
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>taskId</code></td>
<td class="type">
</td>
<td class="description last">the taskId to cancel</td>
</tr>
<tr>
<td class="name"><code>reason</code></td>
<td class="type">
</td>
<td class="description last">optional reason the task was rejected</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
boolean - true on success, false if taskId not found
</div>
<h4 class="name" id="decodeAsync"><span class="type-signature">(async) </span>decodeAsync<span class="signature">(compressedImageFrame, imageInfo)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="shared_decoders_decodeJPEGBaseline12Bit-wasm-not-yet-working.js.html">shared/decoders/decodeJPEGBaseline12Bit-wasm-not-yet-working.js</a>, <a href="shared_decoders_decodeJPEGBaseline12Bit-wasm-not-yet-working.js.html#line42">line 42</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>compressedImageFrame</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>imageInfo</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>signed</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">-</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="decodeAsync"><span class="type-signature">(async) </span>decodeAsync<span class="signature">(compressedImageFrame, imageInfo)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="shared_decoders_decodeJPEGBaseline8Bit.js.html">shared/decoders/decodeJPEGBaseline8Bit.js</a>, <a href="shared_decoders_decodeJPEGBaseline8Bit.js.html#line42">line 42</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>compressedImageFrame</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>imageInfo</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>signed</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">-</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="decodeAsync"><span class="type-signature">(async) </span>decodeAsync<span class="signature">(compressedImageFrame, imageInfo)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="shared_decoders_decodeJPEGLS.js.html">shared/decoders/decodeJPEGLS.js</a>, <a href="shared_decoders_decodeJPEGLS.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>compressedImageFrame</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>imageInfo</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last">
<h6>Properties</h6>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>signed</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">(pixelRepresentation === 1)</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<h4 class="name" id="decodeImageFrame"><span class="type-signature">(async) </span>decodeImageFrame<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="shared_decodeImageFrame.js.html">shared/decodeImageFrame.js</a>, <a href="shared_decodeImageFrame.js.html#line19">line 19</a>
</li></ul></dd>
</dl>
<div class="description usertext">
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.
</div>
<h4 class="name" id="extractOrientationFromDataset"><span class="type-signature"></span>extractOrientationFromDataset<span class="signature">(dataSet)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html">imageLoader/wadouri/metaData/extractPositioningFromDataset.js</a>, <a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html#line80">line 80</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Extract orientation information from a dataset. It tries to get the orientation
from the Detector Information Sequence (for NM images) if image type equal
to RECON TOMO or RECON GATED TOMO
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dataSet</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h4 class="name" id="extractOrientationFromMetadata"><span class="type-signature"></span>extractOrientationFromMetadata<span class="signature">(metaData)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadors_metaData_extractPositioningFromMetadata.js.html">imageLoader/wadors/metaData/extractPositioningFromMetadata.js</a>, <a href="imageLoader_wadors_metaData_extractPositioningFromMetadata.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Extract orientation information from a metadata. It tries to get the orientation
from the Detector Information Sequence (for NM images) if image type equal
to RECON TOMO or RECON GATED TOMO
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>metaData</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h4 class="name" id="extractOrientationFromNMMultiframeDataset"><span class="type-signature"></span>extractOrientationFromNMMultiframeDataset<span class="signature">(dataSet)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html">imageLoader/wadouri/metaData/extractPositioningFromDataset.js</a>, <a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html#line27">line 27</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Extracts the orientation from NM multiframe dataset, if image type
equal to RECON TOMO or RECON GATED TOMO
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dataSet</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h4 class="name" id="extractOrientationFromNMMultiframeMetadata"><span class="type-signature"></span>extractOrientationFromNMMultiframeMetadata<span class="signature">(metaData)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadors_metaData_NMHelpers.js.html">imageLoader/wadors/metaData/NMHelpers.js</a>, <a href="imageLoader_wadors_metaData_NMHelpers.js.html#line36">line 36</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Extracts the orientation from NM multiframe metadata, if image type
equal to RECON TOMO or RECON GATED TOMO
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>metaData</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h4 class="name" id="extractPositionFromDataset"><span class="type-signature"></span>extractPositionFromDataset<span class="signature">(dataSet)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html">imageLoader/wadouri/metaData/extractPositioningFromDataset.js</a>, <a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html#line110">line 110</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Extract position information from a dataset. It tries to get the position
from the Detector Information Sequence (for NM images) if image type equal
to RECON TOMO or RECON GATED TOMO
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dataSet</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h4 class="name" id="extractPositionFromMetadata"><span class="type-signature"></span>extractPositionFromMetadata<span class="signature">(metaData)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadors_metaData_extractPositioningFromMetadata.js.html">imageLoader/wadors/metaData/extractPositioningFromMetadata.js</a>, <a href="imageLoader_wadors_metaData_extractPositioningFromMetadata.js.html#line35">line 35</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Extract position information from a metaData. It tries to get the position
from the Detector Information Sequence (for NM images) if image type equal
to RECON TOMO or RECON GATED TOMO
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>metaData</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h4 class="name" id="extractPositionFromNMMultiframeDataset"><span class="type-signature"></span>extractPositionFromNMMultiframeDataset<span class="signature">(dataSet)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html">imageLoader/wadouri/metaData/extractPositioningFromDataset.js</a>, <a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html#line53">line 53</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Extracts the position from NM multiframe dataset, if image type
equal to RECON TOMO or RECON GATED TOMO
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dataSet</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h4 class="name" id="extractPositionFromNMMultiframeMetadata"><span class="type-signature"></span>extractPositionFromNMMultiframeMetadata<span class="signature">(metaData)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadors_metaData_NMHelpers.js.html">imageLoader/wadors/metaData/NMHelpers.js</a>, <a href="imageLoader_wadors_metaData_NMHelpers.js.html#line59">line 59</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Extracts the position from NM multiframe dataset, if image type
equal to RECON TOMO or RECON GATED TOMO
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>metaData</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h4 class="name" id="extractSliceThicknessFromDataset"><span class="type-signature"></span>extractSliceThicknessFromDataset<span class="signature">(dataSet)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html">imageLoader/wadouri/metaData/extractPositioningFromDataset.js</a>, <a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html#line157">line 157</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Extract the sliceThickness information. If exists, extracts this information
from Pixel Measures Sequence
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dataSet</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h4 class="name" id="extractSpacingFromDataset"><span class="type-signature"></span>extractSpacingFromDataset<span class="signature">(dataSet)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html">imageLoader/wadouri/metaData/extractPositioningFromDataset.js</a>, <a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html#line136">line 136</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Extract the pixelSpacing information. If exists, extracts this information
from Pixel Measures Sequence
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dataSet</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h4 class="name" id="framesAreFragmented"><span class="type-signature"></span>framesAreFragmented<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadouri_getEncapsulatedImageFrame.js.html">imageLoader/wadouri/getEncapsulatedImageFrame.js</a>, <a href="imageLoader_wadouri_getEncapsulatedImageFrame.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Function to deal with extracting an image frame from an encapsulated data set.
</div>
<h4 class="name" id="getImageTypeSubItemFromDataset"><span class="type-signature"></span>getImageTypeSubItemFromDataset<span class="signature">(dataSet, index)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html">imageLoader/wadouri/metaData/extractPositioningFromDataset.js</a>, <a href="imageLoader_wadouri_metaData_extractPositioningFromDataset.js.html#line9">line 9</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Get a subpart of Image Type dicom tag defined by index
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dataSet</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">0 based index of the subtype</td>
</tr>
</tbody>
</table>
<h4 class="name" id="getImageTypeSubItemFromMetadata"><span class="type-signature"></span>getImageTypeSubItemFromMetadata<span class="signature">(metaData, index)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadors_metaData_NMHelpers.js.html">imageLoader/wadors/metaData/NMHelpers.js</a>, <a href="imageLoader_wadors_metaData_NMHelpers.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Get a subpart of Image Type dicom tag defined by index
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>metaData</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
<span class="param-type">*</span>
</td>
<td class="description last">0 based index of the subtype</td>
</tr>
</tbody>
</table>
<h4 class="name" id="getMinMax"><span class="type-signature"></span>getMinMax<span class="signature">(storedPixelData)</span><span class="type-signature"> → {Object}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="shared_getMinMax.js.html">shared/getMinMax.js</a>, <a href="shared_getMinMax.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Calculate the minimum and maximum values in an Array
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>storedPixelData</code></td>
<td class="type">
<span class="param-type">Array.<Number></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id="getNumberString"><span class="type-signature"></span>getNumberString<span class="signature">(element, index<span class="signature-attributes">opt</span>, defaultValue<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {*}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadors_metaData_getNumberString.js.html">imageLoader/wadors/metaData/getNumberString.js</a>, <a href="imageLoader_wadors_metaData_getNumberString.js.html#line11">line 11</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Returns the first string value as a Javascript number
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>element</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="description last">The javascript object for the specified element in the metadata</td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">the index of the value in a multi-valued element, default is 0</td>
</tr>
<tr>
<td class="name"><code>defaultValue</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">The default value to return if the element does not exist</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
<h4 class="name" id="getNumberValues"><span class="type-signature"></span>getNumberValues<span class="signature">(element, minimumLength<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {*}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadors_metaData_getNumberValues.js.html">imageLoader/wadors/metaData/getNumberValues.js</a>, <a href="imageLoader_wadors_metaData_getNumberValues.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Returns the values as an array of javascript numbers
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>element</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="description last">The javascript object for the specified element in the metadata</td>
</tr>
<tr>
<td class="name"><code>minimumLength</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">the minimum number of values</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
<h4 class="name" id="getStatistics"><span class="type-signature"></span>getStatistics<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_webWorkerManager.js.html">imageLoader/webWorkerManager.js</a>, <a href="imageLoader_webWorkerManager.js.html#line350">line 350</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Function to return the statistics on running web workers
</div>
<h5>Returns:</h5>
<div class="param-desc">
object containing statistics
</div>
<h4 class="name" id="getTransferSyntaxForContentType"><span class="type-signature"></span>getTransferSyntaxForContentType<span class="signature">(contentType)</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadors_loadImage.js.html">imageLoader/wadors/loadImage.js</a>, <a href="imageLoader_wadors_loadImage.js.html#line10">line 10</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Helper method to extract the transfer-syntax from the response of the server.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>contentType</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">The value of the content-type header as returned by the WADO-RS server.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
The transfer-syntax as announced by the server, or Implicit Little Endian by default.
</div>
<h4 class="name" id="getUncompressedImageFrame"><span class="type-signature"></span>getUncompressedImageFrame<span class="signature">()</span><span class="type-signature"></span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadouri_getUncompressedImageFrame.js.html">imageLoader/wadouri/getUncompressedImageFrame.js</a>, <a href="imageLoader_wadouri_getUncompressedImageFrame.js.html#line7">line 7</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Function to deal with extracting an image frame from an encapsulated data set.
</div>
<h4 class="name" id="getValue"><span class="type-signature"></span>getValue<span class="signature">(element, index<span class="signature-attributes">opt</span>, defaultValue<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {*}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="imageLoader_wadors_metaData_getValue.js.html">imageLoader/wadors/metaData/getValue.js</a>, <a href="imageLoader_wadors_metaData_getValue.js.html#line9">line 9</a>
</li></ul></dd>
</dl>
<div class="description usertext">
Returns the raw value
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>element</code></td>
<td class="type">
</td>
<td class="attributes">
</td>
<td class="description last">The javascript object for the specified element in the metadata</td>
</tr>
<tr>
<td class="name"><code>index</code></td>
<td class="type">
</td>
<td class="attributes">
<optional><br>