Package com.itextpdf.pdfocr.onnxtr.detection

Class OnnxDetectionPredictorProperties

java.lang.Object

com.itextpdf.pdfocr.onnxtr.detection.OnnxDetectionPredictorProperties

       public class OnnxDetectionPredictorProperties extends Object
      

Properties for configuring text detection ONNX models.

It contains a path to the model, model input properties and a model output post-processor.

Constructor Summary

Constructors

Constructor	Description
OnnxDetectionPredictorProperties(String modelPath, OnnxInputProperties inputProperties, IDetectionPostProcessor postProcessor)	Creates new text detection predictor properties.

Method Summary

Modifier and Type	Method	Description
static OnnxDetectionPredictorProperties	dbNet(String modelPath)	Creates a new text detection properties object for existing pre-trained DBNet models, stored on disk.
boolean	equals(Object o)
static OnnxDetectionPredictorProperties	fast(String modelPath)	Creates a new text detection properties object for existing pre-trained FAST models, stored on disk.
OnnxInputProperties	getInputProperties()	Returns the ONNX model input properties.
String	getModelPath()	Returns the path to the ONNX model.
IDetectionPostProcessor	getPostProcessor()	Returns the ONNX model output post-processor.
int	hashCode()
static OnnxDetectionPredictorProperties	linkNet(String modelPath)	Creates a new text detection properties object for existing pre-trained LinkNet models, stored on disk.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

OnnxDetectionPredictorProperties

             public OnnxDetectionPredictorProperties
             (String modelPath, OnnxInputProperties inputProperties, IDetectionPostProcessor postProcessor)
            

Creates new text detection predictor properties.

Parameters:

modelPath - path to the ONNX model to load

inputProperties - ONNX model input properties

postProcessor - ONNX model output post-processor

Method Details

dbNet

             public static OnnxDetectionPredictorProperties dbNet
             (String modelPath)
            

Creates a new text detection properties object for existing pre-trained DBNet models, stored on disk.

This can be used to load the following models from OnnxTR:

• db_resnet50
• db_resnet50 (8-bit quantized)
• db_resnet34
• db_resnet34 (8-bit quantized)
• db_mobilenet_v3_large
• db_mobilenet_v3_large (8-bit quantized)

Parameters:

modelPath - path to the pre-trained model

Returns:

a new text detection properties object for a DBNet model

fast

             public static OnnxDetectionPredictorProperties fast
             (String modelPath)
            

Creates a new text detection properties object for existing pre-trained FAST models, stored on disk. This is the default text detection model in OnnxTR.

This can be used to load the following models from OnnxTR:

• fast_base
• fast_small
• fast_tiny

Parameters:

modelPath - path to the pre-trained model

Returns:

a new text detection properties object for a FAST model

linkNet

             public static OnnxDetectionPredictorProperties linkNet
             (String modelPath)
            

Creates a new text detection properties object for existing pre-trained LinkNet models, stored on disk.

This can be used to load the following models from OnnxTR:

• linknet_resnet50
• linknet_resnet50 (8-bit quantized)
• linknet_resnet34
• linknet_resnet34 (8-bit quantized)
• linknet_resnet18
• linknet_resnet18 (8-bit quantized)

Parameters:

modelPath - path to the pre-trained model

Returns:

a new text detection properties object for a LinkNet model

getModelPath

             public String getModelPath()
            

Returns the path to the ONNX model.

Returns:

the path to the ONNX model

getInputProperties

             public OnnxInputProperties getInputProperties()
            

Returns the ONNX model input properties.

Returns:

the ONNX model input properties

getPostProcessor

             public IDetectionPostProcessor getPostProcessor()
            

Returns the ONNX model output post-processor.

Returns:

the ONNX model output post-processor

equals

             public boolean equals
             (Object o)
            

Overrides:

equals in class Object

hashCode

             public int hashCode()
            

Overrides:

hashCode in class Object

toString

             public String toString()
            

Overrides:

toString in class Object