<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: AnalysisData</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: AnalysisData</h1>
<section>
<header>
<h2>
AnalysisData
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="AnalysisData"><span class="type-signature"></span>new AnalysisData<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
AnalysisData structure, used as a container for all face analysis results.
This structure is passed as a parameter to the <a href="VisageFaceAnalyser.html#analyseImage">VisageFaceAnalyser.analyseImage()</a> or <a href="VisageFaceAnalyser.html#analyseStream">VisageFaceAnalyser.analyseStream()</a> method. Both methods store analysis results into the structure.
<br/><br/>
If an operation was not performed (turned off via options) or failed, the respective validity boolean will return false and estimations will contain the default value.
<br/><br/>
</div>
<dl class="details">
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="getAge"><span class="type-signature"></span>getAge<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
</dt>
<dd>
<div class="description">
get the age value from AnalysisData
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
result of age estimation
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getAgeValid"><span class="type-signature"></span>getAgeValid<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
</dt>
<dd>
<div class="description">
check if age value is valid
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
boolean flag returning whether age estimation has been successful or not
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getGender"><span class="type-signature"></span>getGender<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
</dt>
<dd>
<div class="description">
get the gender value from AnalysisData
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
1 for MALE gender <br> 0 for FEMALE gender
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getGenderValid"><span class="type-signature"></span>getGenderValid<span class="signature">()</span><span class="type-signature"> → {number}</span></h4>
</dt>
<dd>
<div class="description">
check if gender value is valid
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
boolean flag returning whether gender estimation has been successful or not
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getEmotionProbabilities"><span class="type-signature"></span>getEmotionProbabilities<span class="signature">()</span><span class="type-signature"> → {Array}</span></h4>
</dt>
<dd>
<div class="description">
get an array representing emotions from AnalysisData
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
result of emotion estimation, See: <a href="global.html#VFAEmotionIndices">VFAEmotionIndices</a>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="getEmotionsValid"><span class="type-signature"></span>getEmotionsValid<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
check if emotion value is valid (if the calculation was valid)
</div>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
boolean flag returning whether emotion estimation has been successful or not
</div>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-VisageTrackerUnityPlugin.html">VisageTrackerUnityPlugin</a></li><li><a href="module-VisageAnalyserUnityPlugin.html">VisageAnalyserUnityPlugin</a></li></ul><h3>Classes</h3><ul><li><a href="FaceData.html">FaceData</a></li><li><a href="ScreenSpaceGazeData.html">ScreenSpaceGazeData</a></li><li><a href="VectorFloat.html">VectorFloat</a></li><li><a href="VectorShort.html">VectorShort</a></li><li><a href="VectorString.html">VectorString</a></li><li><a href="VisageFaceAnalyser.html">VisageFaceAnalyser</a></li><li><a href="AnalysisData.html">AnalysisData</a></li><li><a href="FeaturePoint.html">FeaturePoint</a></li><li><a href="FDP.html">FDP</a></li><li><a href="VisageDetector.html">VisageDetector</a></li><li><a href="FaceDataVector.html">FaceDataVector</a></li><li><a href="VSRectVector.html">VSRectVector</a></li><li><a href="VSRect.html">VSRect</a></li><li><a href="VisageGazeTracker.html">VisageGazeTracker</a></li><li><a href="VisageFaceRecognition.html">VisageFaceRecognition</a></li><li><a href="VisageTracker.html">VisageTracker</a></li><li><a href="VisageConfiguration.html">VisageConfiguration</a></li><li><a href="VisageLivenessBlink.html">VisageLivenessBlink</a></li><li><a href="VisageLivenessSmile.html">VisageLivenessSmile</a></li><li><a href="VisageLivenessBrowRaise.html">VisageLivenessBrowRaise</a></li><li><a href="VisageAR.html">VisageAR</a></li></ul><h3>Global</h3><ul><li><a href="global.html#FP_START_GROUP_INDEX">FP_START_GROUP_INDEX</a></li><li><a href="global.html#FP_END_GROUP_INDEX">FP_END_GROUP_INDEX</a></li><li><a href="global.html#FP_NUMBER_OF_GROUPS">FP_NUMBER_OF_GROUPS</a></li><li><a href="global.html#initializeLicenseManager">initializeLicenseManager</a></li><li><a href="global.html#VisageTrackerStatus">VisageTrackerStatus</a></li><li><a href="global.html#VisageTrackerImageFormat">VisageTrackerImageFormat</a></li><li><a href="global.html#VisageTrackerOrigin">VisageTrackerOrigin</a></li><li><a href="global.html#getSDKVersion">getSDKVersion</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Sat Jul 29 2023 01:38:28 GMT-0000 (GMT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>