DocumentDetector.documentWidthRatio Property

Module: DocumentDetector

Type: float

Definition

Ratio of the estimated width of the searched document in the image.

Hint

Default value is 1.

document_width_ratio: float

Exceptions

An error has occurred during Document Library execution.
double get documentWidthRatio => getDocumentWidthRatio();
set documentWidthRatio(double value) => setDocumentWidthRatio(value);

Exceptions

An error has occurred during Document Library execution.
public float documentWidthRatio
{
    get => GetdocumentWidthRatio();
    set => SetdocumentWidthRatio(ref value);
}

Exceptions

An error has occurred during Document Library execution.
public float getDocumentWidthRatio() throws DocumentException
public void setDocumentWidthRatio(float documentWidthRatio) throws DocumentException

Exceptions

An error has occurred during Document Library execution.
public var documentWidthRatio: Float
    get {
        return try! getDocumentWidthRatio()
    }
}

Exceptions

An error has occurred during Document Library execution.
int id3DocumentDetector_GetDocumentWidthRatio (ID3_DOCUMENT_DETECTOR hDocumentDetector, float * documentWidthRatio)
int id3DocumentDetector_SetDocumentWidthRatio (ID3_DOCUMENT_DETECTOR hDocumentDetector, float documentWidthRatio)

Returns

int
An error code.
See id3DocumentError file for the list of possible error codes.