face-api/typedoc/functions/tf.browser.fromPixels.html

18 lines
25 KiB
HTML
Raw Normal View History

2024-01-17 22:56:53 +01:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>fromPixels | @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="../modules/tf.html">tf</a></li><li><a href="../modules/tf.browser.html">browser</a></li><li><a href="tf.browser.fromPixels.html">fromPixels</a></li></ul><h1>Function fromPixels</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="fromPixels" class="tsd-anchor"></a><span class="tsd-kind-call-signature">from<wbr/>Pixels</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">pixels</span>, <span class="tsd-kind-parameter">numChannels</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/tf.Tensor3D.html" class="tsd-signature-type tsd-kind-type-alias">Tensor3D</a><a href="#fromPixels" 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-comment tsd-typography"><p>Creates a <code>tf.Tensor</code> from an image.</p>
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">image</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">ImageData</span><span class="hl-1">(</span><span class="hl-4">1</span><span class="hl-1">, </span><span class="hl-4">1</span><span class="hl-1">);</span><br/><span class="hl-5">image</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">[</span><span class="hl-4">0</span><span class="hl-1">] = </span><span class="hl-4">100</span><span class="hl-1">;</span><br/><span class="hl-5">image</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">[</span><span class="hl-4">1</span><span class="hl-1">] = </span><span class="hl-4">150</span><span class="hl-1">;</span><br/><span class="hl-5">image</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">[</span><span class="hl-4">2</span><span class="hl-1">] = </span><span class="hl-4">200</span><span class="hl-1">;</span><br/><span class="hl-5">image</span><span class="hl-1">.</span><span class="hl-5">data</span><span class="hl-1">[</span><span class="hl-4">3</span><span class="hl-1">] = </span><span class="hl-4">255</span><span class="hl-1">;</span><br/><br/><span class="hl-5">tf</span><span class="hl-1">.</span><span class="hl-5">browser</span><span class="hl-1">.</span><span class="hl-3">fromPixels</span><span class="hl-1">(</span><span class="hl-5">image</span><span class="hl-1">).</span><span class="hl-3">print</span><span class="hl-1">();</span>
</code><button>Copy</button></pre>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">pixels</span>: <span class="tsd-signature-type">HTMLCanvasElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLImageElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLVideoElement</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ImageData</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ImageBitmap</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PixelData</span></h5><div class="tsd-comment tsd-typography"><p>The input image to construct the tensor from. The
supported image types are all 4-channel. You can also pass in an image
object with following attributes:
<code>{data: Uint8Array; width: number; height: number}</code></p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">numChannels</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The number of channels of the output tensor. A
numChannels value less than 4 allows you to ignore channels. Defaults to
3 (ignores alpha channel of input image).</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/tf.Tensor3D.html" class="tsd-signature-type tsd-kind-type-alias">Tensor3D</a></h4><p>A Tensor3D with the shape <code>[height, width, numChannels]</code>.</p>
<p>Note: fromPixels can be lossy in some cases, same image may result in
slightly different tensor values, if rendered by different rendering
engines. This means that results from different browsers, or even same
browser with CPU and GPU rendering engines can be different. See discussion
in details:
<a href="https://github.com/tensorflow/tfjs/issues/5482">https://github.com/tensorflow/tfjs/issues/5482</a></p>
2024-02-07 17:20:36 +01:00
<div class="tsd-comment tsd-typography"><h4>Doc</h4></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@tensorflow/tfjs-core/dist/ops/browser.d.ts:122</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>@vladmandic/face-api - v1.7.13</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li><a href="../modules/draw.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg>draw</a></li><li><a href="../modules/tf.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg>tf</a></li><li><a href="../modules/utils.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4"></use></svg>utils</a></li><li><a href="../enums/Gender.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg>Gender</a></li><li><a href="../classes/AgeGenderNet.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AgeGenderNet</a></li><li><a href="../classes/BoundingBox.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>BoundingBox</a></li><li><a href="../classes/Box.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>Box</a></li><li><a href="../classes/ComposableTask.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ComposableTask</a></li><li><a href="../classes/ComputeAllFaceDescriptorsTask.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ComputeAllFaceDescriptorsTask</a></li><li><a href="../classes/ComputeFaceDescriptorsTaskBase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ComputeFaceDescriptorsTaskBase</a></li><li><a href="../classes/ComputeSingleFaceDescriptorTask.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ComputeSingleFaceDescriptorTask</a></li><li><a href="../classes/DetectAllFaceLandmarksTask.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>DetectAllFaceLandmarksTask</a></li><li><a href="../classes/DetectAllFacesTask.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>DetectAllFacesTask</a></li><li><a href="../classes/DetectFaceLandmarksTaskBase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>DetectFaceLandmarksTaskBase</a></li><li><a href="../classes/DetectFacesTaskBase.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>DetectFacesTaskBase</a></li><li><a href="../classes/DetectSingleFaceLandmarksTask.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>