2025-02-05 15:15:34 +01:00
<!DOCTYPE html> < html class = "default" lang = "en" data-base = ".." > < head > < meta charset = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > FaceLandmarks68 | @vladmandic/face-api - v1.7.15< / 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/icons.js" id = "tsd-icons-script" > < / script > < script async src = "../assets/search.js" id = "tsd-search-script" > < / script > < script async src = "../assets/navigation.js" id = "tsd-nav-script" > < / script > < script async src = "../assets/hierarchy.js" id = "tsd-hierarchy-script" > < / script > < / head > < body > < script > document . documentElement . dataset . theme = localStorage . getItem ( "tsd-theme" ) || "os" ; document . body . style . display = "none" ; setTimeout ( ( ) => app ? app . showPage ( ) : document . body . style . removeProperty ( "display" ) , 500 ) < / script > < header class = "tsd-page-toolbar" > < div class = "tsd-toolbar-contents container" > < div class = "table-cell" id = "tsd-search" > < 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 = "../assets/icons.svg#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.15< / 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 = "../assets/icons.svg#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 = "FaceLandmarks68.html" > FaceLandmarks68< / a > < / li > < / ul > < h1 > Class FaceLandmarks68< / h1 > < / div > < section class = "tsd-panel tsd-hierarchy" data-refl = "2696" > < h4 > Hierarchy (< a href = "../hierarchy.html#FaceLandmarks68" > View Summary< / a > )< / h4 > < ul class = "tsd-hierarchy" > < li class = "tsd-hierarchy-item" > < a href = "FaceLandmarks.html" class = "tsd-signature-type tsd-kind-class" > FaceLandmarks< / a > < ul class = "tsd-hierarchy" > < li class = "tsd-hierarchy-item" > < span class = "tsd-hierarchy-target" > FaceLandmarks68< / span > < / li > < / ul > < / li > < / ul > < / section > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/vladmandic/face-api/blob/master/src/classes/FaceLandmarks68.ts#L5" > src/classes/FaceLandmarks68.ts:5< / 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-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 = "../assets/icons.svg#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 = "FaceLandmarks68.html#constructor" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-512" > < / use > < / svg > < span > constructor< / span > < / a >
2025-02-05 15:02:06 +01:00
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Accessors< / h3 > < div class = "tsd-index-list" > < a href = "FaceLandmarks68.html#imageheight" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > image< wbr / > Height< / span > < / a >
< a href = "FaceLandmarks68.html#imagewidth" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > image< wbr / > Width< / span > < / a >
2024-09-10 17:30:23 +02:00
< a href = "FaceLandmarks68.html#positions" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > positions< / span > < / a >
2025-02-05 15:02:06 +01:00
< a href = "FaceLandmarks68.html#relativepositions" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-262144" > < / use > < / svg > < span > relative< wbr / > Positions< / span > < / a >
2024-09-10 17:30:23 +02:00
< a href = "FaceLandmarks68.html#shift" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#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 = "FaceLandmarks68.html#align" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > align< / span > < / a >
2025-02-05 15:02:06 +01:00
< a href = "FaceLandmarks68.html#forsize" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > for< wbr / > Size< / span > < / a >
< a href = "FaceLandmarks68.html#getjawoutline" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Jaw< wbr / > Outline< / span > < / a >
< a href = "FaceLandmarks68.html#getlefteye" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Left< wbr / > Eye< / span > < / a >
< a href = "FaceLandmarks68.html#getlefteyebrow" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Left< wbr / > Eye< wbr / > Brow< / span > < / a >
< a href = "FaceLandmarks68.html#getmouth" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Mouth< / span > < / a >
< a href = "FaceLandmarks68.html#getnose" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Nose< / span > < / a >
< a href = "FaceLandmarks68.html#getrighteye" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Right< wbr / > Eye< / span > < / a >
< a href = "FaceLandmarks68.html#getrighteyebrow" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > get< wbr / > Right< wbr / > Eye< wbr / > Brow< / span > < / a >
< a href = "FaceLandmarks68.html#shiftby" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > shift< wbr / > By< / span > < / a >
< a href = "FaceLandmarks68.html#shiftbypoint" class = "tsd-index-link tsd-is-inherited" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-2048" > < / use > < / svg > < span > shift< wbr / > By< wbr / > Point< / span > < / a >
< / div > < / section > < / div > < / details > < / section > < / section > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Constructors" > < h2 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Constructors< / h2 > < / summary > < section > < 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 = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "constructorfacelandmarks68" class = "tsd-anchor" > < / a > < span class = "tsd-signature-keyword" > new< / span > < span class = "tsd-kind-constructor-signature" > FaceLandmarks68< / span > < span class = "tsd-signature-symbol" > (< / span > < br / > < span class = "tsd-kind-parameter" > relativeFaceLandmarkPositions< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "Point.html" class = "tsd-signature-type tsd-kind-class" > Point< / a > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > ,< / span > < br / > < span class = "tsd-kind-parameter" > imgDims< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "../interfaces/IDimensions.html" class = "tsd-signature-type tsd-kind-interface" > IDimensions< / a > < span class = "tsd-signature-symbol" > ,< / span > < br / > < span class = "tsd-kind-parameter" > shift< / span > < span class = "tsd-signature-symbol" > ?:< / span > < a href = "Point.html" class = "tsd-signature-type tsd-kind-class" > Point< / a > < span class = "tsd-signature-symbol" > ,< / span > < br / > < span class = "tsd-signature-symbol" > )< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "FaceLandmarks68.html" class = "tsd-signature-type tsd-kind-class" > FaceLandmarks68< / a > < a href = "#constructorfacelandmarks68" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#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 > < span > < 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 > < / span > < / li > < li > < span > < span class = "tsd-kind-parameter" > imgDims< / span > : < a href = "../interfaces/IDimensions.html" class = "tsd-signature-type tsd-kind-interface" > IDimensions< / a > < / span > < / li > < li > < span > < 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 > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "FaceLandmarks68.html" class = "tsd-signature-type tsd-kind-class" > FaceLandmarks68< / a > < / h4 > < aside class = "tsd-sources" > < p > Inherited from < a href = "FaceLandmarks.html" > FaceLandmarks< / a > .< a href = "FaceLandmarks.html#constructor" > constructor< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/vladmandic/face-api/blob/master/src/classes/FaceLandmarks.ts#L27" > src/classes/FaceLandmarks.ts:27< / a > < / li > < / ul > < / aside > < / li > < / ul > < / section > < / section > < / details > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Accessors" > < h2 > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Accessors< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member tsd-is-inherited" > < 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 = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-is-inherited" > < li class = "tsd-signature" id = "imageheight-1" > < span class = "tsd-signature-keyword" > get< / span > < span class = "tsd-kind-get-signature" > imageHeight< / span > < span class = "tsd-signature-symbol" > ()< /s
2024-09-10 17:30:23 +02:00
bounding box, or it's current shift. This function should be used to align the face images
2021-09-19 00:38:13 +02:00
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 >
2025-02-05 15:02:06 +01:00
< / div > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < code class = "tsd-tag" > 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 > < / span > < 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
2024-09-10 17:30:23 +02:00
it's current shift.< / p >
2025-02-05 15:02:06 +01:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / li > < li > < span > < span class = "tsd-kind-parameter" > options< / span > : < span class = "tsd-signature-symbol" > {< / 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 > < 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 > < span class = "tsd-signature-symbol" > = {}< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a href = "Box.html" class = "tsd-signature-type tsd-kind-class" > Box< / a > < / h4 > < p > The bounding box of the aligned face.< / p >
2025-02-05 15:15:34 +01:00
< div class = "tsd-comment tsd-typography" > < / div > < aside class = "tsd-sources" > < p > Inherited from < a href = "FaceLandmarks.html" > FaceLandmarks< / a > .< a href = "FaceLandmarks.html#align" > align< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/vladmandic/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 tsd-is-inherited" > < 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 = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-is-inherited" > < li class = "tsd-signature tsd-anchor-link" > < a id = "forsize-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > forSize< / span > < span class = "tsd-signature-symbol" > < < / span > < a class = "tsd-signature-type tsd-kind-type-parameter" href = "FaceLandmarks68.html#forsizet" > T< / a > < span class = "tsd-signature-keyword" > extends< / span > < a href = "FaceLandmarks.html" class = "tsd-signature-type tsd-kind-class" > FaceLandmarks< / a > < span class = "tsd-signature-symbol" > > < / span > < span class = "tsd-signature-symbol" > (< / span > < span class = "tsd-kind-parameter" > width< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > ,< / span > < span class = "tsd-kind-parameter" > height< / span > < 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 class = "tsd-signature-type tsd-kind-type-parameter" href = "FaceLandmarks.html#forsizet" > T< / a > < a href = "#forsize-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#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 > < span > < a id = "forsizet" 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 > < / span > < / li > < / ul > < / section > < div class = "tsd-parameters" > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameter-list" > < li > < span > < span class = "tsd-kind-parameter" > width< / span > : < span class = "tsd-signature-type" > number< / span > < / span > < / li > < li > < span > < span class = "tsd-kind-parameter" > height< / span > : < span class = "tsd-signature-type" > number< / span > < / span > < / li > < / ul > < / div > < h4 class = "tsd-returns-title" > Returns < a class = "tsd-signature-type tsd-kind-type-parameter" href = "FaceLandmarks.html#forsizet" > T< / a > < / h4 > < aside class = "tsd-sources" > < p > Inherited from < a href = "FaceLandmarks.html" > FaceLandmarks< / a > .< a href = "FaceLandmarks.html#forsize" > forSize< / a > < / p > < ul > < li > Defined in < a href = "https://github.com/vladmandic/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 = "getjawoutline" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > get< wbr / > Jaw< wbr / > Outline< / span > < a href = "#getjawoutline" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h3 > < ul class = "tsd-signatures" > < li class = "tsd-signature tsd-anchor-link" > < a id = "getjawoutline-1" class = "tsd-anchor" > < / a > < span class = "tsd-kind-call-signature" > getJawOutline< / span > < span class = "tsd-signature-symbol" > ()< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "Point.html" class = "tsd-signature-type tsd-kind-class" > Point< / a > < span class = "tsd-signature-symbol" > []< / span > < a href = "#getjawoutline-1" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / li > < li class = "tsd-description" > < h4 class = "tsd-returns-title" > Returns < a href = "Point.html" class = "tsd-signature-type tsd-kind-class" > Point< / a > < span class = "tsd-signature-sym
