diglettk

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Global - DigleTTK</title> <meta name="keywords" content="medical, imaging, dicom, webgl" /> <meta name="keyword" content="medical, imaging, dicom, webgl" /> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <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 > <input type="text" id="nav-search" placeholder="Search" /> <h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/dvisionlab/DigletTK" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><h3>Classes</h3><ul><li><a href="baseView.html">baseView</a></li><li><a href="MPRManager.html">MPRManager</a><ul class='methods'><li data-type='method' style='display: none;'><a href="MPRManager.html#destroy">destroy</a></li><li data-type='method' style='display: none;'><a href="MPRManager.html#getInitialState">getInitialState</a></li><li data-type='method' style='display: none;'><a href="MPRManager.html#onRotate">onRotate</a></li><li data-type='method' style='display: none;'><a href="MPRManager.html#onThickness">onThickness</a></li><li data-type='method' style='display: none;'><a href="MPRManager.html#resize">resize</a></li><li data-type='method' style='display: none;'><a href="MPRManager.html#setImage">setImage</a></li><li data-type='method' style='display: none;'><a href="MPRManager.html#setTool">setTool</a></li></ul></li><li><a href="VRView.html">VRView</a><ul class='methods'><li data-type='method' style='display: none;'><a href="VRView.html#_initCropWidget">_initCropWidget</a></li><li data-type='method' style='display: none;'><a href="VRView.html#_initPicker">_initPicker</a></li><li data-type='method' style='display: none;'><a href="VRView.html#destroy">destroy</a></li><li data-type='method' style='display: none;'><a href="VRView.html#getLutList">getLutList</a></li><li data-type='method' style='display: none;'><a href="VRView.html#resetMeasurementState">resetMeasurementState</a></li><li data-type='method' style='display: none;'><a href="VRView.html#resetView">resetView</a></li><li data-type='method' style='display: none;'><a href="VRView.html#resize">resize</a></li><li data-type='method' style='display: none;'><a href="VRView.html#setImage">setImage</a></li><li data-type='method' style='display: none;'><a href="VRView.html#setTool">setTool</a></li></ul></li></ul><h3>Global</h3><ul><li><a href="global.html#addSphereInPoint">addSphereInPoint</a></li><li><a href="global.html#applyAngleStrategy">applyAngleStrategy</a></li><li><a href="global.html#applyLengthStrategy">applyLengthStrategy</a></li><li><a href="global.html#getAbsoluteRange">getAbsoluteRange</a></li><li><a href="global.html#getRelativeRange">getRelativeRange</a></li><li><a href="global.html#setActorProperties">setActorProperties</a></li><li><a href="global.html#setCamera">setCamera</a></li><li><a href="global.html#setupCropWidget">setupCropWidget</a></li><li><a href="global.html#setupPickingPlane">setupPickingPlane</a></li><li><a href="global.html#State">State</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="addSphereInPoint"><span class="type-signature"></span>addSphereInPoint<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="utils_utils.js.html">utils/utils.js</a>, <a href="utils_utils.js.html#line524">line 524</a> </li></ul></dd> </dl> <div class="description usertext"> <p>Add a sphere in a specific point (useful for debugging)</p> </div> <h4 class="name" id="applyAngleStrategy"><span class="type-signature"></span>applyAngleStrategy<span class="signature">(state)</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="utils_strategies.js.html">utils/strategies.js</a>, <a href="utils_strategies.js.html#line38">line 38</a> </li></ul></dd> </dl> <div class="description usertext"> <p>Apply the logic to measure angle between two segments</p> </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>state</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The measurement state</p></td> </tr> </tbody> </table> <h4 class="name" id="applyLengthStrategy"><span class="type-signature"></span>applyLengthStrategy<span class="signature">(state)</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="utils_strategies.js.html">utils/strategies.js</a>, <a href="utils_strategies.js.html#line7">line 7</a> </li></ul></dd> </dl> <div class="description usertext"> <p>Apply the logic to measure length between two points</p> </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>state</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The measurement state</p></td> </tr> </tbody> </table> <h4 class="name" id="getAbsoluteRange"><span class="type-signature"></span>getAbsoluteRange<span class="signature">(actor, relativeRange)</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="utils_utils.js.html">utils/utils.js</a>, <a href="utils_utils.js.html#line367">line 367</a> </li></ul></dd> </dl> <div class="description usertext"> <p>Rescale relative range to abs range values (eg hist min-max)</p> </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>actor</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>relativeRange</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="param-desc"> <p>wwwl object</p> </div> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type">*</span> </dd> </dl> <h4 class="name" id="getRelativeRange"><span class="type-signature"></span>getRelativeRange<span class="signature">(actor, absoluteRange)</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="utils_utils.js.html">utils/utils.js</a>, <a href="utils_utils.js.html#line348">line 348</a> </li></ul></dd> </dl> <div class="description usertext"> <p>Rescale abs range to relative range values (eg 0-1)</p> </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>actor</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>absoluteRange</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h5>Returns:</h5> <div class="param-desc"> <p>wwwl object</p> </div> <dl class="param-type"> <dt> Type </dt> <dd> <span class="param-type">*</span> </dd> </dl> <h4 class="name" id="setActorProperties"><span class="type-signature"></span>setActorProperties<span class="signature">(actor)</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="utils_utils.js.html">utils/utils.js</a>, <a href="utils_utils.js.html#line397">line 397</a> </li></ul></dd> </dl> <div class="description usertext"> <p>Set actor appearance properties</p> </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>actor</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h4 class="name" id="setCamera"><span class="type-signature"></span>setCamera<span class="signature">(center)</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="utils_utils.js.html">utils/utils.js</a>, <a href="utils_utils.js.html#line383">line 383</a> </li></ul></dd> </dl> <div class="description usertext"> <p>Set camera lookat point</p> </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>center</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="description last"><p>As [x,y,z]</p></td> </tr> </tbody> </table> <h4 class="name" id="setupCropWidget"><span class="type-signature"></span>setupCropWidget<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="utils_utils.js.html">utils/utils.js</a>, <a href="utils_utils.js.html#line464">line 464</a> </li></ul></dd> </dl> <div class="description usertext"> <p>Initialize a crop widget</p> </div> <h4 class="name" id="setupPickingPlane"><span class="type-signature"></span>setupPickingPlane<span class="signature">(camera, actor)</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="utils_utils.js.html">utils/utils.js</a>, <a href="utils_utils.js.html#line502">line 502</a> </li></ul></dd> </dl> <div class="description usertext"> <p>Create a plane to perform picking</p> </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>camera</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>actor</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"></td> </tr> </tbody> </table> <h3 class="subsection-title">Type Definitions</h3> <h4 class="name" id="State">State</h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="mprManager.js.html">mprManager.js</a>, <a href="mprManager.js.html#line17">line 17</a> </li></ul></dd> </dl> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>slicePlaneNormal</code></td> <td class="type"> <span class="param-type">Array.<Number></span> </td> <td class="description last"><p>The slice plane normal as [x,y,z]</p></td> </tr> <tr> <td class="name"><code>sliceViewUp</code></td> <td class="type"> <span class="param-type">Array.<Number></span> </td> <td class="description last"><p>The up vector as [x,y,z]</p></td> </tr> <tr> <td class="name"><code>slicePlaneXRotation</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The x axis rotation in deg</p></td> </tr> <tr> <td class="name"><code>slicePlaneYRotation</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The y axis rotation in deg</p></td> </tr> <tr> <td class="name"><code>viewRotation</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The view rotation in deg</p></td> </tr> <tr> <td class="name"><code>sliceThickness</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>The MIP slice thickness in px</p></td> </tr> <tr> <td class="name"><code>blendMode</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>The active blending mode ("MIP", "MinIP", "Average")</p></td> </tr> <tr> <td class="name"><code>window</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>wwwl</p> <h6>Properties</h6> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>ww</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>Window width</p></td> </tr> <tr> <td class="name"><code>wl</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>Window level</p></td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <div class="description usertext"> <p>Internal state of a single view</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">Object</span> </li> </ul> </article> </section> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme. </footer> <script>prettyPrint();</script> <script src="scripts/polyfill.js"></script> <script src="scripts/linenumber.js"></script> <script src="scripts/search.js" defer></script> <script src="scripts/collapse.js" defer></script> </body> </html>