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 > FaceLandmarks | @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 = "FaceLandmarks.html" > FaceLandmarks< / a > < / li > < / ul > < h1 > Class FaceLandmarks< / h1 > < / div > < section class = "tsd-panel tsd-hierarchy" > < h4 > Hierarchy (< a class = "link" href = "../hierarchy.html#FaceLandmarks" > view full< / a > )< / h4 > < ul class = "tsd-hierarchy" > < li > < span class = "target" > FaceLandmarks< / span > < ul class = "tsd-hierarchy" > < li > < a href = "FaceLandmarks5.html" class = "tsd-signature-type tsd-kind-class" > FaceLandmarks5< / a > < / li > < li > < a href = "FaceLandmarks68.html" class = "tsd-signature-type tsd-kind-class" > FaceLandmarks68< / a > < / li > < / ul > < / li > < / ul > < / section > < section class = "tsd-panel" > < h4 > Implements< / h4 > < ul class = "tsd-hierarchy" > < li > < a href = "../interfaces/IFaceLandmarks.html" class = "tsd-signature-type tsd-kind-interface" > IFaceLandmarks< / a > < / li > < / ul > < / section > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/Mixtiles/face-api/blob/master/src/classes/FaceLandmarks.ts#L20" > src/classes/FaceLandmarks.ts:20< / 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 = "FaceLandmarks.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 = "FaceLandmarks.html#imageHeight" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-262144" > < / use > < / svg > < span > image< wbr / > Height< / span > < / a >
< a href = "FaceLandmarks.html#imageWidth" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-262144" > < / use > < / svg > < span > image< wbr / > Width< / span > < / a >
< a href = "FaceLandmarks.html#positions" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-262144" > < / use > < / svg > < span > positions< / span > < / a >
< a href = "FaceLandmarks.html#relativePositions" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-262144" > < / use > < / svg > < span > relative< wbr / > Positions< / span > < / a >
< a href = "FaceLandmarks.html#shift" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-262144" > < / use > < / svg > < span > shift< / span > < / a >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Methods< / h3 > < div class = "tsd-index-list" > < a href = "FaceLandmarks.html#align" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > align< / span > < / a >
< a href = "FaceLandmarks.html#forSize" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > for< wbr / > Size< / span > < / a >
< a href = "FaceLandmarks.html#shiftBy" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > shift< wbr / > By< / span > < / a >
< a href = "FaceLandmarks.html#shiftByPoint" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-2048" > < / use > < / svg > < span > shift< wbr / > By< wbr / > Point< / 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_FaceLandmarks" class = "tsd-anchor" > < / a > < span class = "tsd-kind-constructor-signature" > new < wbr / > Face< wbr / > Landmarks< / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > relativeFaceLandmarkPositions< / span > , < span class = "tsd-kind-parameter" > imgDims< / span > , < span class = "tsd-kind-parameter" > shift< / span > < span class = "tsd-signature-symbol" > ?< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a href = "FaceLandmarks.html" class = "tsd-signature-type tsd-kind-class" > FaceLandmarks< / a > < a href = "#constructor.new_FaceLandmarks" 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" > relativeFaceLandmarkPositions< / span > : < a href = "Point.html" class = "tsd-signature-type tsd-kind-class" > Point< / a > < span class = "tsd-signature-symbol" > []< / span > < / h5 > < / li > < li > < h5 > < span class = "tsd-kind-parameter" > imgDims< / span > : < a href = "../interfaces/IDimensions.html" class = "tsd-signature-type tsd-kind-interface" > IDimensions< / a > < / h5 > < / li > < li > < h5 > < span class = "tsd-kind-parameter" > shift< / span > : < a href = "Point.html" class = "tsd-signature-type tsd-kind-class" > Point< / a > < span class = "tsd-signature-symbol" > = ...< / span > < / h5 > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "FaceLandmarks.html" class = "tsd-signature-type tsd-kind-class" > FaceLandmarks< / a > < / h4 > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/Mixtiles/face-api/blob/master/src/classes/FaceLandmarks.ts#L27" > src/classes/FaceLandmarks.ts:27< / 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" > < a id = "imageHeight" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > image< wbr / > Height< / span > < a href = "#imageHeight" 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" id = "imageHeight.imageHeight-1" > < span class = "tsd-signature-keyword" > 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 > < li class = "tsd-description" > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > number< / span > < / h4 > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/Mixtiles/face-api/blob/master/src/classes/FaceLandmarks.ts#L44" > src/classes/FaceLandmarks.ts:44< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "imageWidth" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > image< wbr / > Width< / span > < a href = "#imageWidth" 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" id = "imageWidth.imageWidth-1" > < span class = "tsd-signature-keyword" > 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 > < li class = "tsd-description" > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > number< / span > < / h4 > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/Mixtiles/face-api/blob/master/src/classes/FaceLandmarks.ts
2021-09-19 00:38:13 +02:00
bounding box, or it' s current shift. This function should be used to align the face images
after face detection has been performed, before they are passed to the face recognition net.
This will make the computed face descriptor more accurate.< / p >
2024-01-17 22:56:53 +01:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-parameter" > detection< / span > : < span class = "tsd-signature-type" > null< / span > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/IRect.html" class = "tsd-signature-type tsd-kind-interface" > IRect< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "../interfaces/IBoundingBox.html" class = "tsd-signature-type tsd-kind-interface" > IBoundingBox< / a > < span class = "tsd-signature-symbol" > | < / span > < a href = "FaceDetection.html" class = "tsd-signature-type tsd-kind-class" > FaceDetection< / a > < / h5 > < div class = "tsd-comment tsd-typography" > < p > (optional) The bounding box of the face or the face detection result. If
2021-09-19 00:38:13 +02:00
no argument was passed the position of the face landmarks are assumed to be relative to
it' s current shift.< / p >
2024-01-17 22:56:53 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < h5 > < span class = "tsd-kind-parameter" > options< / span > : < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > minBoxPadding< / span > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < span class = "tsd-kind-property" > useDlibAlignment< / span > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > = {}< / span > < / h5 > < ul class = "tsd-parameters" > < li class = "tsd-parameter" > < h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-property" > min< wbr / > Box< wbr / > Padding< / span > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > number< / span > < / h5 > < / li > < li class = "tsd-parameter" > < h5 > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span class = "tsd-kind-property" > use< wbr / > Dlib< wbr / > Alignment< / span > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > boolean< / span > < / h5 > < / li > < / ul > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "Box.html" class = "tsd-signature-type tsd-kind-class" > Box< / a > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > any< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < p > The bounding box of the aligned face.< / p >
2024-02-07 17:20:36 +01:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/Mixtiles/face-api/blob/master/src/classes/FaceLandmarks.ts#L84" > src/classes/FaceLandmarks.ts:84< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "forSize" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > for< wbr / > Size< / span > < a href = "#forSize" 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 = "forSize.forSize-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > for< wbr / > Size< / span > < span class = "tsd-signature-symbol" > < < / span > < a class = "tsd-signature-type tsd-kind-type-parameter" href = "FaceLandmarks.html#forSize.forSize-1.T" > T< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > width< / span > , < span class = "tsd-kind-parameter" > height< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a class = "tsd-signature-type tsd-kind-type-parameter" href = "FaceLandmarks.html#forSize.forSize-1.T" > T< / a > < a href = "#forSize.forSize-1" 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" > < section class = "tsd-panel" > < h4 > Type Parameters< / h4 > < ul class = "tsd-type-parameter-list" > < li > < h4 > < a id = "forSize.forSize-1.T" class = "tsd-anchor" > < / a > < span class = "tsd-kind-type-parameter" > T< / span > < span class = "tsd-signature-keyword" > extends < / span > < a href = "FaceLandmarks.html" class = "tsd-signature-type tsd-kind-class" > FaceLandmarks< / a > < / h4 > < / li > < / ul > < / section > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < span class = "tsd-kind-parameter" > width< / span > : < span class = "tsd-signature-type" > number< / span > < / h5 > < / li > < li > < h5 > < span class = "tsd-kind-parameter" > height< / span > : < span class = "tsd-signature-type" > number< / span > < / h5 > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a class = "tsd-signature-type tsd-kind-type-parameter" href = "FaceLandmarks.html#forSize.forSize-1.T" > T< / a > < / h4 > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/Mixtiles/face-api/blob/master/src/classes/FaceLandmarks.ts#L54" > src/classes/FaceLandmarks.ts:54< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member" > < a id = "shiftBy" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > shift< wbr / > By< / span > < a href = "#shiftBy" 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 = "shiftBy.shiftBy-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > shift< wbr / > By< / span > < span class = "tsd-signature-symbol" > < < / span > < a class = "tsd-signature-type tsd-kind-type-parameter" href = "FaceLandmarks.html#shiftBy.shiftBy-1.T-1" > T< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > x< / span > , < span class = "tsd-kind-parameter" > y< / span > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > : < / span > < a class = "tsd-signature-type tsd-kind-type-parameter" href = "FaceLandmarks.html#shiftBy.shiftBy-1.T-1" > T< / a > < a href = "#shiftBy.shiftBy-1" 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" > < section class = "tsd-panel" > < h4 > Type Parameters< / h4 > < ul class = "tsd-type-parameter-list" > < li > < h4 > < a id = "shiftBy.shiftBy-1.T-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-type-parameter" > T< / span > < span class = "tsd-signature-keyword" > extends < / span > < a href = "FaceLandmarks.html" class = "tsd-signature-type tsd-kind-class" > FaceLandmarks< / a > < / h4 > < / li > < / ul > < / section > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < h5 > < span class = "tsd-kind-pa
