face-api/typedoc/classes/FaceDetection.html

402 lines
22 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>FaceDetection | @vladmandic/face-api</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/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../index.html">@vladmandic/face-api</a>
</li>
<li>
<a href="FaceDetection.html">FaceDetection</a>
</li>
</ul>
<h1>Class FaceDetection</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="ObjectDetection.html" class="tsd-signature-type" data-tsd-kind="Class">ObjectDetection</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">FaceDetection</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/IFaceDetecion.html" class="tsd-signature-type" data-tsd-kind="Interface">IFaceDetecion</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="FaceDetection.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetection.html#box" class="tsd-kind-icon">box</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetection.html#className" class="tsd-kind-icon">class<wbr>Name</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetection.html#classScore" class="tsd-kind-icon">class<wbr>Score</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetection.html#imageDims" class="tsd-kind-icon">image<wbr>Dims</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetection.html#imageHeight" class="tsd-kind-icon">image<wbr>Height</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetection.html#imageWidth" class="tsd-kind-icon">image<wbr>Width</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetection.html#relativeBox" class="tsd-kind-icon">relative<wbr>Box</a></li>
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="FaceDetection.html#score" class="tsd-kind-icon">score</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="FaceDetection.html#forSize" class="tsd-kind-icon">for<wbr>Size</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Face<wbr>Detection<span class="tsd-signature-symbol">(</span>score<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, relativeBox<span class="tsd-signature-symbol">: </span><a href="Rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a>, imageDims<span class="tsd-signature-symbol">: </span><a href="../interfaces/IDimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FaceDetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="ObjectDetection.html">ObjectDetection</a>.<a href="ObjectDetection.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceDetection.ts#L12">classes/FaceDetection.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>score: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>relativeBox: <a href="Rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a></h5>
</li>
<li>
<h5>imageDims: <a href="../interfaces/IDimensions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDimensions</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="FaceDetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="box" class="tsd-anchor"></a>
<h3>box</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> box<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/IFaceDetecion.html">IFaceDetecion</a>.<a href="../interfaces/IFaceDetecion.html#box">box</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L36">classes/ObjectDetection.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="Box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="className" class="tsd-anchor"></a>
<h3>class<wbr>Name</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> className<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L34">classes/ObjectDetection.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="classScore" class="tsd-anchor"></a>
<h3>class<wbr>Score</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> classScore<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L32">classes/ObjectDetection.ts:32</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="imageDims" class="tsd-anchor"></a>
<h3>image<wbr>Dims</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageDims<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L38">classes/ObjectDetection.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="Dimensions.html" class="tsd-signature-type" data-tsd-kind="Class">Dimensions</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="imageHeight" class="tsd-anchor"></a>
<h3>image<wbr>Height</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageHeight<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L42">classes/ObjectDetection.ts:42</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="imageWidth" class="tsd-anchor"></a>
<h3>image<wbr>Width</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> imageWidth<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L40">classes/ObjectDetection.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="relativeBox" class="tsd-anchor"></a>
<h3>relative<wbr>Box</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> relativeBox<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L44">classes/ObjectDetection.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="Box.html" class="tsd-signature-type" data-tsd-kind="Class">Box</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="score" class="tsd-anchor"></a>
<h3>score</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> score<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>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/IFaceDetecion.html">IFaceDetecion</a>.<a href="../interfaces/IFaceDetecion.html#score">score</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/ObjectDetection.ts#L30">classes/ObjectDetection.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="forSize" class="tsd-anchor"></a>
<h3>for<wbr>Size</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">for<wbr>Size<span class="tsd-signature-symbol">(</span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="FaceDetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="ObjectDetection.html">ObjectDetection</a>.<a href="ObjectDetection.html#forSize">forSize</a></p>
<ul>
<li>Defined in <a href="https://github.com/vladmandic/face-api/blob/main/src/classes/FaceDetection.ts#L20">classes/FaceDetection.ts:20</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>width: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>height: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="FaceDetection.html" class="tsd-signature-type" data-tsd-kind="Class">FaceDetection</a></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../index.html">Exports</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class">
<a href="FaceDetection.html" class="tsd-kind-icon">Face<wbr>Detection</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a href="FaceDetection.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetection.html#box" class="tsd-kind-icon">box</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetection.html#className" class="tsd-kind-icon">class<wbr>Name</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetection.html#classScore" class="tsd-kind-icon">class<wbr>Score</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetection.html#imageDims" class="tsd-kind-icon">image<wbr>Dims</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetection.html#imageHeight" class="tsd-kind-icon">image<wbr>Height</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetection.html#imageWidth" class="tsd-kind-icon">image<wbr>Width</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetection.html#relativeBox" class="tsd-kind-icon">relative<wbr>Box</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="FaceDetection.html#score" class="tsd-kind-icon">score</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="FaceDetection.html#forSize" class="tsd-kind-icon">for<wbr>Size</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>