2024-02-07 17:20:36 +01:00
|
|
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LabeledBox | @vladmandic/face-api - v1.7.13</title><meta name="description" content="Documentation for @vladmandic/face-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@vladmandic/face-api - v1.7.13</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@vladmandic/face-api</a></li><li><a href="LabeledBox.html">LabeledBox</a></li></ul><h1>Class LabeledBox</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#LabeledBox">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="Box.html" class="tsd-signature-type tsd-kind-class">Box</a><ul class="tsd-hierarchy"><li><span class="target">LabeledBox</span><ul class="tsd-hierarchy"><li><a href="PredictedBox.html" class="tsd-signature-type tsd-kind-class">PredictedBox</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Mixtiles/face-api/blob/master/src/classes/LabeledBox.ts#L6">src/classes/LabeledBox.ts:6</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="LabeledBox.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
|
2024-01-17 22:56:53 +01:00
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="LabeledBox.html#area" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>area</span></a>
|
|
|
|
|
<a href="LabeledBox.html#bottom" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>bottom</span></a>
|
|
|
|
|
<a href="LabeledBox.html#bottomLeft" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>bottom<wbr/>Left</span></a>
|
|
|
|
|
<a href="LabeledBox.html#bottomRight" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>bottom<wbr/>Right</span></a>
|
|
|
|
|
<a href="LabeledBox.html#height" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>height</span></a>
|
|
|
|
|
<a href="LabeledBox.html#label" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>label</span></a>
|
|
|
|
|
<a href="LabeledBox.html#left" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>left</span></a>
|
|
|
|
|
<a href="LabeledBox.html#right" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>right</span></a>
|
|
|
|
|
<a href="LabeledBox.html#top" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>top</span></a>
|
|
|
|
|
<a href="LabeledBox.html#topLeft" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>top<wbr/>Left</span></a>
|
|
|
|
|
<a href="LabeledBox.html#topRight" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>top<wbr/>Right</span></a>
|
|
|
|
|
<a href="LabeledBox.html#width" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>width</span></a>
|
|
|
|
|
<a href="LabeledBox.html#x" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>x</span></a>
|
|
|
|
|
<a href="LabeledBox.html#y" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>y</span></a>
|
|
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="LabeledBox.html#calibrate" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>calibrate</span></a>
|
|
|
|
|
<a href="LabeledBox.html#clipAtImageBorders" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>clip<wbr/>At<wbr/>Image<wbr/>Borders</span></a>
|
|
|
|
|
<a href="LabeledBox.html#floor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>floor</span></a>
|
|
|
|
|
<a href="LabeledBox.html#pad" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pad</span></a>
|
|
|
|
|
<a href="LabeledBox.html#padAtBorders" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pad<wbr/>At<wbr/>Borders</span></a>
|
|
|
|
|
<a href="LabeledBox.html#rescale" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>rescale</span></a>
|
|
|
|
|
<a href="LabeledBox.html#round" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>round</span></a>
|
|
|
|
|
<a href="LabeledBox.html#shift" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>shift</span></a>
|
|
|
|
|
<a href="LabeledBox.html#toSquare" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>Square</span></a>
|
|
|
|
|
<a href="LabeledBox.html#assertIsValidBox" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>assert<wbr/>Is<wbr/>Valid<wbr/>Box</span></a>
|
|
|
|
|
<a href="LabeledBox.html#assertIsValidLabeledBox" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>assert<wbr/>Is<wbr/>Valid<wbr/>Labeled<wbr/>Box</span></a>
|
|
|
|
|
<a href="LabeledBox.html#isRect" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Rect</span></a>
|
2024-02-07 17:20:36 +01:00
|
|
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_LabeledBox" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Labeled<wbr/>Box</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">box</span>, <span class="tsd-kind-parameter">label</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="LabeledBox.html" class="tsd-signature-type tsd-kind-class">LabeledBox</a><a href="#constructor.new_LabeledBox" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">box</span>: <span class="tsd-signature-type">any</span></h5></li><li><h5><span class="tsd-kind-parameter">label</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="LabeledBox.html" class="tsd-signature-type tsd-kind-class">LabeledBox</a></h4><aside class="tsd-sources"><p>Overrides <a href="Box.html">Box</a>.<a href="Box.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/Mixtiles/face-api/blob/master/src/classes/LabeledBox.ts#L16">src/classes/LabeledBox.ts:16</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="area" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>area</span><a href="#area" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature" id="area.area-1"><span class="tsd-signature-keyword">get</span> area<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><p>Inherited from Box.area</p><ul><li>Defined in <a href="https://github.com/Mixtiles/face-api/blob/master/src/classes/Box.ts#L70">src/classes/Box.ts:70</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="bottom" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bottom</span><a href="#bottom" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature" id="bottom.bottom-1"><span class="tsd-signature-keyword">get</span> bottom<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><p>Inherited from Box.bottom</p><ul><li>Defined in <a href="https://github.com/Mixtiles/face-api/blob/master/src/classes/Box.ts#L68">src/classes/Box.ts:68</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="bottomLeft" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bottom<wbr/>Left</span><a href="#bottomLeft" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="t
|
