Class DdddOcr

Index

Constructors

Methods

classification detection enableDebug setOcrMode setRanges

Constructors

constructor

new DdddOcr(logSeverityLevel?: LogSeverityLevel): DdddOcr
Class representing an OCR (Optical Character Recognition) model.
Parameters
- logSeverityLevel: LogSeverityLevel = 4
  Log severity level. See https://github.com/microsoft/onnxruntime/blob/main/include/onnxruntime/core/common/logging/severity.h
Returns DdddOcr
- Defined in src/index.ts:44

Methods

classification

classification(url: string): Promise<string>
Classifies an image by running it through an OCR model.
Parameters
- url: string
Returns Promise<string>
- Defined in src/index.ts:113

detection

detection(url: string): Promise<number[][]>
Detects objects in an image by extracting bounding boxes and optionally visualizing the detection results on the image.

This method reads the image, retrieves bounding boxes, and then optionally draws the detected bounding boxes on the image if debugging is enabled.
Parameters
- url: string
Returns Promise<number[][]>
- Defined in src/index.ts:128

enableDebug

enableDebug(): this
Enables the debug mode and prepares the debug folder.

Returns this
- Defined in src/index.ts:64

setOcrMode

setOcrMode(mode: MODEL_TYPE): this
Sets the OCR mode for the instance.
Parameters
- mode: MODEL_TYPE
Returns this
- Defined in src/index.ts:81

setRanges

setRanges(charsetRange: string | CHARSET_RANGE): this
Sets the range restriction for OCR results.

This method restricts the characters returned by OCR based on the input:
- For number input, it applies a predefined character set. See the CHARSET_RANGE type for the available options.
- For string input, each character in the string is treated as a valid OCR result.
Parameters
- charsetRange: string | CHARSET_RANGE
Returns this
- Defined in src/index.ts:103