HALCON 24.11.1.0 / HALCON Operator Reference / OCR / Lexica
ClassesClasses | | Operators

import_lexiconT_import_lexiconImportLexiconImportLexiconimport_lexicon (Operator)

Name

import_lexiconT_import_lexiconImportLexiconImportLexiconimport_lexicon — Create a lexicon from a text file.

Signature

import_lexicon( : : Name, FileName : LexiconHandle)

Herror T_import_lexicon(const Htuple Name, const Htuple FileName, Htuple* LexiconHandle)

void ImportLexicon(const HTuple& Name, const HTuple& FileName, HTuple* LexiconHandle)

void HLexicon::HLexicon(const HString& Name, const HString& FileName)

void HLexicon::HLexicon(const char* Name, const char* FileName)

void HLexicon::HLexicon(const wchar_t* Name, const wchar_t* FileName)   ( Windows only)

void HLexicon::ImportLexicon(const HString& Name, const HString& FileName)

void HLexicon::ImportLexicon(const char* Name, const char* FileName)

void HLexicon::ImportLexicon(const wchar_t* Name, const wchar_t* FileName)   ( Windows only)

static void HOperatorSet.ImportLexicon(HTuple name, HTuple fileName, out HTuple lexiconHandle)

public HLexicon(string name, string fileName)

void HLexicon.ImportLexicon(string name, string fileName)

def import_lexicon(name: str, file_name: str) -> HHandle

Description

import_lexiconimport_lexiconImportLexiconImportLexiconimport_lexicon creates a new lexicon based on a list of words in the file specified by FileNameFileNameFileNamefileNamefile_name. The format of the file is a simple text file with one word per line. By specifying a unique textual NameNameNamenamename, you can later refer to the lexicon from syntax expressions like those used, e.g., by do_ocr_word_mlpdo_ocr_word_mlpDoOcrWordMlpDoOcrWordMlpdo_ocr_word_mlp.

Note that lexicon support in HALCON is currently not aimed at natural languages. Rather, it is intended as a post-processing step in OCR applications that only need to distinguish between a limited set of not more than a few thousand valid words, e.g., country or product names. When the lexicon file contains entries with special, non-ASCII characters, it is expected to be encoded in UTF-8. However, old lexicon files which use the local 8-bit encoding, can still be loaded as long as they contain at least one byte sequence, which cannot be misinterpreted as UTF-8 character. MVTec itself does not provide any lexica.

Execution Information

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

NameNameNamenamename (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Unique name for the new lexicon.

Default: 'lex1' "lex1" "lex1" "lex1" "lex1"

FileNameFileNameFileNamefileNamefile_name (input_control)  filename.read → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of a text file containing words for the new lexicon.

Default: 'words.txt' "words.txt" "words.txt" "words.txt" "words.txt"

File extension: .txt

LexiconHandleLexiconHandleLexiconHandlelexiconHandlelexicon_handle (output_control)  lexicon → HLexicon, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the lexicon.

Possible Successors

do_ocr_word_mlpdo_ocr_word_mlpDoOcrWordMlpDoOcrWordMlpdo_ocr_word_mlp, do_ocr_word_svmdo_ocr_word_svmDoOcrWordSvmDoOcrWordSvmdo_ocr_word_svm

Alternatives

create_lexiconcreate_lexiconCreateLexiconCreateLexiconcreate_lexicon

See also

lookup_lexiconlookup_lexiconLookupLexiconLookupLexiconlookup_lexicon, suggest_lexiconsuggest_lexiconSuggestLexiconSuggestLexiconsuggest_lexicon

Module

OCR/OCV

ClassesClasses | | Operators
HALCON Operator Reference 24.11.1.0 Copyright © 1996-2024 MVTec Software GmbH