## Uses of Class
eu.id3.face.FaceException

- - ### Uses of FaceException in eu.id3.face

    Methods in eu.id3.face that throw FaceException
    Modifier and Type | Method and Description
    --- | ---
    `static void` | FaceLicense.`activate(java.lang.String hardwareCode, java.lang.String login, java.lang.String password, java.lang.String productReference, java.lang.String commentary, java.lang.String path)` Activates a license using customer credentials and a product reference and saves the license to a file.
    `static void` | FaceLicense.`activateActivationKey(java.lang.String hardwareCode, java.lang.String activationKey, java.lang.String commentary, java.lang.String path)` Activates a license file using an activation key and saves the license to a file.
    `static byte[]` | FaceLicense.`activateActivationKeyBuffer(java.lang.String hardwareCode, java.lang.String activationKey, java.lang.String commentary)` Activates a license using an activation key and returns the license in a data buffer.
    `static byte[]` | FaceLicense.`activateBuffer(java.lang.String hardwareCode, java.lang.String login, java.lang.String password, java.lang.String productReference, java.lang.String commentary)` Retrieves a license file buffer using customer credentials and a product reference and returns the license in a data buffer.
    `static void` | FaceLicense.`activateSerialKey(java.lang.String hardwareCode, java.lang.String serialKey, java.lang.String commentary, java.lang.String path)` Activates a license using a serial key and saves the license to a file.
    `static byte[]` | FaceLicense.`activateSerialKeyBuffer(java.lang.String hardwareCode, java.lang.String serialKey, java.lang.String commentary)` Activates a license using a serial key and returns the license in a data buffer.
    `void` | DetectedFaceList.`add(DetectedFace detectedFaceItem)` Adds an item to the DetectedFaceList object.
    `void` | FaceCandidateList.`add(FaceCandidate faceCandidateItem)` Adds an item to the FaceCandidateList object.
    `void` | FaceTemplateList.`add(FaceTemplate faceTemplateItem)` Adds an item to the FaceTemplateList object.
    `void` | ImageList.`add(Image imageItem)` Adds an item to the ImageList object.
    `void` | PointList.`add(Point pointItem)` Adds an item to the PointList object.
    `void` | StringList.`add(java.lang.String item)` Adds an item to the StringList object.
    `void` | FaceTemplateDict.`add(java.lang.String key, FaceTemplate faceTemplateItem)` Adds an item to the FaceTemplateDict object.
    `void` | ImageDict.`add(java.lang.String key, Image imageItem)` Adds an item to the ImageDict object.
    `void` | TrackedFaceList.`add(TrackedFace trackedFaceItem)` Adds an item to the TrackedFaceList object.
    `void` | FaceIndexer.`addTemplate(FaceTemplate faceTemplate, java.lang.String id)` Adds a template to the Face Indexer.
    `Image` | FaceAnalyser.`applyAlphaMask(Image image, Image mask)` Applies an alpha mask to suppress the background and returns a 32-bit BGRA image.
    `Image` | FaceAnalyser.`applyMask(Image image, Image mask, int red, int green, int blue)` Applies a mask to replace the background with the specified color and returns a 24-bit BGR image.
    `boolean` | FaceAnalyser.`checkColorizedImage(Image image)` Verifies if an image is colorized or grayscale.
    `static void` | FaceLicense.`checkLicense(java.lang.String licensePath)` Checks a license from a file.
    `static void` | FaceLicense.`checkLicenseBuffer(byte[] licenseData)` Checks a license from a buffer.
    `static byte[]` | FaceLicense.`checkLicenseBufferWithCard(byte[] licenseData)` Checks the license using a buffer containing the license data and a card-based verification process.
    `static byte[]` | FaceLicense.`checkLicenseWithCard(java.lang.String licensePath)` Checks the license by using a card-based verification process.
    `static void` | FaceLicense.`checkModule(java.lang.String moduleName)` Checks if a module is present in the previously loaded license.
    `void` | TrackedFaceList.`clear()` Clears the TrackedFaceList object.
    `void` | StringList.`clear()` Clears the StringList object.
    `void` | Portrait.`clear()` Clears all attributes.
    `void` | PointList.`clear()` Clears the PointList object.
    `void` | ImageList.`clear()` Clears the ImageList object.
    `void` | ImageDict.`clear()` Clears the ImageDict object.
    `void` | FaceTemplateList.`clear()` Clears the FaceTemplateList object.
    `void` | FaceTemplateDict.`clear()` Clears the FaceTemplateDict object.
    `void` | FaceCandidateList.`clear()` Clears the FaceCandidateList object.
    `void` | DetectedFaceList.`clear()` Clears the DetectedFaceList object.
    `TrackedFaceList` | TrackedFaceList.`clone()` Creates a copy of the TrackedFaceList object.
    `TrackedFace` | TrackedFace.`clone()` Creates a copy of the TrackedFace object.
    `Portrait` | Portrait.`clone()` Creates a copy of the Portrait object.
    `PointList` | PointList.`clone()` Creates a copy of the PointList object.
    `ImageList` | ImageList.`clone()` Creates a copy of the ImageList object.
    `ImageDict` | ImageDict.`clone()` Creates a copy of the ImageDict object.
    `ImageBuffer` | ImageBuffer.`clone()` Creates a copy of the ImageBuffer object.
    `Image` | Image.`clone()` Creates a copy of the Image object.
    `FaceTemplateList` | FaceTemplateList.`clone()` Creates a copy of the FaceTemplateList object.
    `FaceTemplateDict` | FaceTemplateDict.`clone()` Creates a copy of the FaceTemplateDict object.
    `FaceTemplate` | FaceTemplate.`clone()` Creates a copy of the FaceTemplate object.
    `FaceCandidateList` | FaceCandidateList.`clone()` Creates a copy of the FaceCandidateList object.
    `FaceCandidate` | FaceCandidate.`clone()` Creates a copy of the FaceCandidate object.
    `DetectedFaceList` | DetectedFaceList.`clone()` Creates a copy of the DetectedFaceList object.
    `DetectedFace` | DetectedFace.`clone()` Creates a copy of the DetectedFace object.
    `float` | Image.`compare(Image cmpImage)` Computes the difference with another image.
    `int` | FaceMatcher.`compareTemplateLists(FaceTemplateList referenceList, FaceTemplateList probeList, PoolingMethod poolingMethod)` Compares two template lists and outputs a comparison score.
    `int` | FaceMatcher.`compareTemplates(FaceTemplate reference, FaceTemplate probe)` Compares two templates and outputs a comparison score.
    `int` | FaceAnalyser.`computeAge(Image image, DetectedFace detectedFace)` Computes the age of a detected face.
    `FaceAttributes` | FaceAnalyser.`computeAttributes(Image image, DetectedFace detectedFace)` Computes the attributes of a detected face.
    `BackgroundUniformity` | FaceAnalyser.`computeBackgroundUniformity(Image image, DetectedFace detectedFace)` Computes the background uniformity behind a detected face.
    `int` | FacePad.`computeBlurrinessScore(Image image, DetectedFace detectedFace)` Computes a blurriness score for a color image.
    `ColorBasedPadResult` | FacePad.`computeColorBasedScore(Image image, DetectedFace detectedFace)` Computes the PAD score and confidence of a detected face using only the color image.
    `int` | FacePad.`computeDepthBasedScore(Image image, DetectedFace detectedFace)` Computes the PAD score of a detected face using a depth map image.
    `FaceExpression` | FaceAnalyser.`computeExpression(Image image, DetectedFace detectedFace)` Computes the expression of a detected face.
    `EyeGaze` | FaceAnalyser.`computeEyeGaze(Image image, DetectedFace detectedFace, PointList landmarks)` Computes the eye gaze of a detected face.
    `int[]` | FaceAnalyser.`computeEyeOpenness(Image image, DetectedFace detectedFace, PointList landmarks)` Computes the eye openness of a detected face.
    `int[]` | FaceAnalyser.`computeEyeRedness(Image image, DetectedFace detectedFace, PointList landmarks)` Computes the eye redness of a detected face.
    `GeometricAttributes` | FaceAnalyser.`computeGeometricAttributes(Image image, DetectedFace detectedFace, PointList landmarks)` Computes the geometric attributes of a detected face.
    `GlassesAttributes` | FaceAnalyser.`computeGlassesAttributes(Image image, DetectedFace detectedFace, PointList landmarks)` Computes the glasses attributes of a detected face.
    `PointList` | FaceAnalyser.`computeLandmarks(Image image, DetectedFace detectedFace)` Computes 68 landmarks of a detected face.
    `int` | FaceAnalyser.`computeNoise(Image image)` Measures the image noise.
    `PhotographicAttributes` | FaceAnalyser.`computePhotographicAttributes(Image image, DetectedFace detectedFace, PointList landmarks)` Computes the photographic attributes of a detected face.
    `FacePose` | FaceAnalyser.`computePose(DetectedFace detectedFace)` Computes the pose of a detected face.
    `FacePose` | FaceAnalyser.`computePoseWithLandmarks(DetectedFace detectedFace, PointList landmarks)` Computes the pose of a detected face using the specified 68-point landmarks.
    `int` | FaceEncoder.`computeQuality(Image image, DetectedFace detectedFace)` Computes the quality of a detected face.
    `boolean` | ImageDict.`containsKey(java.lang.String key)` Determines whether the ImageDictobject contains the specified key.
    `boolean` | FaceTemplateDict.`containsKey(java.lang.String key)` Determines whether the FaceTemplateDictobject contains the specified key.
    `void` | Image.`correctGamma(int contrast, int brightness, float gamma)` Applies a gamma correction to the image.
    `static FaceIndexer` | FaceIndexer.`create(int maximumTemplateCount, FaceTemplateFormat format)` Creates an empty face indexer
    `static TrackedFace` | TrackedFace.`create(Rectangle bounds, int detectionScore, int id, PointList landmarks)` Creates a detected face.
    `static DetectedFace` | DetectedFace.`create(Rectangle bounds, int detectionScore, int id, PointList landmarks)` Creates a detected face.
    `Portrait` | PortraitProcessor.`createPortrait(Image image)` Analyses an image and creates a portrait with the first detected face or the currently tracked face if the update parameter is activated.
    `FaceTemplate` | FaceEncoder.`createTemplate(Image image, DetectedFace detectedFace)` Extracts the unique features of a detected face and store them in a FaceTemplate.
    `Image` | Image.`crop(int left, int top, int width, int height)` Crop a rectangular region of interest in the image according to the given bounds.
    `Image` | PortraitProcessor.`cropIcaoPortrait(Portrait portrait)` Creates an ICAO-compliant portrait image by cropping the source image around the detected face.
    `Image` | PortraitProcessor.`cropPortrait(Portrait portrait)` Creates a portrait image by cropping the source image around the detected face.
    `void` | FaceIndexer.`deleteTemplate(java.lang.String id)` Deletes a template from the face indexer.
    `DetectedFaceAttackSupport` | FacePad.`detectAttackSupport(Image image, DetectedFace detectedFace)` Detects if an attack support surrounds the detected face.
    `int` | FaceAnalyser.`detectFaceMask(Image image, DetectedFace detectedFace)` Detects the presence of a face mask on a detected face.
    `DetectedFaceList` | FaceDetector.`detectFaces(Image image)` Detects faces in an image and store their info in a DetectedFaceList object.
    `void` | FaceTracker.`detectFaces(Image image, TrackedFaceList trackedFaceList)` Detects faces in an image and update their info in a TrackedFaceList object.
    `FaceOcclusionScores` | FaceAnalyser.`detectOcclusions(Image image, DetectedFace detectedFace)` Detects occlusions on the subject's face.
    `void` | PortraitProcessor.`detectOcclusions(Portrait portrait)` Detects occlusions on the subject's face.
    `void` | PortraitProcessor.`detectPresentationAttack(Portrait portrait)` Detects a possible presentation attack.
    `float` | Image.`downscale(int maxSize)` Downscales the image in-place so that its maximum dimension is equal to the given maximum size, while preserving the aspect ratio.
    `float` | Image.`downscaleTo(Image dstImage, int maxSize)` Downscales the image so that its maximum dimension equals the given maximum size, while preserving the aspect ratio.
    `void` | PortraitProcessor.`estimateAge(Portrait portrait)` Estimates the age of the person.
    `void` | PortraitProcessor.`estimateBackgroundUniformity(Portrait portrait)` Checks the background uniformity of the specified portrait.
    `void` | PortraitProcessor.`estimateExpression(Portrait portrait)` Estimates the subject's expression on the specified portrait.
    `void` | PortraitProcessor.`estimateFaceAttributes(Portrait portrait)` Estimates the face attributes of the specified portrait.
    `void` | PortraitProcessor.`estimateGeometryQuality(Portrait portrait)` Estimates the geometric quality of the specified portrait according to the ICAO portrait parameters.
    `void` | PortraitProcessor.`estimatePhotographicQuality(Portrait portrait)` Etimates the photographic quality of the specified portrait.
    `Image` | Image.`extractRoi(Rectangle bounds)` Extracts a region of interest in the image according to the given bounds.
    `Image` | Image.`extractRoiWithColor(Rectangle bounds, int colorRed, int colorGreen, int colorBlue)` Extracts a region of interest in the image according to the given bounds.
    `static void` | FaceLicense.`finalizeCheckLicenseWithCard(byte[] cryptogram)` Finalizes the license check process using the provided cryptogram.
    `DetectedFace` | DetectedFaceList.`findDetectedFace(int id)` Finds a detected face by ID.
    `TrackedFace` | TrackedFaceList.`findTrackedFace(int id)` Finds a tracked face by ID.
    `void` | Image.`flip(boolean flipHorizontally, boolean flipVertically)` Flips the image in-place.
    `void` | Image.`flipTo(boolean flipHorizontally, boolean flipVertically, Image dstImage)` Flips the image.
    `static TrackedFace` | TrackedFace.`fromBuffer(byte[] data)` Imports the face object from a buffer.
    `static Portrait` | Portrait.`fromBuffer(byte[] data)` Imports the portrait object from a buffer.
    `static FaceTemplate` | FaceTemplate.`fromBuffer(byte[] data)` Imports the face template object from a buffer.
    `static DetectedFace` | DetectedFace.`fromBuffer(byte[] data)` Imports the face object from a buffer.
    `static Image` | Image.`fromBuffer(byte[] data, PixelFormat pixelFormat)` Creates an Image from the specified data buffer.
    `static TrackedFace` | TrackedFace.`fromFile(java.lang.String path)` Imports the face object from a file.
    `static FaceTemplate` | FaceTemplate.`fromFile(java.lang.String path)` Imports the face template object from a file.
    `static FaceIndexer` | FaceIndexer.`fromFile(java.lang.String path)` Imports the face indexer object from a file.
    `static DetectedFace` | DetectedFace.`fromFile(java.lang.String path)` Imports the face object from a file.
    `static Image` | Image.`fromFile(java.lang.String filepath, PixelFormat pixelFormat)` Creates an Image from the specified file.
    `static Image` | Image.`fromRawBuffer(byte[] pixels, int width, int height, int stride, PixelFormat srcPixelFormat, PixelFormat dstPixelFormat)` Creates an Image from the specified raw data buffer.
    `static Image` | Image.`fromYuvPlanes(byte[] yPlane, byte[] uPlane, byte[] vPlane, int yWidth, int yHeight, int uvPixelStride, int uvRowStride, PixelFormat dstPixelFormat)` Creates an Image from the specified YUV planes.
    `TrackedFace` | TrackedFaceList.`get(int index)` Gets an item of the TrackedFaceList object.
    `java.lang.String` | StringList.`get(int index)` Gets an item of the StringList object.
    `Point` | PointList.`get(int index)` Gets an item of the PointList object.
    `Image` | ImageList.`get(int index)` Gets an item of the ImageList object.
    `FaceTemplate` | FaceTemplateList.`get(int index)` Gets an item of the FaceTemplateList object.
    `FaceCandidate` | FaceCandidateList.`get(int index)` Gets an item of the FaceCandidateList object.
    `DetectedFace` | DetectedFaceList.`get(int index)` Gets an item of the DetectedFaceList object.
    `Image` | ImageDict.`get(java.lang.String key)` Gets an item of the ImageDict object.
    `FaceTemplate` | FaceTemplateDict.`get(java.lang.String key)` Gets an item of the FaceTemplateDict object.
    `int` | Portrait.`getAge()` Gets the estimated age of the subject. -1 if not computed.
    `DetectedFace` | TrackedFace.`getAsDetectedFace()` Gets the tracked face as a detected face.
    `int` | FacePad.`getAttackSupportDetectorConfidenceThreshold()` Gets the attack support detector confidence threshold, in the range [0;100].
    `int` | PortraitProcessor.`getBackgroundColorUniformityThreshold()` Gets the background color uniformity threshold.
    `int` | PortraitProcessor.`getBackgroundStructureUniformityThreshold()` Gets the background structure uniformity threshold.
    `BackgroundUniformity` | Portrait.`getBackgroundUniformity()` Gets the result of the background uniformity computation.
    `Rectangle` | TrackedFace.`getBounds()` Gets the bounds of the detected face.
    `Rectangle` | DetectedFace.`getBounds()` Gets the bounds of the detected face.
    `int` | FaceTracker.`getConfidenceThreshold()` Gets the confidence threshold, in the range [0;100].
    `int` | FaceDetector.`getConfidenceThreshold()` Gets the confidence threshold, in the range [0;100].
    `int` | TrackedFaceList.`getCount()` Gets the number of elements in the TrackedFaceList object.
    `int` | StringList.`getCount()` Gets the number of elements in the StringList object.
    `int` | PointList.`getCount()` Gets the number of elements in the PointList object.
    `int` | ImageList.`getCount()` Gets the number of elements in the ImageList object.
    `int` | ImageDict.`getCount()` Gets the number of elements in the ImageDict object.
    `int` | FaceTemplateList.`getCount()` Gets the number of elements in the FaceTemplateList object.
    `int` | FaceTemplateDict.`getCount()` Gets the number of elements in the FaceTemplateDict object.
    `int` | FaceCandidateList.`getCount()` Gets the number of elements in the FaceCandidateList object.
    `int` | DetectedFaceList.`getCount()` Gets the number of elements in the DetectedFaceList object.
    `float` | PortraitProcessor.`getCropAspectRatio()` Gets the aspect ratio (height to width) of the cropped portrait image.
    `float` | PortraitProcessor.`getCropEyePositionRatio()` Gets the ratio between the vertical eye position and the image height for ICAO portrait cropping.
    `float` | PortraitProcessor.`getCropIodRatio()` Gets the ratio between the interocular distance (IOD) and the image width for ICAO portrait cropping.
    `float` | PortraitProcessor.`getCropMargin()` Gets the relative margin around the face for basic portrait cropping.
    `byte[]` | ImageBuffer.`getData()` Gets the image buffer data.
    `byte[]` | Image.`getData()` Gets the raw data buffer of the image.
    `FaceModel` | FaceTracker.`getDetectionModel()` Gets the model used to detect and track faces.
    `int` | TrackedFace.`getDetectionScore()` Gets the confidence score of the detected face.
    `int` | DetectedFace.`getDetectionScore()` Gets the confidence score of the detected face.
    `int` | TrackedFace.`getDistanceToCamera(Image depthImage)` Gets the distance between the detected face and the camera when using a depth map in pixels.
    `int` | DetectedFace.`getDistanceToCamera(Image depthImage)` Gets the distance between the detected face and the camera when using a depth map in pixels.
    `int` | PortraitProcessor.`getDynamicRangeThreshold()` Gets the face dynamic range threshold.
    `FaceModel` | FaceTracker.`getEncodingModel()` Gets the model used to create features and assess consistancy among views of a given face.
    `int` | PortraitProcessor.`getEqualBrightnessThreshold()` Gets the equal brightness threshold.
    `Rectangle` | TrackedFace.`getExpandedBounds(float aspectRatio, float margin)` Gets the bounding box around the detected face with specified aspect ratio and specified margin.
    `Rectangle` | DetectedFace.`getExpandedBounds(float aspectRatio, float margin)` Gets the bounding box around the detected face with specified aspect ratio and specified margin.
    `static java.lang.String` | FaceLicense.`getExpiryDate()` Retrieves the license expiry date.
    `FaceExpression` | Portrait.`getExpression()` Gets the estimated expression of the subject (angriness, disgust, fear, happiness, sadness, surprise, or neutral).
    `int` | PortraitProcessor.`getExpressionSensibility()` Gets the sensibility of the expression classifier.
    `int` | FaceAnalyser.`getExpressionSensibility()` Gets the sensibility of the expression classifier.
    `static java.lang.String` | FaceLicense.`getExternalDriveHardwareCode(LicenseHardwareCodeType hardwareCodeType, java.lang.String externalDrivePath)` Retrieves the hardware code of the external drive you run the library on.
    `EyeGaze` | Portrait.`getEyeGaze()` Gets the estimated gaze.
    `int` | PortraitProcessor.`getEyeOcclusionThreshold()` Gets the visible eye threshold.
    `int` | PortraitProcessor.`getEyeOpeningThreshold()` Gets the eye opening threshold.
    `int` | PortraitProcessor.`getFaceDetectionImageSize()` Gets the the size, in pixels, of the downscaled image used for face detection.
    `FaceModel` | PortraitProcessor.`getFaceDetectionModel()` Gets the specifies the model used to detect and track faces.
    `int` | PortraitProcessor.`getFaceDetectionThreshold()` Gets the specifies the face detection confidence threshold, in the range is [0;100].
    `FaceModel` | PortraitProcessor.`getFaceEncodingModel()` Gets the model used to create features and assess consistancy among views of a given face.
    `int` | Portrait.`getFaceId()` Gets the unique face ID.
    `int` | Portrait.`getFaceMask()` Gets the value indicating whether a face mask is detected.
    `int` | PortraitProcessor.`getFaceMaskThreshold()` Gets the face mask detection threshold.
    `FaceTemplate` | TrackedFace.`getFaceTemplate()` Gets the computed template the tracked face.
    `FaceTemplate` | Portrait.`getFaceTemplate()` Gets the face template.
    `FaceTemplateFormat` | FaceTemplate.`getFormat()` Gets the format of the face template.
    `FaceTemplateFormat` | FaceIndexer.`getFormat()` Gets the face template format accepted by this face indexer.
    `int` | Portrait.`getGenderMale()` Gets the value indicating whether the subject is a male. -1 if not computed.
    `GeometricAttributes` | Portrait.`getGeometricAttributes()` Gets the geometric attributes.
    `int` | Portrait.`getGlasses()` Gets the value indicating whether the subject wears glasses. -1 if not computed.
    `int` | PortraitProcessor.`getGlassesThreshold()` Gets the glasses detection threshold.
    `int` | Portrait.`getHat()` Gets the value indicating whether the subject wears a hat. -1 if not computed.
    `int` | PortraitProcessor.`getHatThreshold()` Gets the threshold for confirming that the person is wearing a hat.
    `int` | Image.`getHeight()` Gets the height in pixels.
    `static java.lang.String` | FaceLicense.`getHostHardwareCode(LicenseHardwareCodeType hardwareCodeType)` Retrieves the hardware code of the device using the requested hardware code type.
    `int` | TrackedFace.`getId()` Gets the ID of the detected face.
    `java.lang.String` | FaceCandidate.`getId()` Gets the ID of the most similar face template as defined in the reference face template list used to perform the search.
    `int` | DetectedFace.`getId()` Gets the ID of the detected face.
    `int[]` | TrackedFaceList.`getIdList()` Gets the list of IDs in the list.
    `int[]` | DetectedFaceList.`getIdList()` Gets the list of IDs in the list.
    `Image` | Portrait.`getImage()` Gets the source image.
    `Point` | Portrait.`getImageCenter()` Gets the center of the portrait in the source image.
    `float` | Portrait.`getImageScale()` Gets the scale to be applied to the source image to display the portrait.
    `Point` | Portrait.`getImageTranslation()` Gets the translation to be applied to the source image to display the portrait.
    `PortraitInstruction` | Portrait.`getInstruction()` Gets the instruction to be given to the user for portrait capture.
    `int` | TrackedFace.`getInterocularDistance()` Gets the distance between the eyes (IOD) of the detected face in pixels.
    `int` | DetectedFace.`getInterocularDistance()` Gets the distance between the eyes (IOD) of the detected face in pixels.
    `StringList` | ImageDict.`getKeys()` Gets the gets a string list containing the keys in the dict.
    `StringList` | FaceTemplateDict.`getKeys()` Gets the gets a string list containing the keys in the dict.
    `PointList` | TrackedFace.`getLandmarks()` Gets the landmarks (eyes, nose and mouth corners) of the detected face.
    `PointList` | Portrait.`getLandmarks()` Gets the 68-points landmarks.
    `PointList` | DetectedFace.`getLandmarks()` Gets the landmarks (eyes, nose and mouth corners) of the detected face.
    `TrackedFace` | TrackedFaceList.`getLargestFace()` Gets the largest face in the list.
    `DetectedFace` | DetectedFaceList.`getLargestFace()` Gets the largest face in the list.
    `int` | Portrait.`getLeftEyeOpening()` Gets the value estimating the opening of the left eye. -1 if not computed.
    `int` | Portrait.`getLeftEyeVisibility()` Gets the value estimating the visibility of the left eye. -1 if not computed.
    `static java.lang.String` | FaceLicense.`getLicenseFileHardwareCode()` Retrieves the hardware code of the previously loaded license.
    `static java.lang.String` | FaceLicense.`getLicenseFileSerial()` Retrieves the serial number of the previously loaded license.
    `static java.lang.String` | FaceLicense.`getLicenseName()` Retrieves the license name.
    `static java.lang.String` | FaceLicense.`getLicenseOwner()` Retrieves the license owner.
    `static java.lang.String` | FaceLicense.`getLicensePath()` Retrieves the license path.
    `static LicenseType` | FaceLicense.`getLicenseType()` Retrieves the license type.
    `int` | Portrait.`getLookStraightScore()` Gets the value estimating if the user is looking straight towards the camera. -1 if not computed.
    `int` | Portrait.`getMakeup()` Gets the value indicating whether makeup is detected. -1 if not computed.
    `int` | PortraitProcessor.`getMakeupThreshold()` Gets the make-up detection threshold.
    `int` | PortraitProcessor.`getMaleThreshold()` Gets the male gender detection threshold.
    `int` | FaceTracker.`getMatchThreshold()` Gets the minimum match score to reach to preserve the ID of a tracked face between frame 't-1' and frame 't'.
    `int` | PortraitProcessor.`getMaximumEyeGazeX()` Gets the maximum value of the eye gaze alongside the X axis.
    `int` | PortraitProcessor.`getMaximumEyeGazeY()` Gets the maximum value of the eye gaze alongside the Y axis.
    `int` | PortraitProcessor.`getMaximumHeadHeightRatio()` Gets the maximum distance between the base of the chin and the crown is less than 80% of the total height of the image.
    `int` | PortraitProcessor.`getMaximumHeadWidthRatio()` Gets the value indicating if the image width is conform to the (image width / head width) ratio of 7:5.
    `int` | PortraitProcessor.`getMaximumHorizontalPosition()` Gets the value indicating if the head is correctly centered horizontally.
    `int` | PortraitProcessor.`getMaximumIod()` Gets the maximum interocular distance (IOD), in pixels.
    `float` | PortraitProcessor.`getMaximumPitchAngle()` Gets the maximum head pitch angle, in degrees, for frontal positioning.
    `float` | PortraitProcessor.`getMaximumRollAngle()` Gets the maximum head roll angle, in degrees, for frontal positioning.
    `int` | FaceIndexer.`getMaximumTemplateCount()` Gets the maximum number of templates that this face indexer can hold.
    `int` | FaceTracker.`getMaximumTrackedFaceAge()` Gets the maximum number of consecutive non-detections to reach before deleting a tracked face.
    `int` | PortraitProcessor.`getMaximumVerticalPosition()` Gets the maximum distance from the bottom edge of the image to the imaginary line passing through the center of the eyes is between 50% - 70% of the total vertical length of the image.
    `float` | PortraitProcessor.`getMaximumYawAngle()` Gets the maximum head yaw angle, in degrees, for frontal positioning.
    `int` | FaceEncoder.`getMinimalIod()` Gets the minimal interocular distance (IOD) in pixels required to perform a face encoding.
    `int` | PortraitProcessor.`getMinimumHeadHeightRatio()` Gets the minimum distance between the base of the chin and the crown is less than 80% of the total height of the image.
    `int` | PortraitProcessor.`getMinimumHeadWidthRatio()` Gets the value indicating if the image width is conform to the (image width / head width) ratio of 7:5.
    `int` | PortraitProcessor.`getMinimumHorizontalPosition()` Gets the value indicating if the head is correctly centered horizontally.
    `int` | PortraitProcessor.`getMinimumIod()` Gets the minimum intra-occular distance, in pixels.
    `int` | FaceTracker.`getMinimumTrackedFaceAge()` Gets the minimum number of consecutive detections to reach before creating a tracked face.
    `int` | PortraitProcessor.`getMinimumVerticalPosition()` Gets the minimum distance from the bottom edge of the image to the imaginary line passing through the center of the eyes is between 50% - 70% of the total vertical length of the image.
    `FaceModel` | FaceEncoder.`getModel()` Gets the model used to create templates.
    `FaceModel` | FaceDetector.`getModel()` Gets the model used to detect and track faces.
    `static java.lang.String` | FaceLibrary.`getModelFileName(FaceModel model)` Retrieves the model file name which is needed in the LoadModel function.
    `static int` | FaceLicense.`getModuleCount()` Retrieves the number of modules in the license.
    `static java.lang.String` | FaceLicense.`getModuleName(int index)` Retrieves the name of the specified license module.
    `static int` | FaceLicense.`getModuleValue(java.lang.String name)` Retrieves the value associated to the specified license module.
    `int` | PortraitProcessor.`getMouthOcclusionThreshold()` Gets the mouth occlusion threshold.
    `int` | Portrait.`getMouthOpening()` Gets the value indicating estimating the opening of the mouth. -1 if not computed.
    `int` | PortraitProcessor.`getMouthOpenThreshold()` Gets the mouth opening threshold.
    `int` | Portrait.`getMouthVisibility()` Gets the value estimating the visibility of the mouth. -1 if not computed.
    `int` | PortraitProcessor.`getNaturalSkinColorThreshold()` Gets the natural skin color threshold.
    `int` | FaceTracker.`getNmsIouThreshold()` Gets the non-maximum suppression (NMS) intersection-over-union (IOU) threshold, in the range is [0;100].
    `int` | FaceDetector.`getNmsIouThreshold()` Gets the non-maximum suppression (NMS) intersection-over-union (IOU) threshold, in the range is [0;100].
    `int` | PortraitProcessor.`getNoFlashReflectionThreshold()` Gets the flash reflexion detection threshold.
    `int` | PortraitProcessor.`getNoiseThreshold()` Gets the threshold for confirming the presence of noise in the image.
    `int` | PortraitProcessor.`getNoseOcclusionThreshold()` Gets the nose occlusion threshold.
    `int` | Portrait.`getNoseVisibility()` Gets the value estimating the visibility of the nose. -1 if not computed.
    `int` | FaceAnalyser.`getOverExposureSensibility()` Gets the sensibility of the over-exposure classifier, from 0 to 255.
    `int` | PortraitProcessor.`getOverExposureThreshold()` Gets the over exposure threshold.
    `int` | Portrait.`getPadScore()` Gets the score of the presentation attack detection.
    `PadStatus` | Portrait.`getPadStatus()` Gets the status of the presentation attack detection.
    `int` | PortraitProcessor.`getPadThreshold()` Gets the presentation attack detection threshold, from 0 to 100.
    `PhotographicAttributes` | Portrait.`getPhotographicAttributes()` Gets the photographic attributes.
    `int` | PortraitProcessor.`getPixelationThreshold()` Gets the pixelation detection threshold.
    `int` | Image.`getPixelDepth()` Gets the pixel depth.
    `PixelFormat` | Image.`getPixelFormat()` Gets the pixel format.
    `Rectangle` | TrackedFace.`getPortraitBounds(float eyeImageWidthRatio, float eyeImageHeightRatio, float imageRatio)` Gets the bounding box of the detected face for ICAO portrait cropping.
    `Rectangle` | DetectedFace.`getPortraitBounds(float eyeImageWidthRatio, float eyeImageHeightRatio, float imageRatio)` Gets the bounding box of the detected face for ICAO portrait cropping.
    `FacePose` | Portrait.`getPose()` Gets the face pose.
    `Rectangle` | TrackedFace.`getPredictedBounds()` Gets the predicted bounds of the tracked face.
    `ProcessingUnit` | FaceEncoder.`getProcessingUnit()` Gets the processing unit where to run the encoding process.
    `ProcessingUnit` | FaceDetector.`getProcessingUnit()` Gets the processing unit where to run the detection process.
    `static java.lang.String` | FaceLicense.`getProductReference()` Retrieves the license product reference.
    `int` | FaceTemplate.`getQuality()` Gets the quality of the face template.
    `PortraitQualityCheckpoints` | Portrait.`getQualityCheckpoints()` Gets the quality check points of the portrait.
    `int` | Portrait.`getQualityScore()` Gets the unified quality score, from 0 to 100. -1 if not computed.
    `int` | PortraitProcessor.`getRedEyeThreshold()` Gets the threshold for confirming the presence of red eyes.
    `static int` | FaceLicense.`getRemainingDays()` Retrieves the number of remaining days.
    `int` | PortraitProcessor.`getResolutionThreshold()` Gets the threshold indicating whether the image resolution is sufficient.
    `int` | Portrait.`getRightEyeOpening()` Gets the value estimating the opening of the left eye. -1 if not computed.
    `int` | Portrait.`getRightEyeVisibility()` Gets the value estimating the visibility of the right eye. -1 if not computed.
    `int` | FaceCandidate.`getScore()` Gets the match score between the face probe template and the most similar one in the reference face template list used to perform the search.
    `int` | PortraitProcessor.`getSharpnessThreshold()` Gets the sharpness threshold.
    `int` | Portrait.`getSmile()` Gets the value indicating whether the subject is smiling. -1 if not computed.
    `int` | PortraitProcessor.`getSmileThreshold()` Gets the smile threshold.
    `PortraitStatus` | Portrait.`getStatus()` Gets the status of the portrait.
    `int` | Image.`getStride()` Gets the stride in bytes.
    `int` | Portrait.`getSubjectPosition()` Gets the position of the subject in the image.
    `FaceTemplate` | FaceIndexer.`getTemplate(java.lang.String id)` Retrieves a template from the face indexer by ID.
    `int` | FaceIndexer.`getTemplateCount()` Gets the current number of indexed templates.
    `int` | PortraitProcessor.`getThreadCount()` Gets the number of threads to be used for portrait processing.
    `int` | FaceTracker.`getThreadCount()` Gets the number of threads to be used for face detection and tracking.
    `int` | FaceEncoder.`getThreadCount()` Gets the number of threads to be used for template encoding.
    `int` | FaceDetector.`getThreadCount()` Gets the number of threads to be used for face detection.
    `int` | FaceAnalyser.`getThreadCount()` Gets the number of threads to be used for face analysis.
    `int` | PortraitProcessor.`getTintedGlassThreshold()` Gets the tinted glass detection threshold.
    `TrackedFace` | Portrait.`getTrackedFace()` Gets the tracked face.
    `int` | PortraitProcessor.`getTrackerMatchingThreshold()` Gets the minimum match score to reach to preserve the ID of a tracked face between frame 't-1' and frame 't'.
    `int` | PortraitProcessor.`getTrackerMaximumFaceAge()` Gets the maximum number of consecutive non-detections to be reached before deleting a tracked face.
    `int` | PortraitProcessor.`getTrackerMinimumFaceAge()` Gets the minimum number of consecutive detections to reach before creating a tracked face.
    `int` | PortraitProcessor.`getTrackerNmsIouThreshold()` Gets the non-maximum suppression (NMS) intersection-over-union (IOU) threshold, in the range [0;100].
    `TrackingStatus` | TrackedFace.`getTrackingStatus()` Gets the status of the tracked face.
    `int` | FaceAnalyser.`getUnderExposureSensibility()` Gets the sensibility of the under-exposure classifier, from 0 to 255.
    `int` | PortraitProcessor.`getUnderExposureThreshold()` Gets the under exposure threshold.
    `static java.lang.String` | FaceLibrary.`getVersion()` Retrieves the library version as a `X.Y.Z` formatted string.
    `static LibVersion` | FaceLibrary.`getVersionEx()` Retrieves the library version as a structure.
    `int` | Image.`getWidth()` Gets the width in pixels.
    `static void` | FaceLibrary.`loadModel(java.lang.String modelPath, FaceModel faceModel, ProcessingUnit processingUnit)` Loads a specified AI model into memory from the specified directory.
    `static void` | FaceLibrary.`loadModelBuffer(byte[] modelBuffer, FaceModel faceModel, ProcessingUnit processingUnit)` Loads a model into memory from the specified buffer.
    `void` | Image.`pad(int top, int left, int bottom, int right, int colorRed, int colorGreen, int colorBlue)` Add padding around the image Only works for BGR 24 bits, RGB 24 bits and Grayscale 8bits images.
    `static void` | FaceLicense.`reactivate(java.lang.String hardwareCode, java.lang.String productReference, java.lang.String path)` Reactivates a license file using the host hardware code and the product reference.
    `static byte[]` | FaceLicense.`reactivateBuffer(java.lang.String hardwareCode, java.lang.String productReference)` Reactivates a license in a data buffer using the host hardware code and the product reference.
    `void` | Image.`reallocate(int width, int height, PixelFormat pixelFormat)` Reallocates the internal memory of the Image from parameters.
    `void` | ImageDict.`remove(java.lang.String key)` Removes an element of the ImageDict object.
    `void` | FaceTemplateDict.`remove(java.lang.String key)` Removes an element of the FaceTemplateDict object.
    `void` | TrackedFaceList.`removeAt(int index)` Removes an element of the TrackedFaceList object.
    `void` | StringList.`removeAt(int index)` Removes an element of the StringList object.
    `void` | PointList.`removeAt(int index)` Removes an element of the PointList object.
    `void` | ImageList.`removeAt(int index)` Removes an element of the ImageList object.
    `void` | FaceTemplateList.`removeAt(int index)` Removes an element of the FaceTemplateList object.
    `void` | FaceCandidateList.`removeAt(int index)` Removes an element of the FaceCandidateList object.
    `void` | DetectedFaceList.`removeAt(int index)` Removes an element of the DetectedFaceList object.
    `void` | PortraitProcessor.`removeBackground(Image image, int red, int green, int blue)` Removes the background on the specified portrait image.
    `Image` | FaceAnalyser.`removeCompressionArtifacts(Image image)` Upscale and enhance the image of a face.
    `void` | TrackedFace.`rescale(float scale)` Rescales the detected face object bounding box and landmarks.
    `void` | DetectedFace.`rescale(float scale)` Rescales the detected face object bounding box and landmarks.
    `void` | TrackedFaceList.`rescaleAll(float scale)` Rescales all tracked faces in the list.
    `void` | DetectedFaceList.`rescaleAll(float scale)` Rescales all detected faces in the list.
    `void` | PortraitProcessor.`reset()` Resets the face tracker.
    `void` | TrackedFaceList.`resize(int newSize)` TrackedFaceList object.
    `void` | StringList.`resize(int newSize)` StringList object.
    `void` | PointList.`resize(int newSize)` PointList object.
    `void` | ImageList.`resize(int newSize)` ImageList object.
    `void` | FaceTemplateList.`resize(int newSize)` FaceTemplateList object.
    `void` | FaceIndexer.`resize(int maximumCount)` Resizes the maximum number of templates that the face indexer can hold.
    `void` | FaceCandidateList.`resize(int newSize)` FaceCandidateList object.
    `void` | DetectedFaceList.`resize(int newSize)` DetectedFaceList object.
    `void` | Image.`resize(int width, int height)` Resizes the image in-place to the required width and height.
    `void` | Image.`resizeTo(int width, int height, Image dstImage)` Resizes the image to the specified width and height.
    `void` | Image.`rotate(int angle)` Rotates the image in-place to the specified angle.
    `void` | TrackedFace.`rotate(int angle, Point center)` Rotates the face object by a given angle in degrees from a given center.
    `void` | DetectedFace.`rotate(int angle, Point center)` Rotates the face object by a given angle in degrees from a given center.
    `void` | Image.`rotateTo(int angle, Image dstImage)` Rotates the image to the specified angle.
    `void` | FaceMatcher.`searchTemplate(FaceTemplateDict referenceDict, FaceTemplate probe, int maxCandidates, FaceCandidateList candidateList)` Performs a one-to-many search of a biometric probe against a previously initialized dictionary of biometric references and outputs a candidate list.
    `FaceCandidateList` | FaceIndexer.`searchTemplate(FaceTemplate probe, int maxCandidates)` Performs a one-to-many search of a face template probe against a previously initialized face indexer and outputs a candidate list.
    `Image` | FaceAnalyser.`segmentBackground(Image image)` Computes face segmentation mask for background removal.
    `Image` | FaceAnalyser.`segmentFace(Image image)` Computes a segmentation map of a face.
    `void` | DetectedFaceList.`set(int index, DetectedFace detectedFaceItem)` Sets an item of the DetectedFaceList object.
    `void` | FaceCandidateList.`set(int index, FaceCandidate faceCandidateItem)` Sets an item of the FaceCandidateList object.
    `void` | FaceTemplateList.`set(int index, FaceTemplate faceTemplateItem)` Sets an item of the FaceTemplateList object.
    `void` | ImageList.`set(int index, Image imageItem)` Sets an item of the ImageList object.
    `void` | PointList.`set(int index, Point pointItem)` Sets an item of the PointList object.
    `void` | StringList.`set(int index, java.lang.String item)` Sets an item of the StringList object.
    `void` | TrackedFaceList.`set(int index, TrackedFace trackedFaceItem)` Sets an item of the TrackedFaceList object.
    `void` | FaceTemplateDict.`set(java.lang.String key, FaceTemplate faceTemplateItem)` Sets an item of the FaceTemplateDict object.
    `void` | ImageDict.`set(java.lang.String key, Image imageItem)` Sets an item of the ImageDict object.
    `void` | FacePad.`setAttackSupportDetectorConfidenceThreshold(int attackSupportDetectorConfidenceThreshold)` Sets the attack support detector confidence threshold, in the range [0;100].
    `void` | PortraitProcessor.`setBackgroundColorUniformityThreshold(int backgroundColorUniformityThreshold)` Sets the background color uniformity threshold.
    `void` | PortraitProcessor.`setBackgroundStructureUniformityThreshold(int backgroundStructureUniformityThreshold)` Sets the background structure uniformity threshold.
    `void` | TrackedFace.`setBounds(Rectangle bounds)` Sets the bounds of the detected face.
    `void` | DetectedFace.`setBounds(Rectangle bounds)` Sets the bounds of the detected face.
    `void` | FaceTracker.`setConfidenceThreshold(int confidenceThreshold)` Sets the confidence threshold, in the range [0;100].
    `void` | FaceDetector.`setConfidenceThreshold(int confidenceThreshold)` Sets the confidence threshold, in the range [0;100].
    `void` | PortraitProcessor.`setCropAspectRatio(float cropAspectRatio)` Sets the aspect ratio (height to width) of the cropped portrait image.
    `void` | PortraitProcessor.`setCropEyePositionRatio(float cropEyePositionRatio)` Sets the ratio between the vertical eye position and the image height for ICAO portrait cropping.
    `void` | PortraitProcessor.`setCropIodRatio(float cropIodRatio)` Sets the ratio between the interocular distance (IOD) and the image width for ICAO portrait cropping.
    `void` | PortraitProcessor.`setCropMargin(float cropMargin)` Sets the relative margin around the face for basic portrait cropping.
    `void` | FaceTracker.`setDetectionModel(FaceModel detectionModel)` Sets the model used to detect and track faces.
    `void` | PortraitProcessor.`setDynamicRangeThreshold(int dynamicRangeThreshold)` Sets the face dynamic range threshold.
    `void` | FaceTracker.`setEncodingModel(FaceModel encodingModel)` Sets the model used to create features and assess consistancy among views of a given face.
    `void` | PortraitProcessor.`setEqualBrightnessThreshold(int equalBrightnessThreshold)` Sets the equal brightness threshold.
    `void` | PortraitProcessor.`setExpressionSensibility(int expressionSensibility)` Sets the sensibility of the expression classifier.
    `void` | FaceAnalyser.`setExpressionSensibility(int expressionSensibility)` Sets the sensibility of the expression classifier.
    `void` | PortraitProcessor.`setEyeOcclusionThreshold(int eyeOcclusionThreshold)` Sets the visible eye threshold.
    `void` | PortraitProcessor.`setEyeOpeningThreshold(int eyeOpeningThreshold)` Sets the eye opening threshold.
    `void` | PortraitProcessor.`setFaceDetectionImageSize(int faceDetectionImageSize)` Sets the the size, in pixels, of the downscaled image used for face detection.
    `void` | PortraitProcessor.`setFaceDetectionModel(FaceModel faceDetectionModel)` Sets the specifies the model used to detect and track faces.
    `void` | PortraitProcessor.`setFaceDetectionThreshold(int faceDetectionThreshold)` Sets the specifies the face detection confidence threshold, in the range is [0;100].
    `void` | PortraitProcessor.`setFaceEncodingModel(FaceModel faceEncodingModel)` Sets the model used to create features and assess consistancy among views of a given face.
    `void` | PortraitProcessor.`setFaceMaskThreshold(int faceMaskThreshold)` Sets the face mask detection threshold.
    `void` | PortraitProcessor.`setGlassesThreshold(int glassesThreshold)` Sets the glasses detection threshold.
    `void` | PortraitProcessor.`setHatThreshold(int hatThreshold)` Sets the threshold for confirming that the person is wearing a hat.
    `void` | TrackedFace.`setId(int id)` Sets the ID of the detected face.
    `void` | DetectedFace.`setId(int id)` Sets the ID of the detected face.
    `void` | TrackedFace.`setLandmarks(PointList landmarks)` Sets the landmarks (eyes, nose and mouth corners) of the detected face.
    `void` | DetectedFace.`setLandmarks(PointList landmarks)` Sets the landmarks (eyes, nose and mouth corners) of the detected face.
    `void` | PortraitProcessor.`setMakeupThreshold(int makeupThreshold)` Sets the make-up detection threshold.
    `void` | PortraitProcessor.`setMaleThreshold(int maleThreshold)` Sets the male gender detection threshold.
    `void` | FaceTracker.`setMatchThreshold(int matchThreshold)` Sets the minimum match score to reach to preserve the ID of a tracked face between frame 't-1' and frame 't'.
    `void` | PortraitProcessor.`setMaximumEyeGazeX(int maximumEyeGazeX)` Sets the maximum value of the eye gaze alongside the X axis.
    `void` | PortraitProcessor.`setMaximumEyeGazeY(int maximumEyeGazeY)` Sets the maximum value of the eye gaze alongside the Y axis.
    `void` | PortraitProcessor.`setMaximumHeadHeightRatio(int maximumHeadHeightRatio)` Sets the maximum distance between the base of the chin and the crown is less than 80% of the total height of the image.
    `void` | PortraitProcessor.`setMaximumHeadWidthRatio(int maximumHeadWidthRatio)` Sets the value indicating if the image width is conform to the (image width / head width) ratio of 7:5.
    `void` | PortraitProcessor.`setMaximumHorizontalPosition(int maximumHorizontalPosition)` Sets the value indicating if the head is correctly centered horizontally.
    `void` | PortraitProcessor.`setMaximumIod(int maximumIod)` Sets the maximum interocular distance (IOD), in pixels.
    `void` | PortraitProcessor.`setMaximumPitchAngle(float maximumPitchAngle)` Sets the maximum head pitch angle, in degrees, for frontal positioning.
    `void` | PortraitProcessor.`setMaximumRollAngle(float maximumRollAngle)` Sets the maximum head roll angle, in degrees, for frontal positioning.
    `void` | FaceTracker.`setMaximumTrackedFaceAge(int maximumTrackedFaceAge)` Sets the maximum number of consecutive non-detections to reach before deleting a tracked face.
    `void` | PortraitProcessor.`setMaximumVerticalPosition(int maximumVerticalPosition)` Sets the maximum distance from the bottom edge of the image to the imaginary line passing through the center of the eyes is between 50% - 70% of the total vertical length of the image.
    `void` | PortraitProcessor.`setMaximumYawAngle(float maximumYawAngle)` Sets the maximum head yaw angle, in degrees, for frontal positioning.
    `void` | FaceEncoder.`setMinimalIod(int minimalIod)` Sets the minimal interocular distance (IOD) in pixels required to perform a face encoding.
    `void` | PortraitProcessor.`setMinimumHeadHeightRatio(int minimumHeadHeightRatio)` Sets the minimum distance between the base of the chin and the crown is less than 80% of the total height of the image.
    `void` | PortraitProcessor.`setMinimumHeadWidthRatio(int minimumHeadWidthRatio)` Sets the value indicating if the image width is conform to the (image width / head width) ratio of 7:5.
    `void` | PortraitProcessor.`setMinimumHorizontalPosition(int minimumHorizontalPosition)` Sets the value indicating if the head is correctly centered horizontally.
    `void` | PortraitProcessor.`setMinimumIod(int minimumIod)` Sets the minimum intra-occular distance, in pixels.
    `void` | FaceTracker.`setMinimumTrackedFaceAge(int minimumTrackedFaceAge)` Sets the minimum number of consecutive detections to reach before creating a tracked face.
    `void` | PortraitProcessor.`setMinimumVerticalPosition(int minimumVerticalPosition)` Sets the minimum distance from the bottom edge of the image to the imaginary line passing through the center of the eyes is between 50% - 70% of the total vertical length of the image.
    `void` | FaceEncoder.`setModel(FaceModel model)` Sets the model used to create templates.
    `void` | FaceDetector.`setModel(FaceModel model)` Sets the model used to detect and track faces.
    `void` | PortraitProcessor.`setMouthOcclusionThreshold(int mouthOcclusionThreshold)` Sets the mouth occlusion threshold.
    `void` | PortraitProcessor.`setMouthOpenThreshold(int mouthOpenThreshold)` Sets the mouth opening threshold.
    `void` | PortraitProcessor.`setNaturalSkinColorThreshold(int naturalSkinColorThreshold)` Sets the natural skin color threshold.
    `void` | FaceTracker.`setNmsIouThreshold(int nmsIouThreshold)` Sets the non-maximum suppression (NMS) intersection-over-union (IOU) threshold, in the range is [0;100].
    `void` | FaceDetector.`setNmsIouThreshold(int nmsIouThreshold)` Sets the non-maximum suppression (NMS) intersection-over-union (IOU) threshold, in the range is [0;100].
    `void` | PortraitProcessor.`setNoFlashReflectionThreshold(int noFlashReflectionThreshold)` Sets the flash reflexion detection threshold.
    `void` | PortraitProcessor.`setNoiseThreshold(int noiseThreshold)` Sets the threshold for confirming the presence of noise in the image.
    `void` | PortraitProcessor.`setNoseOcclusionThreshold(int noseOcclusionThreshold)` Sets the nose occlusion threshold.
    `void` | FaceAnalyser.`setOverExposureSensibility(int overExposureSensibility)` Sets the sensibility of the over-exposure classifier, from 0 to 255.
    `void` | PortraitProcessor.`setOverExposureThreshold(int overExposureThreshold)` Sets the over exposure threshold.
    `void` | PortraitProcessor.`setPadThreshold(int padThreshold)` Sets the presentation attack detection threshold, from 0 to 100.
    `void` | PortraitProcessor.`setPixelationThreshold(int pixelationThreshold)` Sets the pixelation detection threshold.
    `void` | FaceEncoder.`setProcessingUnit(ProcessingUnit processingUnit)` Sets the processing unit where to run the encoding process.
    `void` | FaceDetector.`setProcessingUnit(ProcessingUnit processingUnit)` Sets the processing unit where to run the detection process.
    `void` | PortraitProcessor.`setRedEyeThreshold(int redEyeThreshold)` Sets the threshold for confirming the presence of red eyes.
    `void` | PortraitProcessor.`setResolutionThreshold(int resolutionThreshold)` Sets the threshold indicating whether the image resolution is sufficient.
    `void` | PortraitProcessor.`setSharpnessThreshold(int sharpnessThreshold)` Sets the sharpness threshold.
    `void` | PortraitProcessor.`setSmileThreshold(int smileThreshold)` Sets the smile threshold.
    `void` | PortraitProcessor.`setThreadCount(int threadCount)` Sets the number of threads to be used for portrait processing.
    `void` | FaceTracker.`setThreadCount(int threadCount)` Sets the number of threads to be used for face detection and tracking.
    `void` | FaceEncoder.`setThreadCount(int threadCount)` Sets the number of threads to be used for template encoding.
    `void` | FaceDetector.`setThreadCount(int threadCount)` Sets the number of threads to be used for face detection.
    `void` | FaceAnalyser.`setThreadCount(int threadCount)` Sets the number of threads to be used for face analysis.
    `void` | PortraitProcessor.`setTintedGlassThreshold(int tintedGlassThreshold)` Sets the tinted glass detection threshold.
    `void` | PortraitProcessor.`setTrackerMatchingThreshold(int trackerMatchingThreshold)` Sets the minimum match score to reach to preserve the ID of a tracked face between frame 't-1' and frame 't'.
    `void` | PortraitProcessor.`setTrackerMaximumFaceAge(int trackerMaximumFaceAge)` Sets the maximum number of consecutive non-detections to be reached before deleting a tracked face.
    `void` | PortraitProcessor.`setTrackerMinimumFaceAge(int trackerMinimumFaceAge)` Sets the minimum number of consecutive detections to reach before creating a tracked face.
    `void` | PortraitProcessor.`setTrackerNmsIouThreshold(int trackerNmsIouThreshold)` Sets the non-maximum suppression (NMS) intersection-over-union (IOU) threshold, in the range [0;100].
    `void` | FaceAnalyser.`setUnderExposureSensibility(int underExposureSensibility)` Sets the sensibility of the under-exposure classifier, from 0 to 255.
    `void` | PortraitProcessor.`setUnderExposureThreshold(int underExposureThreshold)` Sets the under exposure threshold.
    `byte[]` | FaceTemplate.`toBdt()` Exports the face template object to a Biometric Data Template (BDT) buffer.
    `byte[]` | FaceTemplate.`toBit(int threshold, int referenceDataQualifier)` Exports the face template as a Biometric Information Template (BIT) for enrolment on a smart card equipped with id3 Match-on-Card technology.
    `byte[]` | TrackedFace.`toBuffer()` Exports the face object to a buffer.
    `byte[]` | Portrait.`toBuffer()` Exports the portrait to a buffer.
    `byte[]` | FaceTemplate.`toBuffer()` Exports the face template object to a buffer.
    `byte[]` | DetectedFace.`toBuffer()` Exports the face object to a buffer.
    `byte[]` | Image.`toBuffer(ImageFormat imageFormat, float compressionLevel)` Exports the image to a buffer.
    `void` | Image.`toBufferObject(ImageFormat imageFormat, float compressionLevel, ImageBuffer buffer)` Copies the image to a buffer in the specified format.
    `void` | TrackedFace.`toFile(java.lang.String path)` Saves the face object to a file.
    `void` | FaceTemplate.`toFile(java.lang.String path)` Exports the face template object to a file.
    `void` | FaceIndexer.`toFile(java.lang.String path)` Saves the face indexer object to a file.
    `void` | DetectedFace.`toFile(java.lang.String path)` Saves the face object to a file.
    `void` | Image.`toFile(java.lang.String filepath, float compressionLevel)` Saves the image to the specified file.
    `void` | Image.`toRawBuffer(PixelFormat pixelFormat, ImageBuffer buffer)` Copies image pixels in the specified format into a buffer.
    `void` | FaceDetector.`trackFaces(Image image, DetectedFaceList detectedFaceList)` Tracks faces in an image and update their info in a DetectedFaceList object.
    `void` | FaceTracker.`trackFaces(Image image, TrackedFaceList trackedFaceList)` Tracks faces in an image and update their info in a TrackedFaceList object.
    `void` | TrackedFace.`translate(int tx, int ty)` Translates the face object.
    `void` | DetectedFace.`translate(int tx, int ty)` Translates the face object.
    `void` | Image.`transpose()` Transposes the image object.
    `static void` | FaceLibrary.`unloadModel(FaceModel faceModel, ProcessingUnit processingUnit)` Unloads a model from memory.
    `void` | FaceTemplate.`update(FaceTemplate newFaceTemplate)` Updates the face template by combining it with the specified face template.
    `void` | PortraitProcessor.`updatePortrait(Portrait portrait, Image image)` Analyses an image and updates the specified portrait with the first detected face or the currently tracked face.
    `void` | FaceEncoder.`warmUp()` Gets the face encoder module ready to work by initializing all its internal memory layout.
    `void` | FaceTracker.`warmUp(int imageWidth, int imageHeight)` Gets the face tracker module ready to work on a specific image size by initializing all its internal memory layout.
    `void` | FaceDetector.`warmUp(int imageWidth, int imageHeight)` Gets the face detector module ready to work on a specific image size by initializing all its internal memory layout.

    Constructors in eu.id3.face that throw FaceException
    Constructor and Description
    `DetectedFace()` Creates a new instance of the DetectedFace class.
    `DetectedFace(long handle)` Creates a new instance of the DetectedFace class.
    `DetectedFaceList()` Creates a new instance of the DetectedFaceList class.
    `DetectedFaceList(long handle)` Creates a new instance of the DetectedFaceList class.
    `FaceAnalyser()` Creates a new instance of the FaceAnalyser class.
    `FaceAnalyser(long handle)` Creates a new instance of the FaceAnalyser class.
    `FaceCandidate()` Creates a new instance of the FaceCandidate class.
    `FaceCandidate(long handle)` Creates a new instance of the FaceCandidate class.
    `FaceCandidateList()` Creates a new instance of the FaceCandidateList class.
    `FaceCandidateList(long handle)` Creates a new instance of the FaceCandidateList class.
    `FaceDetector()` Creates a new instance of the FaceDetector class.
    `FaceDetector(long handle)` Creates a new instance of the FaceDetector class.
    `FaceEncoder()` Creates a new instance of the FaceEncoder class.
    `FaceEncoder(long handle)` Creates a new instance of the FaceEncoder class.
    `FaceIndexer()` Creates a new instance of the FaceIndexer class.
    `FaceIndexer(long handle)` Creates a new instance of the FaceIndexer class.
    `FaceMatcher()` Creates a new instance of the FaceMatcher class.
    `FaceMatcher(long handle)` Creates a new instance of the FaceMatcher class.
    `FacePad()` Creates a new instance of the FacePad class.
    `FacePad(long handle)` Creates a new instance of the FacePad class.
    `FaceTemplate()` Creates a new instance of the FaceTemplate class.
    `FaceTemplate(long handle)` Creates a new instance of the FaceTemplate class.
    `FaceTemplateDict()` Creates a new instance of the FaceTemplateDict class.
    `FaceTemplateDict(long handle)` Creates a new instance of the FaceTemplateDict class.
    `FaceTemplateList()` Creates a new instance of the FaceTemplateList class.
    `FaceTemplateList(long handle)` Creates a new instance of the FaceTemplateList class.
    `FaceTracker()` Creates a new instance of the FaceTracker class.
    `FaceTracker(long handle)` Creates a new instance of the FaceTracker class.
    `Image()` Creates a new instance of the Image class.
    `Image(long handle)` Creates a new instance of the Image class.
    `ImageBuffer()` Creates a new instance of the ImageBuffer class.
    `ImageBuffer(long handle)` Creates a new instance of the ImageBuffer class.
    `ImageDict()` Creates a new instance of the ImageDict class.
    `ImageDict(long handle)` Creates a new instance of the ImageDict class.
    `ImageList()` Creates a new instance of the ImageList class.
    `ImageList(long handle)` Creates a new instance of the ImageList class.
    `PointList()` Creates a new instance of the PointList class.
    `PointList(long handle)` Creates a new instance of the PointList class.
    `Portrait()` Creates a new instance of the Portrait class.
    `Portrait(long handle)` Creates a new instance of the Portrait class.
    `PortraitProcessor()` Creates a new instance of the PortraitProcessor class.
    `PortraitProcessor(long handle)` Creates a new instance of the PortraitProcessor class.
    `StringList()` Creates a new instance of the StringList class.
    `StringList(long handle)` Creates a new instance of the StringList class.
    `TrackedFace()` Creates a new instance of the TrackedFace class.
    `TrackedFace(long handle)` Creates a new instance of the TrackedFace class.
    `TrackedFaceList()` Creates a new instance of the TrackedFaceList class.
    `TrackedFaceList(long handle)` Creates a new instance of the TrackedFaceList class.

Copyright © id3 Technologies. All rights reserved. eu.id3.face