Skip to content

Document SDK 2.2.2

Document SDK 2.2.2

Introduction
Requirements
Quick start
Licensing
Distribution

Usage

Overview
Error handling
License handling
AI Models
Document database
Document detection
Document reading
MRZ reading
Document authenticity check

Reference

Document API
- DetectedDocument
  - bounds
  - clone
  - confidence
  - info
  - orientation
- DocumentAuthenticator
- DocumentCategory
- DocumentDetector
- DocumentError
- DocumentException
- DocumentFormat
- DocumentImage
  - cannyEdgeDetection
  - cannyEdgeDetectionTo
  - changeAspectRatio
  - changeAspectRatioWithColor
  - clone
  - compare
  - convertToGrayscale
  - convertToGrayscaleTo
  - correctGamma
  - crop
  - cropCenter
  - data
  - dilate
  - dilateTo
  - downscale
  - downscaleTo
  - equalizeHistogram
  - equalizeHistogramTo
  - erode
  - erodeTo
  - extractRoi
  - extractRoiWithColor
  - flip
  - flipTo
  - fromBuffer
  - fromFile
  - fromNumpy
  - fromRawBuffer
  - fromYuvPlanes
  - gaussianBlur
  - gaussianBlurTo
  - getPixels
  - height
  - medianBlur
  - medianBlurTo
  - normalize
  - normalizeQuantile
  - normalizeQuantileTo
  - normalizeTo
  - pad
  - padCenter
  - padCenterWithColor
  - pixelDepth
  - pixelFormat
  - reallocate
  - resize
  - resizeTo
  - rotate
  - rotateTo
  - set
  - sizeInBytes
  - stride
  - toBuffer
  - toBufferObject
  - toFile
  - toNumpy
  - toRawBuffer
  - transpose
  - width
- DocumentInfo
  - category
  - clone
  - country
  - date
  - description
  - format
  - identifier
  - mrzType
  - name
  - pageNumber
- DocumentInfoDictionary
  - add
  - clear
  - clone
  - containsKey
  - count
  - get
  - getCount
  - keys
  - remove
  - set
- DocumentLibrary
- DocumentLicense
- DocumentModel
- DocumentOrientation
  - pitch
  - roll
  - yaw
- DocumentReader
- HologramAuthenticationResult
- HologramAuthenticationResultList
  - add
  - clear
  - clone
  - count
  - get
  - getCount
  - removeAt
  - resize
  - set
- ImageBuffer
  - clone
  - getData
  - getPixels
  - sizeInBytes
- ImageError
- ImageFormat
- LibVersion
  - build
  - major
  - minor
- LicenseCycle
- LicenseError
- LicenseHardwareCodeType
- LicenseType
- MrzHelper
  - check
  - decode
- MrzReader
- MrzReadingResult
  - bounds
  - clone
  - confidence
  - mrz
  - mrzType
- MrzType
- PixelFormat
- Point
  - x
  - y
- PointList
  - add
  - clear
  - clone
  - count
  - get
  - getCount
  - removeAt
  - resize
  - set
- ProcessingUnit
- Rectangle
  - bottomLeft
  - bottomRight
  - clipInsideImage
  - clone
  - extend
  - fromPoints
  - fromXywh
  - fromXyxy
  - getEnglobingRectangle
  - getHeight
  - getWidth
  - getX
  - getY
  - isAligned
  - resize
  - topLeft
  - topRight
- StringDict
  - add
  - clear
  - clone
  - containsKey
  - count
  - get
  - getCount
  - keys
  - remove
  - set
- StringList
  - add
  - clear
  - clone
  - count
  - get
  - getCount
  - removeAt
  - resize
  - set
- TextField
  - bounds
  - clone
  - confidence
  - name
  - value
- TextFieldList
  - add
  - clear
  - clone
  - count
  - get
  - getCount
  - removeAt
  - resize
  - set

ABOUT

Release notes
License agreement
Third-Party Libraries
Frequently Asked Questions
Troubleshooting

DocumentImage.pixelFormat Property¶

Module: DocumentImage

Type: PixelFormat

Definition¶

Pixel format.

DocumentImage.reallocate Method

DocumentImage.pixelDepth Property

Copyright © 2026, id3 Technologies

Made with Furo

On this page

DocumentImage.pixelFormat Property
- Definition