## Uses of Class
eu.id3.document.DocumentImage

- - ### Uses of DocumentImage in eu.id3.document

    Methods in eu.id3.document that return DocumentImage
    Modifier and Type | Method and Description
    --- | ---
    `DocumentImage` | DocumentDetector.`alignDocument(DocumentImage sourceImage, DetectedDocument detectedDocument)` Aligns and crops the specified document on the specified image and returns a new DocumentImage.
    `DocumentImage` | DocumentImage.`clone()` Creates a copy of the DocumentImage object.
    `DocumentImage` | DocumentImage.`crop(int left, int top, int width, int height)` Crop a rectangular region of interest in the image according to the given bounds.
    `DocumentImage` | DocumentReader.`extractFace(DocumentImage image, java.lang.String documentName)` Extracts a crop of the face in a document.
    `DocumentImage` | DocumentImage.`extractRoi(Rectangle bounds)` Extracts a region of interest in the image according to the given bounds.
    `DocumentImage` | DocumentImage.`extractRoiWithColor(Rectangle bounds, int colorRed, int colorGreen, int colorBlue)` Extracts a region of interest in the image according to the given bounds.
    `static DocumentImage` | DocumentImage.`fromBuffer(byte[] data, PixelFormat pixelFormat)` Creates an Image from the specified data buffer.
    `static DocumentImage` | DocumentImage.`fromFile(java.lang.String filepath, PixelFormat pixelFormat)` Creates an Image from the specified file.
    `static DocumentImage` | DocumentImage.`fromRawBuffer(byte[] pixels, int width, int height, int stride, PixelFormat srcPixelFormat, PixelFormat dstPixelFormat)` Creates an Image from the specified raw data buffer.
    `static DocumentImage` | DocumentImage.`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.

    Methods in eu.id3.document with parameters of type DocumentImage
    Modifier and Type | Method and Description
    --- | ---
    `DocumentImage` | DocumentDetector.`alignDocument(DocumentImage sourceImage, DetectedDocument detectedDocument)` Aligns and crops the specified document on the specified image and returns a new DocumentImage.
    `void` | DocumentAuthenticator.`appendFrame(DocumentImage image)` Appends a frame in the FIFO buffer.
    `float` | DocumentImage.`compare(DocumentImage cmpDocumentImage)` Computes the difference with another image.
    `DetectedDocument` | DocumentDetector.`detectDocument(DocumentImage image, Rectangle detectionZone)` Detects a document on a delimited area of the specified DocumentImage and returns a DetectedDocument.
    `DetectedDocument` | DocumentDetector.`detectDocumentByName(DocumentImage image, java.lang.String documentName, Rectangle detectionZone)` Detects a document with specified name on a delimited area of the specified DocumentImage and returns a DetectedDocument.
    `float` | DocumentImage.`downscaleTo(DocumentImage dstDocumentImage, int maxSize)` Downscales the image so that its maximum dimension equals the given maximum size, while preserving the aspect ratio.
    `DocumentImage` | DocumentReader.`extractFace(DocumentImage image, java.lang.String documentName)` Extracts a crop of the face in a document.
    `void` | DocumentImage.`flipTo(boolean flipHorizontally, boolean flipVertically, DocumentImage dstDocumentImage)` Flips the image.
    `TextFieldList` | DocumentReader.`readDocument(DocumentImage image, java.lang.String documentName)` Reads all the fields in a document.
    `TextField` | DocumentReader.`readField(DocumentImage image, java.lang.String documentName, java.lang.String fieldName)` Reads a single field in a document.
    `MrzReadingResult` | MrzReader.`readMrz(DocumentImage image)` Detects and reads an MRZ in an image.
    `void` | DocumentImage.`resizeTo(int width, int height, DocumentImage dstDocumentImage)` Resizes the image to the specified width and height.
    `void` | DocumentImage.`rotateTo(int angle, DocumentImage dstDocumentImage)` Rotates the image to the specified angle.

Copyright © 2020-2030, id3 Technologies. All rights reserved. eu.id3.document