Globale Funktionen - ABBYY Vantage Documentation

Operationen mit Flächen
Operationen mit Abständen
Operationen mit numerischen Datentypen
Operationen mit Rectangles und Regionen
String-Operationen
Zugriff auf XML-Dateien
Typkonvertierung und Prüfungen
Operationen mit Koordinaten
Zugriff auf Datenkataloge
Zugriff auf Skill-Parameter vom Typ Text
Verschiedenes

Operationen mit Flächen

Funktion	Beschreibung
`Area Max( Area a1, Area a2 )`	Gibt den größeren Wert aus a1 und a2 zurück.
`Area Min( Area a1, Area a2 )`	Gibt den kleineren Wert aus a1 und a2 zurück.
`Area ObjectsArea( Rect, ImageObjectType )`	Gibt die Fläche der Objekte des angegebenen Typs innerhalb des angegebenen Rechtecks zurück. Arbeitet mit globalen Koordinaten.
`Area ObjectsIntersectionArea( Rect, ImageObjectType )`	Gibt die Fläche der Objekte des angegebenen Typs innerhalb des angegebenen Rechtecks zurück. Wenn die Objektfläche über das angegebene Rechteck hinausgeht, wird die Schnittfläche der Objekte mit dem angegebenen Rechteck zurückgegeben. Arbeitet mit globalen Koordinaten.

Operationen mit Abständen

Function	Description
`Distance Abs( Distance )`	Gibt den Absolutwert eines Abstands zurück.
`Distance AverageInterLineInterval()`	Gibt die durchschnittliche Höhe der Textzeilen auf der Seite zurück. Die Funktion darf nur verwendet werden, wenn die maximale und minimale Seitenzahl im Dokument auf 1 festgelegt ist. Für ein mehrseitiges Dokument verwenden Sie die entsprechende Methode des Typs Page: `Page( N ).AverageLineHeight`.
`Distance AverageLineHeight()`	Gibt den durchschnittlichen Abstand zwischen den Textzeilen auf der Seite zurück. Die Funktion darf nur verwendet werden, wenn die maximale und minimale Seitenzahl im Dokument auf 1 festgelegt ist. Für ein mehrseitiges Dokument verwenden Sie die entsprechende Methode des Typs Page: `Page( N ).AverageInterLineInterval`.
`Distance Min( Distance d1, Distance d2 )`	Gibt den Minimalwert aus d1 und d2 zurück.
`Distance Max( Distance d1, Distance d2 )`	Gibt den Maximalwert aus d1 und d2 zurück.

Operationen mit numerischen Datentypen

Funktion	Beschreibung
`Int abs( Int )`	Gibt den absoluten Wert einer Zahl zurück.
`Int Ceil( Real )`	Gibt die kleinste ganze Zahl zurück, die nicht kleiner als das Argument ist.
`Int Floor( Real )`	Gibt die größte ganze Zahl zurück, die nicht größer als das Argument ist.
`Int Max( Int n1, Int n2 )`	Gibt den größeren Wert von n1 und n2 zurück.
`Int Min( Int n1, Int n2 )`	Gibt den kleineren Wert von n1 und n2 zurück.
`Int Round( Real )`	Gibt die ganze Zahl zurück, die dem Argument am nächsten liegt.
`Real Min( Real d1, Real d2 )`	Gibt den kleineren Wert von d1 und d2 zurück.
`Real Max( Real d1, Real d2 )`	Gibt den größeren Wert von d1 und d2 zurück.

Operationen mit Rectangles und Regionen

Funktion	Beschreibung
`Rect DocumentRect()`	Gibt das Rechteck des gesamten Dokuments zurück (in globalen Koordinaten).
`Rect PageRect()`	Gibt das Rechteck des gesamten Bildes zurück. Die Funktion darf nur verwendet werden, wenn die minimale und maximale Seitenzahl im Dokument auf 1 festgelegt ist.
`Region FormRegion( RectArray included, RectArray excluded )`	Erstellt eine Region, die die im Array enthaltenen Rectangles einschließt und die im Array ausgeschlossenen Rectangles ausschließt.

String-Operationen

Function	Description
`String Chr( Int )`	Gibt eine Zeichenfolge zurück, die dem angegebenen Unicode-Code des Zeichens entspricht (Code muss im Dezimalsystem angegeben werden).
`String LCase( String )`	Gibt eine Zeichenfolge zurück, die aus der angegebenen Zeichenfolge entsteht, indem alle Zeichen in Kleinbuchstaben umgewandelt werden.
`String RealToStrVariants( Real value, String fractionalPartSeparators, Int maxDigitsCountInFractionalPart = 2 )`	Erstellt, durch senkrechten Strich getrennte, String-Darstellungen für die angegebene reelle Zahl „value“, die Dezimaltrennzeichen „fractionalPartSeparators“ und die maximale Anzahl von Ziffern im Nachkommateil.
`String Str( ... )`	String-Darstellung eines Datentyps. Verfügbar für Int, Logic, Real, XInterval, YInterval, DistInterval, FuzzyRect, Hypothesis, RectArray, Region, Area, Quality, Distance, PageInterval.
`String RemoveSpaces( String )`	Gibt eine Zeichenfolge zurück, die aus der angegebenen Zeichenfolge entsteht, indem alle Leerzeichen entfernt werden.
`String UCase( String )`	Gibt eine Zeichenfolge zurück, die aus der angegebenen Zeichenfolge entsteht, indem alle Zeichen in Großbuchstaben umgewandelt werden.

Zugriff auf XML-Dateien

Funktion	Beschreibung
`StringArray ReadFromXML( String filename, String xPathQuery )`	Liest ein Array von Zeichenketten aus der XML-Datei „filename“. Die Zeichenketten werden durch Auswerten der übergebenen XPath-Abfrage „xPathQuery“ ermittelt. Weitere Informationen zur Verwendung von XML-Dateien finden Sie unter User Dictionaries. Hinweis: Um den Code übersichtlicher zu gestalten, können Sie für häufig verwendete XPath-Abfragen Konstanten mit Platzhaltern definieren und diese Konstanten in Funktionsaufrufen verwenden.
`String ReadSingleStringFromXML( String filename, String xPathQuery )`	Liest eine Zeichenkette aus der XML-Datei „filename“. Die Zeichenkette wird durch Auswerten der übergebenen XPath-Abfrage „xPathQuery“ ermittelt. Weitere Informationen zur Verwendung von XML-Dateien finden Sie unter User Dictionaries.

Typkonvertierung und Prüfungen

Function	Description
`Logic IsReal( String numberString, String separators = ".,", Logic isStrictMode = false )`	Prüft, ob die Zeichenfolge `inputString` sicher in eine reelle Zahl konvertiert werden kann. Die Liste der zulässigen Dezimaltrennzeichen wird durch das Argument „separators“ festgelegt.
`Logic IsRealFuzzy( String, String separators = defaultDecimalSeparators, Logic isStrictMode = false )`	Prüft, ob die Zeichenfolge `inputString` unter Berücksichtigung möglicher Erkennungsfehler sicher in eine reelle Zahl konvertiert werden kann.
`Logic IsInt( String inputString, Logic isStrictMode = false )`	Prüft, ob die Zeichenfolge `inputString` sicher in eine ganze Zahl konvertiert werden kann.
`Logic IsIntFuzzy( String inputString, Logic isStrictMode = false )`	Prüft, ob die Zeichenfolge `inputString` unter Berücksichtigung möglicher Erkennungsfehler sicher in eine ganze Zahl konvertiert werden kann.
`Real StrToRealFuzzy( String, String separators = defaultDecimalSeparators, Logic isStrictMode = false )`	Gibt das Ergebnis der Konvertierung des Werts der Zeichenfolge `inputString` in eine reelle Zahl unter Berücksichtigung möglicher Erkennungsfehler zurück.
`Real StrToReal( String numberString, String separators = ".,", Logic isStrictMode = false )`	Gibt das Ergebnis der Konvertierung der Zeichenfolge `inputString` in eine reelle Zahl zurück. Leerzeichen werden ignoriert.
`Int StrToInt( String inputString, Logic isStrictMode = false )`	Gibt das Ergebnis der Konvertierung des Werts der Zeichenfolge `inputString` in eine ganze Zahl zurück. Leerzeichen werden ignoriert.
`Int StrToIntFuzzy( String, Logic isStrictMode = false )`	Gibt das Ergebnis der Konvertierung des Werts der Zeichenfolge `inputString` in eine ganze Zahl unter Berücksichtigung möglicher Erkennungsfehler zurück.
`Int LogicToInt( Logic value )`	Gibt „1“ zurück, wenn der Wert `true` ist, und „0“, wenn der Wert `false` ist.

Operationen mit Koordinaten

Funktion	Beschreibung
`XCoordinate Min( XCoordinate x1, XCoordinate x2 )`	Gibt den kleineren Wert aus x1 und x2 zurück.
`XCoordinate Max( XCoordinate x1, XCoordinate x2 )`	Gibt den größeren Wert aus x1 und x2 zurück.
`XCoordinate MiddleBetween( XCoordinate x1, XCoordinate x2 )`	Gibt die X-Koordinate zurück, berechnet als ( x1 + x2 ) / 2.
`XCoordinate Between( XCoordinate x1, XCoordinate x2, Real ratio )`	Gibt die X-Koordinate zurück, berechnet als x1 + ( x2 – x1 ) * ratio.
`YCoordinate Min( YCoordinate y1, YCoordinate y2 )`	Gibt den kleineren Wert aus y1 und y2 zurück.
`YCoordinate Max( YCoordinate y1, YCoordinate y2 )`	Gibt den größeren Wert aus y1 und y2 zurück.
`YCoordinate MiddleBetween( YCoordinate y1, YCoordinate y2 )`	Gibt die Y-Koordinate zurück, berechnet als ( y1 + y2 ) / 2.
`YCoordinate Between( YCoordinate y1, YCoordinate y2, Real ratio )`	Gibt die Y-Koordinate zurück, berechnet als y1 + ( y2 – y1 ) * ratio.
`XInterval MiddleBetween( Xinterval x1, XInterval x2 )`	Gibt XInterval zurück, berechnet als ( x1 + x2 ) / 2.
`XInterval Between( Xinterval x1, Xinterval x2, Real ratio )`	Gibt XInterval zurück, berechnet als x1 + ( x2 – x1 ) * ratio.
`YInterval MiddleBetween( Yinterval y1, Yinterval y2 )`	Gibt YInterval zurück, berechnet als ( y1 + y2 ) / 2.
`YInterval Between( Yinterval y1, Yinterval y2, Real ratio )`	Gibt YInterval zurück, berechnet als y1 + ( y2 – y1 ) * ratio.

Zugriff auf Datenkataloge

Hinweis: Um auf einen Datenkatalog zuzugreifen, erstellen Sie zunächst einen Skill-Parameter, der auf diesen Katalog verweist, und verwenden anschließend den Parameternamen in den Methodenaufrufen.

Function	Description
`Logic TestAccessToCatalog( String catalogParameterName )`	Testet den Zugriff auf den Datenkatalog, auf den der Parameter catalogParameterName verweist.
`Logic TestCatalogSearchCriteria( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria )`	Prüft die Gültigkeit der für den Datenkatalog festgelegten Suchkriterien. Die Suchkriterien werden mithilfe eines Arrays benannter Werte festgelegt, wobei jeder benannte Wert einen Spaltennamen und dessen erwarteten Wert darstellt. Das Array searchColumns gibt an, welche Spalten des Datensatzes aus dem Datenkatalog in die Antwort aufgenommen werden.
`StringArray FieldNamesOfCatalog( String catalogParameterName )`	Gibt eine Liste aller Spaltennamen im Datenkatalog zurück, auf den der Parameter catalogParameterName verweist. Die Spalten sind in aufsteigender Reihenfolge nach Indexnummer angeordnet.
`StringArray FieldNamesOfCatalog( String catalogParameterName, StringArray searchColumnNames )`	Gibt eine Liste der Spaltennamen des Datenkatalogs zurück, die im Array searchColumnNames vorkommen (Groß-/Kleinschreibung wird ignoriert). Die Spalten sind in aufsteigender Reihenfolge nach Indexnummer angeordnet. Mit dieser Methode können Sie Spaltenindizes ermitteln.
`Int RecordCountOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray )`	Gibt die Anzahl der Datensätze im Datenkatalog zurück, die die angegebenen Suchkriterien erfüllen.
`Void PrepareRecordsetOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray, Int maxRecordsCount = 1000 )`	Ruft Datensätze aus dem Datenkatalog ab, die die Suchkriterien erfüllen.
`StringArray RecordOfCatalog( String catalogParameterName, StringArray searchColumns, NamedValueArray searchCriteria = EmptyNamedValueArray, Int rowIndex )`	Gibt einen Datensatz aus dem Datenkatalog zurück, der die Suchkriterien erfüllt.
`Quality ValidateByCatalog( String word, String catalogParameterName, Int columnIndex, NamedValueArray searchCriteria = EmptyNamedValueArray, Int maxErrors, Rational maxErrorsPart, Logic ignoreSpaces = true, Int maxRecordsCount = 1000 )`	Prüft die angegebene Zeichenfolge word, indem sie mit den Werten der Spalte mit dem Index columnIndex im Datenkatalog verglichen wird. Gibt die Qualität der Übereinstimmung zwischen der angegebenen Zeichenfolge und dem besten Treffer aus der Spalte des Datenkatalogs zurück.
`Int GetCatalogColumnIndex( String catalogParameterName, String columnName )`	Gibt den Index der ersten Spalte mit dem angegebenen Namen zurück, die im Datenkatalog gefunden wurde, auf den der Parameter catalogParameterName verweist. Der Spaltenname ist unabhängig von Groß-/Kleinschreibung.
`IntArray GetCatalogColumnIndices( String catalogParameterName, String columnName )`	Gibt die Indizes aller Spalten mit dem angegebenen Namen zurück, die im Datenkatalog gefunden wurden, auf den der Parameter catalogParameterName verweist. Der Spaltenname ist unabhängig von Groß-/Kleinschreibung.

Zugriff auf Skill-Parameter vom Typ Text

Function	Description
`Logic NamedParameterStringExists( String parameterName )`	Prüft, ob in der Skill ein Text-Parameter mit dem angegebenen Namen vorhanden ist. Der Parametername unterscheidet zwischen Groß- und Kleinschreibung.
`String GetNamedParameterString( String parameterName )`	Gibt den Wert des Text-Parameters mit dem angegebenen Namen zurück. Der Parametername unterscheidet zwischen Groß- und Kleinschreibung.

Verschiedenes

Funktion	Beschreibung
`InputFieldArray InputFields()`	Gibt eine Sammlung von Objekten zurück – Felder, die im Dokument in den vorherigen Verarbeitungsstufen gefunden wurden.
`Int PagesCount()`	Gibt die Anzahl der Seiten im Dokument zurück.
`Page Page( Int PageNumber )`	Gibt das Page-Objekt zurück, das die Seite mit der angegebenen Nummer repräsentiert.
`Logic IsOnSameLine( Hypothesis, Hypothesis )`	Prüft, ob die Hypothesen sich vertikal überschneiden.

Vordefinierte Variablen zur Beschreibung von Feldbereichen Benutzerwörterbücher

⌘I