dicom-microscopy-viewer
Version:
Interactive web-based viewer for DICOM Microscopy Images
1,308 lines (355 loc) • 19.2 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: OpticalPath</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">Class: OpticalPath</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>
<span class="ancestors"><a href="opticalPath.html">opticalPath</a>.</span>OpticalPath<span class="signature">(options)</span><span class="type-signature"></span></h2>
<div class="class-description">An Optical Path.
An optical path represents a color or a monochromatic image that was acquired
using specific microscopy settings. Usually, an optical path is also
associated with specific specimen preparation steps, in particular one or
more staining steps. For example, in immunofluorescence microscopy imaging,
an optical path is generally associated with a specific fluorescence
illumination wave length or color (e.g., 568nm in the red spectrum of the
visible light) and an antibody or a set of antibodies labeled with a
corresponding fluorophore that can be excited by light at the illumination
wave length and re-emit light (usually at a slightly higher wave length)
upon excitation.
Note, however, that multiple stains may be applied to the imaging target
(specimen) during specimen preparation, and multiple images may be acquired
using different optical paths - either simultaneously or sequentially.
The content of an image thus depends on the physical properties of the
tissue stains (fluorophores) as well as the characteristics of the optical
path (illumination wave length, light and image path filters, etc.).
An optical path is identified by an optical path identifier that must be
unique within the scope of an image acquisition (or multiple cycles of image
acquisition in case of iterative immunofluorescence imaging).
The relationship between the optical path and any corresponding staining
specimen preparation steps may not be explicitly specified.</div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="OpticalPath"><span class="type-signature"></span>new OpticalPath<span class="signature">(options)</span><span class="type-signature"></span></h4>
<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>options</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Options
<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>identifier</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Optical Path Identifier</td>
</tr>
<tr>
<td class="name"><code>description</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Optical Path Description</td>
</tr>
<tr>
<td class="name"><code>illuminationType</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Illumination Type Code</td>
</tr>
<tr>
<td class="name"><code>isMonochromatic</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last">Whether optical path is monochromatic</td>
</tr>
<tr>
<td class="name"><code>illuminationColor</code></td>
<td class="type">
<span class="param-type">Object</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last">Illumination Color Code</td>
</tr>
<tr>
<td class="name"><code>illuminationWaveLength</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last">Illumination Wave Length</td>
</tr>
<tr>
<td class="name"><code>studyInstanceUID</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Study Instance UID of VL Whole Slide Microscopy Image instances</td>
</tr>
<tr>
<td class="name"><code>seriesInstanceUID</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Series Instance UID of VL Whole Slide Microscopy Image instances</td>
</tr>
<tr>
<td class="name"><code>sopInstanceUIDs</code></td>
<td class="type">
<span class="param-type">Array.<string></span>
</td>
<td class="description last">SOP Instance UIDs of VL Whole Slide Microscopy Image instances</td>
</tr>
<tr>
<td class="name"><code>paletteColorLookupTableUID</code></td>
<td class="type">
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</td>
<td class="description last">Palette Color Lookup Table UID</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="opticalPath.js.html">opticalPath.js</a>, <a href="opticalPath.js.html#line33">line 33</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="description"><span class="type-signature"></span>description<span class="type-signature"> :string</span></h4>
<div class="description">
Optical Path Description
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="opticalPath.js.html">opticalPath.js</a>, <a href="opticalPath.js.html#line114">line 114</a>
</li></ul></dd>
</dl>
<h4 class="name" id="identifier"><span class="type-signature"></span>identifier<span class="type-signature"> :string</span></h4>
<div class="description">
Optical Path Identifier
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="opticalPath.js.html">opticalPath.js</a>, <a href="opticalPath.js.html#line105">line 105</a>
</li></ul></dd>
</dl>
<h4 class="name" id="illuminationColor"><span class="type-signature"></span>illuminationColor<span class="type-signature"> :object</span></h4>
<div class="description">
Illumination Color
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="opticalPath.js.html">opticalPath.js</a>, <a href="opticalPath.js.html#line132">line 132</a>
</li></ul></dd>
</dl>
<h4 class="name" id="illuminationType"><span class="type-signature"></span>illuminationType<span class="type-signature"> :object</span></h4>
<div class="description">
Illumination Type Code
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="opticalPath.js.html">opticalPath.js</a>, <a href="opticalPath.js.html#line123">line 123</a>
</li></ul></dd>
</dl>
<h4 class="name" id="illuminationWaveLength"><span class="type-signature"></span>illuminationWaveLength<span class="type-signature"> :string|undefined</span></h4>
<div class="description">
Illumination Wave Length
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
|
<span class="param-type">undefined</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="opticalPath.js.html">opticalPath.js</a>, <a href="opticalPath.js.html#line141">line 141</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isColorable"><span class="type-signature"></span>isColorable<span class="type-signature"> :boolean</span></h4>
<div class="description">
Whether images of optical path are colorable
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="opticalPath.js.html">opticalPath.js</a>, <a href="opticalPath.js.html#line195">line 195</a>
</li></ul></dd>
</dl>
<h4 class="name" id="isMonochromatic"><span class="type-signature"></span>isMonochromatic<span class="type-signature"> :boolean</span></h4>
<div class="description">
Whether optical path is monochromatic
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">boolean</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="opticalPath.js.html">opticalPath.js</a>, <a href="opticalPath.js.html#line186">line 186</a>
</li></ul></dd>
</dl>
<h4 class="name" id="paletteColorLookupTableUID"><span class="type-signature"></span>paletteColorLookupTableUID<span class="type-signature"> :string</span></h4>
<div class="description">
Palette Color Lookup Table UID
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="opticalPath.js.html">opticalPath.js</a>, <a href="opticalPath.js.html#line177">line 177</a>
</li></ul></dd>
</dl>
<h4 class="name" id="seriesInstanceUID"><span class="type-signature"></span>seriesInstanceUID<span class="type-signature"> :string</span></h4>
<div class="description">
Series Instance UID of images
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="opticalPath.js.html">opticalPath.js</a>, <a href="opticalPath.js.html#line159">line 159</a>
</li></ul></dd>
</dl>
<h4 class="name" id="sopInstanceUIDs"><span class="type-signature"></span>sopInstanceUIDs<span class="type-signature"> :Array.<string></span></h4>
<div class="description">
SOP Instance UIDs of images
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array.<string></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="opticalPath.js.html">opticalPath.js</a>, <a href="opticalPath.js.html#line168">line 168</a>
</li></ul></dd>
</dl>
<h4 class="name" id="studyInstanceUID"><span class="type-signature"></span>studyInstanceUID<span class="type-signature"> :string</span></h4>
<div class="description">
Study Instance UID of images
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">string</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="opticalPath.js.html">opticalPath.js</a>, <a href="opticalPath.js.html#line150">line 150</a>
</li></ul></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>