dicom-microscopy-viewer-changed
Version:
Interactive web-based viewer for DICOM Microscopy Images
642 lines (189 loc) • 10.7 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: metadata</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">Namespace: metadata</h1>
<section>
<header>
<h2>metadata</h2>
</header>
<article>
<div class="container-overview">
<div class="description">Namespace for working with DICOM Metadata.</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="dicom-microscopy-viewer-changed.js.html">dicom-microscopy-viewer-changed.js</a>, <a href="dicom-microscopy-viewer-changed.js.html#line90">line 90</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="metadata.Comprehensive3DSR.html">Comprehensive3DSR</a></dt>
<dd></dd>
<dt><a href="metadata.MicroscopyBulkSimpleAnnotations.html">MicroscopyBulkSimpleAnnotations</a></dt>
<dd></dd>
<dt><a href="metadata.ParametricMap.html">ParametricMap</a></dt>
<dd></dd>
<dt><a href="metadata.Segmentation.html">Segmentation</a></dt>
<dd></dd>
<dt><a href="metadata.SOPClass.html">SOPClass</a></dt>
<dd></dd>
<dt><a href="metadata.VLWholeSlideMicroscopyImage.html">VLWholeSlideMicroscopyImage</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".formatMetadata"><span class="type-signature">(static) </span>formatMetadata<span class="signature">(metadata)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
Format DICOM metadata structured according to the DICOM JSON model.
Transforms the DICOM JSON representation into a more human friendly
representation, where values of data elements can be directly accessed via
their keyword (e.g., "SOPInstanceUID").
Bulkdata elements will be extracted and returned as a separate mapping.
</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">Object</span>
</td>
<td class="description last">Metadata structured according to the DICOM JSON model</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="metadata.js.html">metadata.js</a>, <a href="metadata.js.html#line274">line 274</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Formatted dataset and remaining bulkdata
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id=".groupColorInstances"><span class="type-signature">(static) </span>groupColorInstances<span class="signature">(images)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
Group DICOM metadata of color images slides by Optical Path Identifier.
</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>images</code></td>
<td class="type">
<span class="param-type">Array.<<a href="metadata.VLWholeSlideMicroscopyImage.html">metadata.VLWholeSlideMicroscopyImage</a>></span>
</td>
<td class="description last">DICOM VL Whole
Slide Microscopy Image instances.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="metadata.js.html">metadata.js</a>, <a href="metadata.js.html#line390">line 390</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Groups of DICOM VL Whole Slide Microscopy Image instances
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</span>
</dd>
</dl>
<h4 class="name" id=".groupMonochromeInstances"><span class="type-signature">(static) </span>groupMonochromeInstances<span class="signature">(images)</span><span class="type-signature"> → {Object}</span></h4>
<div class="description">
Group DICOM metadata of monochrome slides by Optical Path Identifier.
</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>images</code></td>
<td class="type">
<span class="param-type">Array.<<a href="metadata.VLWholeSlideMicroscopyImage.html">metadata.VLWholeSlideMicroscopyImage</a>></span>
</td>
<td class="description last">DICOM VL Whole
Slide Microscopy Image instances.</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="metadata.js.html">metadata.js</a>, <a href="metadata.js.html#line360">line 360</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
Groups of DICOM VL Whole Slide Microscopy Image instances
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Object</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>