Thanks for downloading Dynamsoft Label Recognizer Package!

Your download will start shortly. If your download does not begin, click here to retry.

LabelRecognizer

You are viewing a history document page of Dynamsoft Label Recognizer Android v2.0.0.

class com.dynamsoft.dlr.LabelRecognizer

Initialization

Method	Description
`LabelRecognizer`	Initialization of `LabelRecognizer` object.
`destroy`	Destroys an instance of `LabelRecognizer` object.
`initLicense`	Sets the license and activates the SDK.

LabelRecognizer

Initialization of LabelRecognizer object.

LabelRecognizer() throws LabelRecognizerException

Exceptions

LabelRecognizerException

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();

destroy

void destroy()

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();
recognizer.destroy();

initLicense

Sets product key and activate the SDK.

static void initLicense(String license, DLRLicenseVerificationListener listener)

Parameters

license: The product keys. listener: The delegate to handle callback when license server returns.

Code Snippet

LabelRecognizer.initLicense("t0260NwAAAHV***************", new DLRLicenseVerificationListener() {
   @Override
   public void DLRLicenseVerificationCallback(boolean b, Exception e) {
      if (!b && e != null) {
         e.printStackTrace();
      }
   }
}

Settings

Method	Description
`getRuntimeSettings`	Gets the current settings and saves it into a struct.
`updateRuntimeSettings`	Updates runtime settings with a given struct.
`resetRuntimeSettings`	Resets the runtime settings.
`appendSettingsFromString`	Appends LabelRecognizerParameter settings in a string to the SDK object.
`appendSettingsFromFile`	Appends LabelRecognizerParameter settings from a file to the SDK object.
`outputSettingsToFile`	Outputs LabelRecognizerParameter settings into a file (JSON file).
`clearAppendedSettings`	Clear all appended LabelRecognizerParameter settings in the SDK object.
`updateReferenceRegionFromBarcodeResults`	Updates reference region which is defined with source type LST_BARCODE.
`getModeArgument`	Get argument value for the specified mode parameter.
`setModeArgument`	Set argument value for the specified mode parameter.
`appendCharacterModelBuffer`	Appends CharacterModel to the SDK object.
`eraseAllCharacterModels`	Erases all CharacterModels the SDK object currently loaded.
`eraseCharacterModelByName`	Erases a name specified CharacterModel from the SDK object.

appendCharacterModelBuffer

Appends CharacterModel to the SDK object.

static void appendCharacterModelBuffer (String name, byte[] prototxtBuffer, byte[] txtBuffer, byte[] characterModelBuffer)

Parameters

name A unique name for the appended CharacterModel.
prototxtBuffer The .prototxt file data of the CharacterModel in a byte array.
txtBuffer The .txt file data of the CharacterModel in a byte array.
characterModelBuffer The .caffemodel file data of the CharacterModel in a byte array.

Code Snippet

AssetManager manager = getAssets();
InputStream isPrototxt = manager.open("CharacterModel/NumberLetter.prototxt");
byte[] prototxt = new byte[isPrototxt.available()];
isPrototxt.read(prototxt);
isPrototxt.close();
InputStream isCharacterModel = manager.open("CharacterModel/NumberLetter.caffemodel");
byte[] characterModel = new byte[isCharacterModel.available()];
isCharacterModel.read(characterModel);
isCharacterModel.close();
InputStream isTxt = manager.open("CharacterModel/NumberLetter.txt");
byte[] txt = new byte[isTxt.available()];
isTxt.read(txt);
isTxt.close();

LabelRecognizer.appendCharacterModelBuffer("NumberLetter", prototxt, txt, characterModel);

eraseAllCharacterModels

Erases all CharacterModels the SDK object currently loaded.

static void eraseAllCharacterModels ()

Code Snippet

LabelRecognizer.eraseAllCharacterModels();

eraseCharacterModelByName

Erases a name specified CharacterModel from the SDK object.

static void eraseCharacterModelByName(String name)

Parameters

name A unique name representing the CharacterModel to erase.

Code Snippet

LabelRecognizer.eraseCharacterModelByName("NumberLetter");

appendSettingsFromFile

Appends LabelRecognizerParameter settings in a file to the SDK object.

void appendSettingsFromFile(String filePath) throws LabelRecognizerException

Parameters

filePath The settings file path.

Exceptions

LabelRecognizerException

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();
recognizer.appendSettingsFromFile("your file path");
recognizer.destroy();

appendSettingsFromString

Append a new template string to the current label Recognizer instance.

void appendSettingsFromString(String content) throws LabelRecognizerException

Parameters

content A JSON string that represents the content of the settings.

Exceptions

LabelRecognizerException

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();
recognizer.appendSettingsFromString("{\"LabelRecognizerParameter\":{\"Name\":\"P1\", \"RegionPredetectionModes\":[{\"Mode\":\"RPM_GENERAL_HSV_CONTRAST\"}], \"ReferenceRegionNameArray\": [\"R1\"]},\"ReferenceRegion\":{\"Name\":\"R1\",\"Localization\":{\"SourceType\":\"LST_PREDETECTED_REGION\",\"RegionPredetectionModesIndex\":0},\"TextAreaNameArray\":[\"T1\"]},\"TextArea\":{\"Name\":\"T1\",\"CharacterModelName\":\"Number\"}}");
recognizer.destroy();

clearAppendedSettings

Clear all appended parameter settings of the current label recognizer instance.

void clearAppendedSettings () throws LabelRecognizerException

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();
recognizer.clearAppendedSettings();

getModeArgument

Get argument value for the specified mode parameter.

String getModeArgument(String modesName, int index, String argumentName) throws LabelRecognizerException	

Parameters

modesName: The mode parameter name to get argument.
index: The array index of mode parameter to indicate a specific mode.
argumentName: The name of the argument to get.

Return value

the optional argument for a specified mode in Modes parameters.

Exceptions

LabelRecognizerException

Remark

Check follow link for available modes and arguments:

RegionPredetectionModes

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();

DLRRuntimeSettings settings = recognizer.getRuntimeSettings();
settings.furtherModes.regionPredetectionModes[0] = EnumRegionPredetectionMode.RPM_GENERAL_RGB_CONTRAST;
recognizer.updateRuntimeSettings(settings);
recognizer.setModeArgument("RegionPredetectionModes", 0, "AspectRatioRange", "100");
String argumentValue = recognizer.getModeArgument("RegionPredetectionModes", 0, "AspectRatioRange");
recognizer.destroy();

getRuntimeSettings

Get current settings and save them into a DLRRuntimeSettings class object.

DLRRuntimeSettings getRuntimeSettings () throws LabelRecognizerException

Return value

The class object of template settings.

Exceptions

LabelRecognizerException

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();

DLRRuntimeSettings settings = recognizer.getRuntimeSettings();
recognizer.destroy();

outputSettingsToFile

Outputs runtime settings and save them into a settings file (JSON file).

void outputSettingsToFile (String filePath, String templateName) throws LabelRecognizerException

Parameters

filePath The path of the output file which stores current settings.
templateName A unique name for declaring current runtime settings.

Exceptions

LabelRecognizerException

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();

recognizer.appendSettingsFromString("{\"LabelRecognizerParameter\":{\"Name\":\"P1\", \"RegionPredetectionModes\":[{\"Mode\":\"RPM_GENERAL_HSV_CONTRAST\"}], \"ReferenceRegionNameArray\": [\"R1\"]},\"ReferenceRegion\":{\"Name\":\"R1\",\"Localization\":{\"SourceType\":\"LST_PREDETECTED_REGION\",\"RegionPredetectionModesIndex\":0},\"TextAreaNameArray\":[\"T1\"]},\"TextArea\":{\"Name\":\"T1\",\"CharacterModelName\":\"Number\"}}");
recognizer.outputSettingsToFile("your saving file path", "currentRuntimeSettings");
recognizer.destroy();

resetRuntimeSettings

Reset all runtime settings to default values.

void resetRuntimeSettings () throws LabelRecognizerException

Exceptions

LabelRecognizerException

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();

DLRRuntimeSettings settings = recognizer.getRuntimeSettings();
settings.maxThreadCount = 4;
recognizer.updateRuntimeSettings(settings);
recognizer.resetRuntimeSettings();
recognizer.destroy();

setModeArgument

Set argument value for the specified mode parameter.

void setModeArgument(String modesName, int index, String argumentName, String argumentValue) throws LabelRecognizerException

Parameters

modesName: The mode parameter name to set argument.
index: The array index of mode parameter to indicate a specific mode.
argumentName: The name of the argument to set.
argumentValue: The value of the argument to set.

Exceptions

LabelRecognizerException

Remark

Check follow link for available modes and arguments:

RegionPredetectionModes

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();

DLRRuntimeSettings settings = recognizer.getRuntimeSettings();
settings.furtherModes.regionPredetectionModes[0] = EnumRegionPredetectionMode.RPM_GENERAL_RGB_CONTRAST;
recognizer.updateRuntimeSettings(settings);
recognizer.setModeArgument("RegionPredetectionModes", 0, "AspectRatioRange", "100");
recognizer.destroy();

updateReferenceRegionFromBarcodeResults

Updates reference region which is defined with source type LST_BARCODE.

void updateReferenceRegionFromBarcodeResults (BarcodeResult[] barcodeResults, String templateName) throws LabelRecognizerException

Parameters

barcodeResults The barcode results used to localize reference region. See also BarcodeResult. templateName The template name. A template name is the value of key LabelRecognizerParameter.Name defined in JSON formatted settings. If no template name is specified, current runtime settings will be used.

Exceptions

LabelRecognizerException

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();

recognizer.appendSettingsFromString("{\"LabelRecognizerParameter\":{\"Name\":\"P1\", \"RegionPredetectionModes\":[{\"Mode\":\"RPM_GENERAL_HSV_CONTRAST\"}], \"ReferenceRegionNameArray\": [\"R1\"]},\"ReferenceRegion\":{\"Name\":\"R1\",\"Localization\":{\"SourceType\":\"LST_BARCODE\"},\"TextAreaNameArray\":[\"T1\"]},\"TextArea\":{\"Name\":\"T1\",\"CharacterModelName\":\"Number\"}}");
//Get barcodeResults from Dynamsoft Barcode Reader SDK
recognizer.updateReferenceRegionFromBarcodeResults(barcodeResults, "P1");
recognizer.destroy();

updateRuntimeSettings

Update runtime settings with a given DLRRuntimeSettings class object.

void updateRuntimeSettings (DLRRuntimeSettings settings) throws LabelRecognizerException

Parameters

settings The class object of template settings. See also DLRRuntimeSettings

Exceptions

LabelRecognizerException

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();

DLRRuntimeSettings settings = recognizer.getRuntimeSettings();
settings.maxThreadCount = 1;
recognizer.updateRuntimeSettings(settings);
recognizer.destroy();

Recognizing

Method	Description
`recognizeByBuffer`	Recognizes text from memory buffer containing image pixels in defined format.
`recognizeByFile`	Recognizes text from a specified image file.
`recognizeByImage`	Recognizes text from a bitmap.

recognizeByBuffer

Recognizes text from the memory buffer containing image pixels in defined format.

DLRResult[] recognizeByBuffer(ImageData imageData, String templateName) throws LabelRecognizerException

Parameters

[in] imageData An object of ImageData that represents an image.
[in] templateName The template name. A template name is the value of key LabelRecognizerParameter.Name defined in JSON formatted settings. If no template name is specified, current runtime settings will be used.

Return value

All results recognized successfully.

Exceptions

LabelRecognizerException

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();

//Generate imageData from somewhere else
DLRResult[] result = recognizer.recognizeByBuffer(imageData, "");
recognizer.destroy();

recognizeByFile

Recognizes text from a specified image file.

DLRResult[] recognizeByFile (String fileName, String templateName) throws LabelRecognizerException

Parameters

fileName A string defining the file name.
templateName The template name. A template name is the value of key LabelRecognizerParameter.Name defined in JSON formatted settings. If no template name is specified, current runtime settings will be used.

Return value

All results recognized successfully.

Exceptions

LabelRecognizerException

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();

DLRResult[] result = recognizer.recognizeByFile("full file path", "");
recognizer.destroy();

recognizeByImage

Recognizes text from a bitmap.

DLRResult[] recognizeByImage (Bitmap image, String templateName) throws LabelRecognizerException	

Parameters

image A bitmap image.
templateName The template name. A template name is the value of key LabelRecognizerParameter.Name defined in JSON formatted settings. If no template name is specified, current runtime settings will be used.

Return value

All results recognized successfully.

Exceptions

LabelRecognizerException

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();

Bitmap img = BitmapFactory.decodeFile("full file path");
DLRResult[] result = recognizer.recognizeByImage(img, "");
recognizer.destroy();

General

Method	Description
`getVersion`	Returns the version number string for the SDK.

getVersion

Get version information of SDK.

String getVersion()

Return value

The version information string.

Code Snippet

LabelRecognizer recognizer = new LabelRecognizer();
String versionInfo = recognizer.getVersion();
recognizer.destroy();