cornerstone-tools-cacalc
Version:
Medical imaging tools for the Cornerstone library with added functionality for computing Agatston calcium scores
2,156 lines (385 loc) • 23.8 kB
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">
</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#applyWWWCRegion">applyWWWCRegion</a></li><li><a href="global.html#calculateMinMaxMean">calculateMinMaxMean</a></li><li><a href="global.html#createMagnificationCanvas">createMagnificationCanvas</a></li><li><a href="global.html#dragCallback">dragCallback</a></li><li><a href="global.html#drawMagnificationTool">drawMagnificationTool</a></li><li><a href="global.html#getPlayClipTimeouts">getPlayClipTimeouts</a></li><li><a href="global.html#mouseDownCallback">mouseDownCallback</a></li><li><a href="global.html#mouseUpCallback">mouseUpCallback</a></li><li><a href="global.html#onImageRendered">onImageRendered</a></li><li><a href="global.html#performThresholding">performThresholding</a></li><li><a href="global.html#playClip">playClip</a></li><li><a href="global.html#recordStartPoint">recordStartPoint</a></li><li><a href="global.html#removeMagnificationCanvas">removeMagnificationCanvas</a></li><li><a href="global.html#stopClip">stopClip</a></li><li><a href="global.html#stopClipWithData">stopClipWithData</a></li><li><a href="global.html#triggerStopEvent">triggerStopEvent</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">Methods</h3>
<h4 class="name" id="applyWWWCRegion"><span class="type-signature"></span>applyWWWCRegion<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="imageTools_wwwcRegion.js.html">imageTools/wwwcRegion.js</a>, <a href="imageTools_wwwcRegion.js.html#line99">line 99</a>
</li></ul></dd>
</dl>
<div class="description">
Calculates the minimum and maximum value in the given pixel array
</div>
<h4 class="name" id="calculateMinMaxMean"><span class="type-signature"></span>calculateMinMaxMean<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="imageTools_wwwcRegion.js.html">imageTools/wwwcRegion.js</a>, <a href="imageTools_wwwcRegion.js.html#line18">line 18</a>
</li></ul></dd>
</dl>
<div class="description">
Calculates the minimum, maximum, and mean value in the given pixel array
</div>
<h4 class="name" id="createMagnificationCanvas"><span class="type-signature"></span>createMagnificationCanvas<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="imageTools_magnify.js.html">imageTools/magnify.js</a>, <a href="imageTools_magnify.js.html#line156">line 156</a>
</li></ul></dd>
</dl>
<div class="description">
Creates the magnifying glass canvas
</div>
<h4 class="name" id="dragCallback"><span class="type-signature"></span>dragCallback<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="imageTools_wwwcRegion.js.html">imageTools/wwwcRegion.js</a>, <a href="imageTools_wwwcRegion.js.html#line195">line 195</a>
</li></ul></dd>
</dl>
<div class="description">
Draws the rectangular region while the touch or mouse event drag occurs
</div>
<h4 class="name" id="dragCallback"><span class="type-signature"></span>dragCallback<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="imageTools_magnify.js.html">imageTools/magnify.js</a>, <a href="imageTools_magnify.js.html#line65">line 65</a>
</li></ul></dd>
</dl>
<div class="description">
Drag callback is triggered by both the touch and mouse magnify tools
</div>
<h4 class="name" id="drawMagnificationTool"><span class="type-signature"></span>drawMagnificationTool<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="imageTools_magnify.js.html">imageTools/magnify.js</a>, <a href="imageTools_magnify.js.html#line78">line 78</a>
</li></ul></dd>
</dl>
<div class="description">
Draws the magnifying glass
</div>
<h4 class="name" id="getPlayClipTimeouts"><span class="type-signature"></span>getPlayClipTimeouts<span class="signature">(vector, speed)</span><span class="type-signature"> → {Array}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="stackTools_playClip.js.html">stackTools/playClip.js</a>, <a href="stackTools_playClip.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
<div class="description">
[private] Turns a Frame Time Vector (0018,1065) array into a normalized array of timeouts. Each element
... of the resulting array represents the amount of time each frame will remain on the screen.
</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>vector</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="description last">A Frame Time Vector (0018,1065) as specified in section C.7.6.5.1.2 of DICOM standard.</td>
</tr>
<tr>
<td class="name"><code>speed</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last">A speed factor which will be applied to each element of the resulting array.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
An array with timeouts for each animation frame.
</div>
<dl class="param-type">
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
<h4 class="name" id="mouseDownCallback"><span class="type-signature"></span>mouseDownCallback<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="imageTools_wwwcRegion.js.html">imageTools/wwwcRegion.js</a>, <a href="imageTools_wwwcRegion.js.html#line164">line 164</a>
</li></ul></dd>
</dl>
<div class="description">
Records the start point and attaches the drag event handler
</div>
<h4 class="name" id="mouseDownCallback"><span class="type-signature"></span>mouseDownCallback<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="imageTools_magnify.js.html">imageTools/magnify.js</a>, <a href="imageTools_magnify.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<div class="description">
Draw the magnifying glass on mouseDown, and begin tracking mouse movements
</div>
<h4 class="name" id="mouseUpCallback"><span class="type-signature"></span>mouseUpCallback<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="imageTools_magnify.js.html">imageTools/magnify.js</a>, <a href="imageTools_magnify.js.html#line17">line 17</a>
</li></ul></dd>
</dl>
<div class="description">
Remove the magnifying glass when the mouse event ends
</div>
<h4 class="name" id="onImageRendered"><span class="type-signature"></span>onImageRendered<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="regions_thresholding.js.html">regions/thresholding.js</a>, <a href="regions_thresholding.js.html#line104">line 104</a>
</li></ul></dd>
</dl>
<div class="description">
Draw regions on image
</div>
<h4 class="name" id="performThresholding"><span class="type-signature"></span>performThresholding<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="regions_thresholding.js.html">regions/thresholding.js</a>, <a href="regions_thresholding.js.html#line47">line 47</a>
</li></ul></dd>
</dl>
<div class="description">
Perform the thresholding on a stack
</div>
<h4 class="name" id="playClip"><span class="type-signature"></span>playClip<span class="signature">(element, framesPerSecond)</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="stackTools_playClip.js.html">stackTools/playClip.js</a>, <a href="stackTools_playClip.js.html#line100">line 100</a>
</li></ul></dd>
</dl>
<div class="description">
Starts playing a clip or adjusts the frame rate of an already playing clip. framesPerSecond is
optional and defaults to 30 if not specified. A negative framesPerSecond will play the clip in reverse.
The element must be a stack of images
</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>element</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>framesPerSecond</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h4 class="name" id="playClip"><span class="type-signature"></span>playClip<span class="signature">(element, framesPerSecond)</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="timeSeriesTools_timeSeriesPlayer.js.html">timeSeriesTools/timeSeriesPlayer.js</a>, <a href="timeSeriesTools_timeSeriesPlayer.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<div class="description">
Starts playing a clip of different time series of the same image or adjusts the frame rate of an
already playing clip. framesPerSecond is optional and defaults to 30 if not specified. A negative
framesPerSecond will play the clip in reverse.
The element must have time series
</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>element</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>framesPerSecond</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h4 class="name" id="recordStartPoint"><span class="type-signature"></span>recordStartPoint<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="imageTools_wwwcRegion.js.html">imageTools/wwwcRegion.js</a>, <a href="imageTools_wwwcRegion.js.html#line177">line 177</a>
</li></ul></dd>
</dl>
<div class="description">
Records the start point of the click or touch
</div>
<h4 class="name" id="removeMagnificationCanvas"><span class="type-signature"></span>removeMagnificationCanvas<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="imageTools_magnify.js.html">imageTools/magnify.js</a>, <a href="imageTools_magnify.js.html#line177">line 177</a>
</li></ul></dd>
</dl>
<div class="description">
Find the magnifying glass canvas and remove it
</div>
<h4 class="name" id="stopClip"><span class="type-signature"></span>stopClip<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="stackTools_playClip.js.html">stackTools/playClip.js</a>, <a href="stackTools_playClip.js.html#line246">line 246</a>
</li></ul></dd>
</dl>
<div class="description">
Stops an already playing clip.
* @param element
</div>
<h4 class="name" id="stopClip"><span class="type-signature"></span>stopClip<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="timeSeriesTools_timeSeriesPlayer.js.html">timeSeriesTools/timeSeriesPlayer.js</a>, <a href="timeSeriesTools_timeSeriesPlayer.js.html#line63">line 63</a>
</li></ul></dd>
</dl>
<div class="description">
Stops an already playing clip.
* @param element
</div>
<h4 class="name" id="stopClipWithData"><span class="type-signature"></span>stopClipWithData<span class="signature">(playClipData)</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="stackTools_playClip.js.html">stackTools/playClip.js</a>, <a href="stackTools_playClip.js.html#line65">line 65</a>
</li></ul></dd>
</dl>
<div class="description">
[private] Performs the heavy lifting of stopping an ongoing animation.
</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>playClipData</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">The data from playClip that needs to be stopped.</td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
void
</div>
<h4 class="name" id="triggerStopEvent"><span class="type-signature"></span>triggerStopEvent<span class="signature">(element)</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="stackTools_playClip.js.html">stackTools/playClip.js</a>, <a href="stackTools_playClip.js.html#line83">line 83</a>
</li></ul></dd>
</dl>
<div class="description">
[private] Trigger playClip tool stop event.
</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>element</code></td>
<td class="type">
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<h5>Returns:</h5>
<div class="param-desc">
void
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>