Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Face SDK 9.16.0
Light Logo Dark Logo
Face SDK 9.16.0
  • Introduction
  • Requirements
  • Quick start
  • Naming conventions
  • Licensing
  • Distribution
  • Troubleshooting

Usage

  • Error Handling
  • License handling
  • Image handling
  • AI Models
  • Face analysis
  • Face background removal
  • Face comparison
  • Face comparison on card
  • Face detection
  • Face encoding
  • Face tracking
  • Face search
  • Presentation attack detection
  • Portrait processing

Reference

  • Face API
    • BackgroundUniformity
      • colorUniformity
      • structureUniformity
    • ColorBasedPadResult
      • confidence
      • score
    • DetectedFace
      • bounds
      • clone
      • create
      • detectionScore
      • fromBuffer
      • fromFile
      • getDistanceToCamera
      • getExpandedBounds
      • getInterocularDistance
      • getPortraitBounds
      • id
      • landmarks
      • rescale
      • rotate
      • toBuffer
      • toFile
      • translate
    • DetectedFaceAttackSupport
      • attackSupport
      • score
    • DetectedFaceList
      • add
      • clear
      • clone
      • count
      • findDetectedFace
      • get
      • getCount
      • getIdList
      • getLargestFace
      • removeAt
      • rescaleAll
      • resize
      • set
    • EyeGaze
      • leftEyeXGaze
      • leftEyeYGaze
      • rightEyeXGaze
      • rightEyeYGaze
    • FaceAnalyser
      • applyAlphaMask
      • applyMask
      • checkColorizedImage
      • computeAge
      • computeAttributes
      • computeBackgroundUniformity
      • computeExpression
      • computeEyeGaze
      • computeEyeOpenness
      • computeEyeRedness
      • computeGeometricAttributes
      • computeGlassesAttributes
      • computeLandmarks
      • computeNoise
      • computePhotographicAttributes
      • computePose
      • computePoseWithLandmarks
      • detectFaceMask
      • detectOcclusions
      • expressionSensibility
      • overExposureSensibility
      • removeCompressionArtifacts
      • segmentBackground
      • segmentFace
      • threadCount
      • underExposureSensibility
    • FaceAttackSupport
    • FaceAttributes
      • glasses
      • hat
      • makeUp
      • male
      • mouthOpen
      • smile
    • FaceCandidate
      • clone
      • id
      • score
    • FaceCandidateList
      • add
      • clear
      • clone
      • count
      • get
      • getCount
      • removeAt
      • resize
      • set
    • FaceDetector
      • confidenceThreshold
      • detectFaces
      • model
      • nmsIouThreshold
      • processingUnit
      • threadCount
      • trackFaces
      • warmUp
    • FaceEncoder
      • computeQuality
      • createTemplate
      • minimalIod
      • model
      • processingUnit
      • threadCount
      • warmUp
    • FaceError
    • FaceException
    • FaceExpression
    • FaceIndexer
      • addTemplate
      • create
      • deleteTemplate
      • format
      • fromFile
      • getTemplate
      • maximumTemplateCount
      • resize
      • searchTemplate
      • templateCount
      • toFile
    • FaceLibrary
      • getModelFileName
      • getVersion
      • getVersionEx
      • loadModel
      • loadModelBuffer
      • unloadModel
    • FaceLicense
      • activate
      • activateActivationKey
      • activateActivationKeyBuffer
      • activateBuffer
      • activateSerialKey
      • activateSerialKeyBuffer
      • checkLicense
      • checkLicenseBuffer
      • checkLicenseBufferWithCard
      • checkLicenseWithCard
      • checkModule
      • encrypt
      • finalizeCheckLicenseWithCard
      • getApplicationHardwareCode
      • getExpiryDate
      • getExternalDriveHardwareCode
      • getHostHardwareCode
      • getLicenseComment
      • getLicenseFileHardwareCode
      • getLicenseFileSerial
      • getLicenseName
      • getLicenseOwner
      • getLicensePath
      • getLicenseType
      • getModuleCount
      • getModuleName
      • getModuleValue
      • getProductReference
      • getRemainingDays
      • reactivate
      • reactivateBuffer
    • FaceMatcher
      • compareTemplateLists
      • compareTemplates
      • searchTemplate
    • FaceMatcherThreshold
    • FaceModel
    • FaceOcclusionScores
      • leftEyeOcclusionScore
      • mouthOcclusionScore
      • noseOcclusionScore
      • rightEyeOcclusionScore
    • FacePad
      • attackSupportDetectorConfidenceThreshold
      • computeBlurrinessScore
      • computeColorBasedScore
      • computeDepthBasedScore
      • detectAttackSupport
    • FacePose
      • pitch
      • roll
      • yaw
    • FaceSegmentationLabel
    • FaceTemplate
      • clone
      • format
      • fromBuffer
      • fromFile
      • quality
      • toBdt
      • toBit
      • toBuffer
      • toFile
      • update
    • FaceTemplateDict
      • add
      • clear
      • clone
      • containsKey
      • count
      • get
      • getCount
      • keys
      • remove
      • set
    • FaceTemplateFormat
    • FaceTemplateList
      • add
      • clear
      • clone
      • count
      • get
      • getCount
      • removeAt
      • resize
      • set
    • FaceTracker
      • confidenceThreshold
      • detectFaces
      • detectionModel
      • encodingModel
      • matchThreshold
      • maximumTrackedFaceAge
      • minimumTrackedFaceAge
      • nmsIouThreshold
      • threadCount
      • trackFaces
      • warmUp
    • GeometricAttributes
      • headImageHeightRatio
      • headImageWidthRatio
      • horizontalPosition
      • resolution
      • verticalPosition
    • GlassesAttributes
      • frameOnEye
      • heavyFrame
      • tintedGlasses
    • Image
      • clone
      • compare
      • correctGamma
      • crop
      • data
      • downscale
      • downscaleTo
      • extractRoi
      • extractRoiWithColor
      • flip
      • flipTo
      • fromBuffer
      • fromFile
      • fromNumpy
      • fromRawBuffer
      • fromYuvPlanes
      • getPixels
      • height
      • pad
      • pixelDepth
      • pixelFormat
      • reallocate
      • resize
      • resizeTo
      • rotate
      • rotateTo
      • set
      • stride
      • toBuffer
      • toBufferObject
      • toFile
      • toNumpy
      • toRawBuffer
      • transpose
      • width
    • ImageBuffer
      • clone
      • getData
      • getPixels
    • ImageDict
      • add
      • clear
      • clone
      • containsKey
      • count
      • get
      • getCount
      • keys
      • remove
      • set
    • ImageError
    • ImageFormat
    • ImageList
      • add
      • clear
      • clone
      • count
      • get
      • getCount
      • removeAt
      • resize
      • set
    • LibVersion
      • build
      • major
      • minor
    • LicenseError
    • LicenseHardwareCodeType
    • LicenseType
    • PadStatus
    • PhotographicAttributes
      • equalBrightness
      • faceDynamicRange
      • flashReflection
      • naturalSkinColor
      • overExposure
      • pixelation
      • sharpness
      • underExposure
    • PixelFormat
    • Point
      • x
      • y
    • PointList
      • add
      • clear
      • clone
      • count
      • get
      • getCount
      • removeAt
      • resize
      • set
    • PoolingMethod
    • Portrait
      • age
      • backgroundUniformity
      • clear
      • clone
      • expression
      • eyeGaze
      • faceId
      • faceMask
      • faceTemplate
      • fromBuffer
      • genderMale
      • geometricAttributes
      • glasses
      • hat
      • image
      • imageCenter
      • imageScale
      • imageTranslation
      • instruction
      • landmarks
      • leftEyeOpening
      • leftEyeVisibility
      • lookStraightScore
      • makeup
      • mouthOpening
      • mouthVisibility
      • noseVisibility
      • padScore
      • padStatus
      • photographicAttributes
      • pose
      • qualityCheckpoints
      • qualityScore
      • rightEyeOpening
      • rightEyeVisibility
      • smile
      • status
      • subjectPosition
      • toBuffer
      • trackedFace
    • PortraitInstruction
    • PortraitProcessor
      • backgroundColorUniformityThreshold
      • backgroundStructureUniformityThreshold
      • createPortrait
      • cropAspectRatio
      • cropEyePositionRatio
      • cropIcaoPortrait
      • cropIodRatio
      • cropMargin
      • cropPortrait
      • detectOcclusions
      • detectPresentationAttack
      • dynamicRangeThreshold
      • equalBrightnessThreshold
      • estimateAge
      • estimateBackgroundUniformity
      • estimateExpression
      • estimateFaceAttributes
      • estimateGeometryQuality
      • estimatePhotographicQuality
      • expressionSensibility
      • eyeOcclusionThreshold
      • eyeOpeningThreshold
      • faceDetectionImageSize
      • faceDetectionModel
      • faceDetectionThreshold
      • faceEncodingModel
      • faceMaskThreshold
      • glassesThreshold
      • hatThreshold
      • makeupThreshold
      • maleThreshold
      • maximumEyeGazeX
      • maximumEyeGazeY
      • maximumHeadHeightRatio
      • maximumHeadWidthRatio
      • maximumHorizontalPosition
      • maximumIod
      • maximumPitchAngle
      • maximumRollAngle
      • maximumVerticalPosition
      • maximumYawAngle
      • minimumHeadHeightRatio
      • minimumHeadWidthRatio
      • minimumHorizontalPosition
      • minimumIod
      • minimumVerticalPosition
      • mouthOcclusionThreshold
      • mouthOpenThreshold
      • naturalSkinColorThreshold
      • noFlashReflectionThreshold
      • noiseThreshold
      • noseOcclusionThreshold
      • overExposureThreshold
      • padThreshold
      • pixelationThreshold
      • redEyeThreshold
      • removeBackground
      • reset
      • resolutionThreshold
      • sharpnessThreshold
      • smileThreshold
      • threadCount
      • tintedGlassThreshold
      • trackerMatchingThreshold
      • trackerMaximumFaceAge
      • trackerMinimumFaceAge
      • trackerNmsIouThreshold
      • underExposureThreshold
      • updatePortrait
    • PortraitQualityCheckpoints
      • backgroundUniform
      • brightnessBalanced
      • dynamicRange
      • expressionNeutral
      • eyesOpen
      • headHeightCorrect
      • headHorizontalPositionCorrect
      • headVerticalPositionCorrect
      • headWidthCorrect
      • imageColoured
      • imageResolutionCorrect
      • imageSharp
      • leftEyeVisible
      • lookStraight
      • mouthClosed
      • mouthVisible
      • noFlashReflection
      • noGlasses
      • noHat
      • noNoise
      • noOverExposure
      • noPixelation
      • noRedEye
      • noSmile
      • noUnderExposure
      • noseVisible
      • poseFrontal
      • rightEyeVisible
      • skinColorNatural
    • PortraitStatus
    • ProcessingUnit
    • Rectangle
      • bottomLeft
      • bottomRight
      • clipInsideImage
      • clone
      • extend
      • fromPoints
      • fromXywh
      • fromXyxy
      • getEnglobingRectangle
      • getHeight
      • getWidth
      • getX
      • getY
      • isAligned
      • resize
      • topLeft
      • topRight
    • StringList
      • add
      • clear
      • count
      • get
      • getCount
      • removeAt
      • resize
      • set
    • SubjectPosition
    • TrackedFace
      • bounds
      • clone
      • create
      • detectionScore
      • faceTemplate
      • fromBuffer
      • fromFile
      • getAsDetectedFace
      • getDistanceToCamera
      • getExpandedBounds
      • getInterocularDistance
      • getPortraitBounds
      • id
      • landmarks
      • predictedBounds
      • rescale
      • rotate
      • toBuffer
      • toFile
      • trackingStatus
      • translate
    • TrackedFaceList
      • add
      • clear
      • clone
      • count
      • findTrackedFace
      • get
      • getCount
      • getIdList
      • getLargestFace
      • removeAt
      • rescaleAll
      • resize
      • set
    • TrackingStatus

ABOUT

  • Release notes
  • License agreement
  • Third-Party Libraries
  • Terms and Definitions
  • Frequently Asked Questions
Back to top

Portrait.instruction Property¶

Module: Portrait

Type: PortraitInstruction

Definition¶

Instruction to be given to the user for portrait capture.

Next
Portrait.landmarks Property
Previous
Portrait.imageTranslation Property
Copyright © 2025, id3 Technologies
Made with Furo
On this page
  • Portrait.instruction Property
    • Definition