dicom-microscopy-viewer
Version:
Interactive web-based viewer for DICOM Microscopy Images
1,805 lines (412 loc) • 21.5 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</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-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<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">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>
<div class="description">
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">
0
</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>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="webWorker_webWorkerManager.js.html">webWorker/webWorkerManager.js</a>, <a href="webWorker_webWorkerManager.js.html#line201">line 201</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">*</span>
</dd>
</dl>
<h4 class="name" id="cancelTask"><span class="type-signature"></span>cancelTask<span class="signature">(taskId, reason)</span><span class="type-signature"></span></h4>
<div class="description">
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>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="webWorker_webWorkerManager.js.html">webWorker/webWorkerManager.js</a>, <a href="webWorker_webWorkerManager.js.html#line285">line 285</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
boolean - true on success, false if taskId not found
</div>
<h4 class="name" id="decode"><span class="type-signature">(async) </span>decode<span class="signature">(byteArray)</span><span class="type-signature"> → {Promise.<object>}</span></h4>
<div class="description">
Decode image.
</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>byteArray</code></td>
<td class="type">
<span class="param-type">Uint8Array</span>
</td>
<td class="description last">Image array</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="webWorker_decoders_decoderAbstract.js.html">webWorker/decoders/decoderAbstract.js</a>, <a href="webWorker_decoders_decoderAbstract.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
decoded array and frame information
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<object></span>
</dd>
</dl>
<h4 class="name" id="getStatistics"><span class="type-signature"></span>getStatistics<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Function to return the statistics on running web workers
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="webWorker_webWorkerManager.js.html">webWorker/webWorkerManager.js</a>, <a href="webWorker_webWorkerManager.js.html#line305">line 305</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
object containing statistics
</div>
<h4 class="name" id="handleMessageFromWorker"><span class="type-signature"></span>handleMessageFromWorker<span class="signature">(msg)</span><span class="type-signature"></span></h4>
<div class="description">
Function to handle a message from a web worker
</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>msg</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="webWorker_webWorkerManager.js.html">webWorker/webWorkerManager.js</a>, <a href="webWorker_webWorkerManager.js.html#line85">line 85</a>
</li></ul></dd>
</dl>
<h4 class="name" id="initialize"><span class="type-signature"></span>initialize<span class="signature">(configObject)</span><span class="type-signature"></span></h4>
<div class="description">
Initialization function for the web worker manager - spawns web workers
</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>configObject</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="webWorker_webWorkerManager.js.html">webWorker/webWorkerManager.js</a>, <a href="webWorker_webWorkerManager.js.html#line137">line 137</a>
</li></ul></dd>
</dl>
<h4 class="name" id="loadWebWorkerTask"><span class="type-signature"></span>loadWebWorkerTask<span class="signature">(sourcePath, taskConfig)</span><span class="type-signature"></span></h4>
<div class="description">
dynamically loads a web worker task
</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>sourcePath</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>taskConfig</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="webWorker_webWorkerManager.js.html">webWorker/webWorkerManager.js</a>, <a href="webWorker_webWorkerManager.js.html#line167">line 167</a>
</li></ul></dd>
</dl>
<h4 class="name" id="setTaskPriority"><span class="type-signature"></span>setTaskPriority<span class="signature">(taskId, priority)</span><span class="type-signature"></span></h4>
<div class="description">
Changes the priority of a queued task
</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>taskId</code></td>
<td class="type">
</td>
<td class="default">
</td>
<td class="description last">the taskId to change the priority of</td>
</tr>
<tr>
<td class="name"><code>priority</code></td>
<td class="type">
</td>
<td class="default">
0
</td>
<td class="description last">priority of the task (defaults to 0), > 0 is higher, < 0 is lower</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="webWorker_webWorkerManager.js.html">webWorker/webWorkerManager.js</a>, <a href="webWorker_webWorkerManager.js.html#line252">line 252</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
boolean - true on success, false if taskId not found
</div>
<h4 class="name" id="spawnWebWorker"><span class="type-signature"></span>spawnWebWorker<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Spawns a new web worker
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="webWorker_webWorkerManager.js.html">webWorker/webWorkerManager.js</a>, <a href="webWorker_webWorkerManager.js.html#line113">line 113</a>
</li></ul></dd>
</dl>
<h4 class="name" id="startTaskOnWebWorker"><span class="type-signature"></span>startTaskOnWebWorker<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Function to start a task on a web worker
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="webWorker_webWorkerManager.js.html">webWorker/webWorkerManager.js</a>, <a href="webWorker_webWorkerManager.js.html#line36">line 36</a>
</li></ul></dd>
</dl>
<h4 class="name" id="terminateAllWebWorkers"><span class="type-signature"></span>terminateAllWebWorkers<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Terminate all running web workers.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="webWorker_webWorkerManager.js.html">webWorker/webWorkerManager.js</a>, <a href="webWorker_webWorkerManager.js.html#line154">line 154</a>
</li></ul></dd>
</dl>
<h4 class="name" id="transform"><span class="type-signature">(async) </span>transform<span class="signature">(sopInstanceUID, decodedFrame)</span><span class="type-signature"> → {Promise.<Buffer>}</span></h4>
<div class="description">
Transform image.
The transform is applied only is iccProfiles are available.
Otherwise the function return the original decoded frame.
</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>sopInstanceUID</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">SOP Instance UID of current image that should be transformed</td>
</tr>
<tr>
<td class="name"><code>decodedFrame</code></td>
<td class="type">
<span class="param-type">Buffer</span>
</td>
<td class="description last">decoded Frame</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="webWorker_transformers_transformerICC.js.html">webWorker/transformers/transformerICC.js</a>, <a href="webWorker_transformers_transformerICC.js.html#line80">line 80</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
transformed buffer
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise.<Buffer></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="annotation.html">annotation</a></li><li><a href="api.html">api</a></li><li><a href="color.html">color</a></li><li><a href="events.html">events</a></li><li><a href="mapping.html">mapping</a></li><li><a href="metadata.html">metadata</a></li><li><a href="opticalPath.html">opticalPath</a></li><li><a href="roi.html">roi</a></li><li><a href="scoord3d.html">scoord3d</a></li><li><a href="segment.html">segment</a></li><li><a href="utils.html">utils</a></li><li><a href="viewer.html">viewer</a></li></ul><h3>Classes</h3><ul><li><a href="annotation.AnnotationGroup.html">AnnotationGroup</a></li><li><a href="color.PaletteColorLookupTable.html">PaletteColorLookupTable</a></li><li><a href="mapping.ParameterMapping.html">ParameterMapping</a></li><li><a href="mapping.Transformation.html">Transformation</a></li><li><a href="metadata.Comprehensive3DSR.html">Comprehensive3DSR</a></li><li><a href="metadata.MicroscopyBulkSimpleAnnotations.html">MicroscopyBulkSimpleAnnotations</a></li><li><a href="metadata.ParametricMap.html">ParametricMap</a></li><li><a href="metadata.Segmentation.html">Segmentation</a></li><li><a href="metadata.SOPClass.html">SOPClass</a></li><li><a href="metadata.VLWholeSlideMicroscopyImage.html">VLWholeSlideMicroscopyImage</a></li><li><a href="module.exports_module.exports.html">exports</a></li><li><a href="opticalPath.OpticalPath.html">OpticalPath</a></li><li><a href="roi.ROI.html">ROI</a></li><li><a href="scoord3d.Ellipse.html">Ellipse</a></li><li><a href="scoord3d.Ellipsoid.html">Ellipsoid</a></li><li><a href="scoord3d.Multipoint.html">Multipoint</a></li><li><a href="scoord3d.Point.html">Point</a></li><li><a href="scoord3d.Polygon.html">Polygon</a></li><li><a href="scoord3d.Polyline.html">Polyline</a></li><li><a href="scoord3d.Scoord3D.html">Scoord3D</a></li><li><a href="segment.Segment.html">Segment</a></li><li><a href="viewer.LabelImageViewer.html">LabelImageViewer</a></li><li><a href="viewer.OverviewImageViewer.html">OverviewImageViewer</a></li><li><a href="viewer.VolumeImageViewer.html">VolumeImageViewer</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addTask">addTask</a></li><li><a href="global.html#cancelTask">cancelTask</a></li><li><a href="global.html#decode">decode</a></li><li><a href="global.html#getStatistics">getStatistics</a></li><li><a href="global.html#handleMessageFromWorker">handleMessageFromWorker</a></li><li><a href="global.html#initialize">initialize</a></li><li><a href="global.html#loadWebWorkerTask">loadWebWorkerTask</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#terminateAllWebWorkers">terminateAllWebWorkers</a></li><li><a href="global.html#transform">transform</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a> on Thu Sep 29 2022 16:54:54 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>