Skip to main content
ParameterDescription
Void AllowEmbeddedHypotheses( Logic )Sets the hypothesis formulation mode. To formulate all possible hypotheses (including overlapping and nested) from a character string, set the value to True. To formulate hypotheses of maximum length, set to False. Example: The code below tells the activity that it must generate the longest hypothesis. AllowEmbeddedHypotheses(False);
Void MinQuality( Real )Sets the minimum quality of the hypothesis. Hypotheses whose quality is below this minimum will be discarded. Example: The code below tells the activity to ignore hypotheses whose quality is lower than 0.95. MinQuality: 0.95;
Void MaxNonDefinedCount( Real )Sets the allowed percentage of characters which do not belong to any of the character sets specified for the search element. Example: The code below tells the activity that the string may contain up to 30% of characters which do not belong to any of the specified character sets. MaxNonDefinedCount(0.3);
Void MaxWordBreakCount( Real )The maximum number of word breaks in the line. The line is divided into words based on the MinInterwordSpace parameter. The parameter is specified as a ratio: [number of word breaks]/[number of characters in the string].
Void MinInterwordSpace( Distance )Enables division into words based on the width of the space and specifies the minimum width of the space to Distance.
Void WordsCount( Int, Int, Int, Int )Sets the number of words in the character string. The number of words is specified by means of a fuzzy interval. The default interval is {-1,-1,INF,INF} (i.e. the activity looks for hypotheses containing any number of words).
Void TotalChainLength( Int, Int, Int, Int )Sets the length of the character string (i.e. the number of characters in the string). The number of characters is specified by means of a fuzzy interval. Example: The code below tells the activity to look for a line 5 to 10 characters long. TotalChainLength(4, 5, 10, 11);
Void TotalGapLength( Distance, Distance, Distance, Distance )Specifies the maximum allowed total length of spaces in the string as a fuzzy interval.
Void MaxGapInLine( Distance )Sets the maximum distance between neighboring characters. When generating a hypothesis, the activity will add characters to the hypothesis until the distance between two neighboring characters does not exceed MaxGapInLine.
Void MaxRelativeGapInLine( Real )Sets the maximum distance between neighboring characters expressed as a percentage of the line height.
Void AllowChoppedWords( Logic )Specifies whether text objects which do not fit entirely within the left and right boundaries should be included into the hypothesis. The default value is True.
Void MaxXOutsidePart( Real )Specifies the part of the text object that may lie outside the search area in the horizontal dimension. The part of the text object is specified by a number from 0 to 1. A text object is included in the hypothesis if the part of the text object outside the search area is not bigger than specified by this parameter.
Void MaxYOutsidePart( Real )Specifies the part of the text object that may lie outside the search area in the vertical dimension. The part of the text object is specified by a number from 0 to 1. A text object is included in the hypothesis if the part of the text object outside the search area is not bigger than specified by this parameter.
Void AddAlphabet( String alphabet, Real portion, Logic isRestrictionStrong )Sets the character set and the allowed percentage of characters in the hypothesis. The flag isRestrictionStrong specifies whether a hypothesis is discarded when the allowed percentage is exceeded. If the flag is set to False, excess symbols will be considered to belong to no character set. The default setting is True. Example: The code below tells the activity to add a character set which consists of the characters №, #, % and *, whose percentage in the hypothesis may not exceed 10%. Note: You can only add characters which are not part of any of the character sets specified for the current element. AddAlphabet("№#%*", 0.1, True);
Void RegularExpression( String )Sets the regular expression defining the text of the hypothesis. The regular expression syntax is described here. Example: The two following regular expressions are equivalent and look for a string where characters may be arranged in one of two ways: 2 digits, - (hyphen), 1 digit; or Letter N, digit from 1 to 5, / (forward slash), 1 to 3 digits. `RegularExpression: (”([0-9][-][0-9])([N][1-5][/][0-9])”); RegularExpression: (”([0-9]”-“[0-9])(“N”[1-5]”/“[0-9])”);`
Void WholeWordMode( Logic )Specifies whether only whole words must be considered as valid hypotheses. If the flag is set to True, hypotheses made up of parts of words will be discarded. The default setting is False. Note: This differs from the AllowedChoppedWords property as follows: AllowChoppedWords only considers words on the boundary of the search area, whereas WholeWordMode considers all words within a hypothesis.
Void RegularExpressionFromFile( String fileName, Int maxRecordsCount = 1000 )Uses a text file to set the regular expression defining the text of the hypotheses. The fileName argument sets the name of the text file. To speed up the search, only the first maxRecordsCount variants are used (the default setting is 1000).
Void RegularExpressionFromCatalog( String catalogParameterName, Int columnIndex, NamedValueArray searchCriteria = EmptyNamedValueArray, Int maxRecordsCount = 1000 )Uses the values in the column with index columnIndex from the data catalog referenced by the catalogParameterName parameter to set the regular expression defining the text of the hypotheses. You can determine column indexes using one of the following global functions: FieldNamesOfCatalog, GetCatalogColumnIndex, GetCatalogColumnIndices. The records may be filtered by the search criteria set using an array of named values, where each named value represents the column name and its expected value. The set will contain only the values from the records which meet the search criteria. To speed up the query, only the first maxRecordsCount records are accessed (the default setting is 1000).
Void Width( Distance, Distance, Distance, Distance )Specifies the width of the hypothesis specified as a fuzzy interval.
Void Height( Distance, Distance, Distance, Distance )Specifies the height of the hypothesis specified as a fuzzy interval.
Void TrimSymbols( String )Specifies the characters to be trimmed at the beginning and at the end of a hypothesis.
Void SimilarSymbolQuality( Real )Specifies a coefficient for the hypothesis quality if the hypothesis includes a character that looks similar to a character from the specified character set.
Void AllowedTextRotations( TextRotations )Specifies a set of allowed orientations for the recognized text. A hypothesis will only be formulated if the recognized text has an orientation that is allowed by this parameter.