Die meisten Arbeiten des LayoutWizzards finden im Allgemeinen im Hintergrund von Goobi statt. Dies betrifft die automatische Bildanalyse und das abschließende Croppen der Bilder, nachdem zwischenzeitlich ein Nutzer den Vorschlag für das Croppen aus der Bildanalyse geprüft hatte.

Die Prüfung dieser Cropping-Vorschläge jedoch ist der wichtigste Interaktionspunkt der Goobi-Anwender mit dem LayoutWizzard. Hier ist es für den Nutzer möglich, für jedes Bild zu sehen, wie dieses analysiert wurde und wie der LayoutWizzard dieses croppen würde. Dabei kann nun für jedes einzelne Bild vom Anwender entschieden werden, ob das Croppen gegebenenfalls anders erfolgen soll. Entsprechend stellt das Plugin eine Nutzeroberfläche zur Verfügung, die eine Rotation der Bilder erlaubt, die Position der Buchfalz ändern läßt und auch den Zuschneiderahmen in seiner Größe und Position bearbeiten läßt. Zur Durchführung dieser Bearbeitung bietet der LayoutWizzard zwei verschiedene Ansichten: die Vorschauansicht zur Sichtung und direkten Korrektur aller Bilder eines Vorganges und die Einzelseitenansicht zur detaillierten Bearbeitung einzelner Bilder.

Alle allgemeinen Einstellungen zur Konfiguration und zu dem Analyseworkflow sind in der Einzelseitenansicht untergebracht. Die eigentliche Kontrolle und Korrektur wird in den meisten Fällen jedoch ausschließlich in der Vorschauansicht stattfinden. Aus diesem Grund sollte der LayoutWizzard möglichst so konfiguriert werden, dass der Einstieg in das Plugin aus einer angenommenen Aufgabe möglichst direkt in die Vorschauansicht erfolgt.

Vorschauansicht

Einzelseitenansicht

Die Vorschauansicht enthält eine Liste aller Bilder im Eingabeordner. Diese sind jedoch in der Regel auf mehrere Seiten verteilt, um die Ladezeiten der anzuzeigenden Bilder möglichst gering zu halten. Je nach gewählter Einstellung werden dabei gegenüberliegende rechte und linke Buchseiten nebeneinander angezeigt, oder es werden abwechselnd jeweils nur rechte und nur linke Bilder angezeigt, so dass diese jeweils schnell verglichen verglichen werden können.

Innerhalb der Vorschauansicht läßt sich festlegen, wie groß die Bilder angezeigt werden sollen und ob der Schneiderahmen oberhalb des originalen Bildes angezeigt werden soll oder stattdessen eine Vorschau, des späteren beschnittenen Bildes.

Für jedes einzelne Bild lassen sich direkt aus dieser Anzeige Korrekturen vornehmen. So kann über den Schieberegler neben dem Bild die Rotation, mit dem Mauszeiger die Buchfalz anders positioniert und mittels Klicken und Ziehen die Größe und Position des Zuschneiderahmens geändert werden.

Tip: Beachten Sie, dass Sie eine Anpassung eines Bildes (Rotation, Buchfalz oder Rahmen) auch mit gedrückter Shift-Taste durchführen können. In diesem Fall wird Ihre Korrektur nicht nur für das aktuell gewählte Bild angewendet, sondern ebenfalls für alle nachfolgenden angezeigten Bilder. Dies spart unter Umständen sehr viel Zeit für manuelle Korrekturarbeiten.

Neben der Möglichkeit, jedes Bild direkt aus der Vorschauansicht zu ändern, erlauben die drei Buttons neben jedem Bild einen direkten Zugang in die Detailansicht der Bildanalyse für das entsprechende Bild innerhalb der Einzelseitenansicht.

Über die Buttons Vorwärts und Rückwärts ober- und unterhalb der Vorschauliste kann der Nutzer durch die Seiten der dargestellten Bilder blättern.

Innerhalb der Vorschauansicht existiert im linken Bereich ein Menü mit mehreren Buttons für die Konfiguration der Bildanzeige.

Die in diesem Menü angebotenen Funktionen haben die folgende Bedeutung:

Die Einzelseitenansicht, bisweilen auch als Übersichtsseite bezeichnet, enthält globale Einstellungen des LayoutWizzards sowie alle Einstellungen zur aktuell betrachteten Seite. Diese Ansicht gliedert sich in mehrere Teilbereiche, wobei die Details einiger dieser Bereiche jeweils nur dann sichtbar sind, wenn die entsprechenden Bereiche aktiv sind. Ein Umschalten zwischen den Bereichen ist möglich, indem die Titelleiste eines Bereichs angeklickt wird. Die Titelleiste enthält außerdem bei manchen Bereichen rechts einen Knopf um den erweiterten Modus für diesen Bereich an- und auszuschalten. Im erweiterten Modus sind jeweils zusätzliche Optionen verfügbar die im normalen Betrieb üblicherweise nicht benötigt werden. Die Teilbereiche sind im Folgenden einzeln beschrieben.

Die Vorschauansicht beinhaltet für jede Bilddatei einen Bildbereich wie den folgenden. Er besteht aus der eigentlichen Bildanzeige, den Steuerelementen für die Rotation und den Zuschneiderahmen sowie mehreren Buttons zum Betreten der Detailansicht für eine bestimmte Analysephase.

Bildanzeige

Die Bildanzeige enthält das eigentliche Bild. Das Bild ist den Analyseergebnissen entsprechend rotiert und enthält Marker für die Falzposition (rot) und den Zuschneiderahmen (türkis). Beide Marker können mit der Maus angefasst und bewegt werden, um somit die Analysedaten zu korrigieren. Ein Klicken, Halten und Ziehen mit der Maus innerhalb des Zuschneiderahmens bewegt den gesamten Rahmen.

Tip: Hält man bei einer dieser Aktionen die Shift-Taste gedrückt, wird die Änderung auf alle folgenden Bilder der selben Ausrichtung auf der aktuellen Seite übertragen. Dabei werden relative Koordinaten verwendet. Verschiebt man also bei gedrückter Shift-Taste die Falz eines rechten Bildes auf eine Position 10% vom linken Bildrand entfernt, wird für alle folgenden rechten Bilder auf der Seite die Falz ebenfalls 10% vom linken Bildrand positioniert; unabhängig von der absoluten Größe der Bilder.

Zusätzlich gelangt man durch einen Doppelklick auf das Bild in einen Rotationsmodus, in dem man durch auf- und Abwärtsbewegungen der Maus die Bildrotation verändern kann. Diese Rotation ist nicht proportional zur Mausbewegung sondern umso stärker je weiter man die Maus vom Ursprung fortbewegt hat. Ein erneuter Doppelklick beendet den Rotationsmodus wieder.

Steuerelement für die Rotation

Mit dem Schieberegler neben der Bildanzeige kann die Rotation des Bildes verändert werden. Klicken Sie hierzu einfach auf den Button und verschieben Sie diesen nach oben oder unten, um die Rotation des gewählten Bildes zu verändern.

Steuerelement zum Verschieben

Neben der Bildanzeige gibt es ein Steuerelement zum Verschieben des Zuschneiderahmens. Dieser Button kann mit der Maus in alle Richtungen bewegt werden und verschiebt somit die Position des Zuschneiderahmens. Zu beachten ist dabei, dass die Verschiebung des Rahmen nicht proportional erfolgt. Je weiter der Button nach dem Klicken gezogen wird, desto schneller wird der Rahmen verschoben.

Buttons zum Betreten der Detailansicht

Die drei Buttons neben der Bildanzeige erlauben das Betreten der Einzelseitenansicht für die gewählte Analysephase, um dort gezielt einzelne Analyseparameter justieren zu können. Klicken Sie innerhalb der Detailansicht erneut auf den Button Vorschauansicht öffnen gelangen Sie wieder zum selben Bild innerhalb der Vorschauansicht.

Unterhalb der Buttons für die Detailansicht befindet sich die Bildnummer innerhalb des Eingabeordners. Hierbei handelt es sich nicht um den Dateinamen der Bilddatei sondern um einen einfachen Zähler, der im Falle vieler gleichartiger angezeigter Bilder eine Orientierung geben soll, an welcher Stelle innerhalb der Bilddateien man sich derzeit befindet.

Abhängig von der Konfiguration des LayoutWizzards wird in diesem Bereich gegebenenfalls ebenso ein DropDown-Menü angezeigt. Dieses erlaubt eine Änderung der Ausrichtung für die jeweiligen Seite. Beachten Sie bitte, dass die hier vorgenommene Änderung ausschließlich für das aktuell ausgewählte Bild erfolgt und keine Auswirkungen auf die nachfolgenden Bilder hat.

Der rechte Bereich umfasst die Anzeige des aktuellen Bildes und einen Kopfbereich mit einigen Informationen zur Bilddatei. Wichtig ist hier vor allem das DropDown-Menü zur Auswahl der Ausrichtung der aktuellen Seite. Es ist zu beachten, dass eine Änderung der Ausrichtung auch die Ausrichtung aller Folgeseiten ändert, nach den im Seitenmodus gewählten Regeln.

In der Kopfzeile lässt sich außerdem zum nächsten und vorherigen Bild, sowie zum nächsten oder vorherigen Ausreißer wechseln.

In der eigentlichen Bildanzeige ist, wenn einer der Analyseschritte ausgewählt ist, das Analyseergebnis des gewählten Schrittes sichtbar, das sich direkt mit der Maus bearbeiten lässt.

Unterhalb des Bildbereichs liegen mehrere Buttons, um das Plugin zu verlassen und den Workflow fortzusetzen.

Übersicht

Einführung

Der LayoutWizzard ist ein Werkzeug zur Analyse vom digitalisierten Buchseiten und ähnlicher Materialien, das die Position der physischen Seite im digitalisierten Bild erkennt und das Bild entsprechend ausrichten und schneiden kann.

Arbeitsweise

Die Analyse im LayoutWizzard findet halbautomatisch statt. Sie beginnt in der Regel mit einem automatischen Arbeitsschritt, in dem alle Bilder nach festen Algorithmen analysiert werden. Anschließend werden die Ergebnisse in einem manuellen Schritt überprüft und gegebenenfalls korrigiert. Abschließend werden in einem weiteren automatischen Schritt zugeschnittene Derivate der Ausgangsbilder erzeugt, üblicherweise innerhalb des Derivate-Ordners im entsprechenden Goobi-Vorgang.

Die automatischen Arbeitsschritte (Automatische Bildanalyse und Automatisches Croppen) finden in aller Regel ausgelagert in einem TaskManager-Plugin statt, um andere Arbeiten innerhalb von Goobi nicht durch eine hohe Rechenlast auf dem Goobi-Server einzuschränken. Aber auch eine Ausführung ohne TaskManager-Plugin ist möglich, so dass diese automatische Arbeitsschritte innerhalb von Goobi Step Plugins ohne eigenen Nutzeroberfläche unmittelbar innerhalb von Goobi workflow erfolgen.

Die manuelle Kontrolle der Analyseergebnisse mit dem Vorschlag für das Croppen erfolgt innerhalb eines eigenständigen Goobi Step Plugins mit Nutzeroberläche, so dass dessen Bedienung vollständig in Goobi workflow integriert ist.

Je nach individueller Installation von Goobi workflow und der jeweiligen Workflows können die einzelnen Arbeitsschritte natürlich individuell benannt werden. Im folgenden Screenshot wurden für die drei nacheinander folgenden Arbeitsschritte beispielsweise andere Namen vergeben:

Details zur Bildanalyse

Die Bildanalyse des LayoutWizzard arbeitet in mehreren Phasen, um ausgehend von dem originalen Bild zu dem gewünschten Bildderivat zu gelangen. Hierzu durchläuft jedes Bild eine Bildanalyse, in der die Seiten ausgerichtet, das Objekt erkannt und die Buchfalz ermittelt wird. Die Bildanalyse besteht entsprechend zumeist aus den folgenden Phasen:

In der Dateiliste im unteren Bereich sind sämtliche Bilddateien im Eingabeordner mit ihrem Dateinamen aufgelistet. Ein Klick auf einen der Dateinamen öffnet das jeweilige Bild in der Einzelseitenansicht.

Der Dateiname ist ganz oder teilweise grün hinterlegt, wenn bereits Analyseschritte für das Bild abgeschlossen sind. Sind noch gar keine Analyseschritte abgeschlossen, ist der Dateiname komplett weiß hinterlegt. Für jeden abgeschlossenen Analyseschritt füllt sich der Hintergrund grün, und ist komplett grün hinterlegt, wenn sämt Analyseschritte abgeschlossen sind.

Bitte beachten Sie, dass das automatische Speichern nur dann erfolgreich durchlaufen kann kann, wenn alle Bilder komplett grün hinterlegt sind. In der Dateiliste lassen sich dafür schnell diejenigen Bilder identifizieren, die noch bearbeitet werden müssen, bevor der aktuelle Workflowschritt abgeschlossen werden kann.

Im Bereich Ordner- und Dateioptionen können globale Einstellungen zur Handhabung der Dateien getätigt werden. Außerdem lässt sich von hier aus der komplette LayoutWizzard-Workflow zurücksetzen.

Umschaltung zwischen den Anzeigemodi

Innerhalb der Übersicht kann links oben der Modus für die Anzeige umgeschaltet werden. Üblicherweise öffnet sich der LayoutWizzard im normalen Modus. Hier sind die wichtigsten Einstellungen bereits direkt bearbeitbar. Sollen hingegen die erweiterten Einstellungsoptionen angezeigt werden, so kann der erweiterte Modus aktiviert werden. Eine Umschaltung zwischen den beiden Anzeigemodi ist mit der Nutzung dieses Buttons in der Titelleiste möglich:

Normaler Modus

Folgende Optionen sind im Bereich des normalen Anzeigemodus verfügbar.

Seitenmodus

Der Seitenmodus dient für die Festlegung der Seitenverarbeitung in rechte, linke, Doppel- oder Einzelseiten. Jeder Modus setzt die Ausrichtung für alle Bilder einmalig fest. Spätere Änderungen der Ausrichtung einzelner Seiten ändern die Ausrichtung aller Folgeseiten wie vom Seitenmodus vorgegeben. Der interne Name innerhalb der nachfolgenden Tabelle ist derjenige, wie er in der LayoutWizzard-Konfigurationsdatei für den Seitenmodus verwendet wird.

Schreibrichtung

Die Einstellung für die Schreibrichtung legt fest, in welche Richtung der Textfluss erfolgt. Ist die Schreibrichtung Rechts-nach-Links ist beim alternierenden Seitenmodus die erste Seite nach dem Einband eine rechte Seite. Ist die Schreibrichtung hingegen Links-nach-Rechts, so ist die erste Seite nach dem Einband eine linke Seite. Im Falle des Doppelseitenmodus wird der jeweilige Teil der Doppelseite in der entsprechenden Reihenfolge vor dem anderen Teil der Doppelseite als eigene Datei gespeichert.

Verwerfen und neu Anfangen

Mit dem Button Verwerfen und neu anfangen können alle LayoutWizzard-Daten für diesen Vorgang gelöscht werden. Dies betrifft sowohl alle Analysedaten als auch die für diesen Vorgang spezifische Konfiguration. Nach dem Klick auf diesen Button öffnet sich ein Menü, um darin die gewünschte Vorlage für die neue Konfiguration auszuwählen. Ein anschließender Klick auf OK verwirft alle bisherigen Daten und erstellt eine neue Konfiguration für den Vorgang aufgrund des ausgewählten Templates.

Erweiterter Modus

Die folgenden Optionen sind nur im erweiterten Modus verfügbar.

Eingabe-Ordner

Der Eingabe-Ordner definiert denjenigen Ordner innerhalb des images-Ordners des Goobi-Vorgangs, aus dem die Originalbilder gelesen werden. Dies ist üblicherweise der Ordner mit den Master-Digitalisaten.

Ausgabe-Ordner

Der Ausgabe-Ordner legt denjenigen Ordner innerhalb des images-Ordners des Goobi-Vorgangs fest, in den die gecroppten Derivate gespeichert werden sollen. Dies ist zumeist der Derivate-Ordner.

Komprimierung der Ausgabebilder

Mit dieser Option kann festgelegt werden, wie die Kompression der Bilder erfolgen soll, die nach dem Croppen entstanden sind. Grundsätzlich werden die Derivate im Tiff-Format gespeichert. Hier kann jedoch angegeben werden, ob die Bilder innerhalb des Tiff-Containers mit einer JPEG-Kompression komprimiert werden sollen.

Ausreißer markieren

Bei Ausreißern handelt es sich um Bilder, die in der Analyse auffällig andere Werte aufweisen als die maximal 12 Bilder vor und nach ihnen. Ebenso handelt es sich um Ausreißer bei Bildern, deren Analyse aufgrund von Fehlern oder Zeitüberschreitungen nicht abgeschlossen werden konnte. Ausreißer werden in der Dateiliste rot dargestellt und in der Vorschauansicht von einem roten Rahmen umgeben.

Folgende Ausreißertypen werden unterschieden und können als zu markieren ausgewählt werden:

Zuschneidebereiche anpassen

Wenn rechte und linke Bilder einzeln gescannt werden und sie dennoch in einer Doppelseitenansicht zusammenpassen sollen, kann der LayoutWizzard Seiten so zuschneiden, dass der Inhalt jeweils auf gleicher Höhe beginnt, so dass der obere Buchrand auf allen Seiten möglichst bündig ist. Zu beachten ist hierbei jedoch, dass es je nach Aufnahme oft nicht möglich ist, zwei Seiten komplett ohne Verzerrungen bündig zu schneiden. Für eine optimale Doppelseitendarstellung ist daher immer auch ein Doppelseitenscan anstelle dieser Option zu empfehlen.

Die Speicheransicht zeigt das Bild in der Regel so, wie das zugeschnittene Derivat gespeichert wird. Eine Ausnahme davon sind Bilder mit Doppelseitenausrichtung. Diese werden als ein einziges Bild angezeigt, also ohne Teilung an der Falzlinie.

Im erweiterten Modus kann man den Ordner, in den die Bilder gespeichert werden, festlegen. Der hier angegebene Pfad ist immer ein Unterordner des images Ordner des Goobi-Vorgangs. Außerdem sind mehrere Optionen zum direkten Speichern der Bilder verfügbar:

Der Bereich der Arbeitsschritte enthält eine Liste aller konfigurierten Analyseschritte. Diese werden jeweils mit mehreren Schaltflächen aufgelistet.

Unterhalb der Analysephasen enthält der Bereich folgende weiteren Optionen:

Dieser Bereich ist nur sichtbar wenn ein Analyseschritt ausgewählt wurde und ist dann benannt nach dem jeweiligen Schritt. Er enthält für jeden Schritt Konfigurationsparameter, die die automatische Analyse dieses Schrittes für alle Bilder bestimmen. Die wichtigsten Parameter sind direkt sichtbar, alle weiterem nur in der erweiterten Ansicht. Hilfestellungen zur Bedeutung jedes Parameters werden beim Klick auf Hilfetexte einblenden in der Goobi-Kopfleiste angezeigt.

Unterhalb der Parameter verfügt dieser Bereich außerdem über drei Buttons, die die Ausführung der Analyse regeln:

Der LayoutWizzard-Workflow in Goobi besteht in aller Regel aus mehreren Goobi-Workflow Schritten die zusammenarbeiten. Ein typischer LayoutWizzard Workflow als Teil eines Goobi-Workflows kann dabei zum Beispiel wie folgt aussehen:

Im ersten Schritt (in diesem Beispiel Automatic Image Analysis) findet eine automatische Layoutanalse der Bilder zur Prüfung der Rotation, des Inhaltsbereichs sowie zur Position der Buchfalz statt. Dies geschieht üblicherweise in einem externen TaskManager, um die Systemressourcen von Goobi zu entlasten. Im zweiten Schritt (in diesem Beispiel LayoutWizzard) erfolgt dann eine manuelle Überprüfung und gegebenenfalls eine Korrektur der analysierten Ergebnisse. Diese Bearbeitung erfolgt innerhalb einer eigenen Nutzeroberfläche, die als Goobi-Plugin installiert wurde. Sobald diese manuelle Überprüfung dann abgeschlossen wurde, findet die automatische Speicherung (hier benannt als Automatic Image Cropping) der zugeschnittenen Derivate statt, auf Basis der zuvor analysierten und eventuell angepassten Daten. Auch diese Speicherung findet üblicherweise innerhalb des TaskManagers statt.

Datenhaltung

Da die einzelnen Workflow-Schritte des LayoutWizzards auf einem gemeinsamen Datenbestand an Konfigurations- und Analysedaten arbeiten, müssen die Daten zumindest für die Dauer des LayoutWizzard Workflows persistent vorgehalten werden. Dies geschieht in der Datei imageData.xml im Goobi-Vorgangsordner. Beispielhaft lautet ein solcher vollständiger Pfad zu dieser Datei entsprechend:

/opt/digiverso/goobi/metadata/1234/imageData.xml

Diese Datei enthält sämtliche Konfigurationseinstellungen für den entsprechenden Vorgang sowie die Analysedaten zu jedem Bild, aus denen im abschließenden Speicherschritt die Derivate erstellt werden.

Die Konfigurationsdatei des Goobi Step Plugins, das die Nutzeroberfläche für den LayoutWizzard darstellt, muss im config Verzeichnis der Goobi-Installation liegen. Ihr Dateiname lautet in aktuellen Goobi-Versionen plugin_intranda_step_LayoutWizzard.xml.

Üblicherweise lautet der vollständige Pfad zu dieser Konfigurationsdatei wie folgt:

/opt/digiverso/goobi/config/plugin_intranda_step_LayoutWizzard.xml

Der Inhalt dieser Konfigurationsdatei ist folgendermaßen aufgebaut:

<config_plugin>
  <config>
    <project>*</project>
    <step>*</step>
    <layout-wizzard-config-path>
        /opt/digiverso/LayoutWizzard/layoutwizzard_config.xml
    </layout-wizzard-config-path>
    <startPage>PREVIEW</startPage>
	  <!--<startPage>SINGLEVIEW</startPage>-->
    <previewMode>ALTERNATING</previewMode>
    <contentBorder>
        <width>2</width>
        <color>#00fa9a</color>
        <opacity>1</opacity>
    </contentBorder>
    <spineMarker>
        <outer>
            <linewidth>20</linewidth>
            <linecolor>#D73946</linecolor>
            <opacity>0.1</opacity>
        </outer>
        <inner>
            <linewidth>2</linewidth>
            <linecolor>#ff0000</linecolor>
            <opacity>1</opacity>
        </inner>
    </spineMarker>
	<preview>
		<cropFrame>
			<linewidth>2</linewidth>
	        <linecolor>#44ffdd</linecolor>
	        <fillcolor>#f1f2f3</fillcolor>
	        <clickradius>20</clickradius>
		</cropFrame>
		<spineMarker>
			<linewidth>2</linewidth>
	        <linecolor>#ff3344</linecolor>
	        <clickradius>20</clickradius>
		</spineMarker>
	</preview>
    <previewCroppingOptions>
        <show>true</show>
    </previewCroppingOptions>
    <previewOrientationSelect>
        <show>false</show>
    </previewOrientationSelect>
    <globalCroppingOptions>
        <show>true</show>
        <unit>mm</unit>
        <keyboardControls use="true">
            <moveMaskKey>SHIFT</moveMaskKey>
            <moveMaskKey>CTRL</moveMaskKey>
            <resizeMaskKey>SHIFT</resizeMaskKey>
            <stepSize>0.1</stepSize>
        </keyboardControls>
    </globalCroppingOptions>
    <info show="true">
        <spine>
            <format>Falz: {f}{u}</format>
        </spine>
    </info>
  </config>
</config_plugin>

ACHTUNG: Bitte beachten Sie, dass hier der korrekte Pfad zur Konfigurationsdatei des LayoutWizzards innerhalb des Elements<layout-wizzard-config-path> angegeben ist.

Dieser Bereich ist nur verfügbar, wenn der Schritt Seite zuschneiden ausgewählt ist und diese Option in der Konfiguration aktiviert ist. Er zeigt die Position und Größe des Zuschneiderahmens für das aktuelle Bildes an. Die Anzeige erfolgt in Millimetern oder einer anderen konfigurierbaren Maßeinheit. Die hier dargestellten Werte sind direkt editierbar und bleiben stets synchron mit dem Rahmen in der Bildanzeige.

Zusätzlich verfügt dieser Bereich über Buttons, um die Größe und Position des aktuellen Rahmens auf andere Bilder zu übertragen:

Programmbibliotheken

Die Installation besteht aus insgesamt vier Programmbibliotheken, die im Apache Tomcat bzw. in Goobi erreichbar sein müssen:

Konfigurationsdateien

Neben diesen Programmdateien werden zwei Konfigurationsdateien benötigt, eine für das Goobi-Plugin, und eine für die zugrundeliegende LayoutWizzard-Programmbibliothek.

Plugin-Konfiguration

Die Konfigurationsdatei des Plugins plugin_LayoutWizzardPlugin.xml muss im Konfigurationsverzeichnis config innerhalb des Goobi-Arbeitsverzeichnisses liegen. Üblicherweise handelt es sich hierbei um diesen Pfad zur Datei:

/opt/digiverso/goobi/config/plugin_LayoutWizzardPlugin.xml

Innerhalb dieser Konfigurationsdatei wird der Pfad zur eigentlichen zentralen Konfiguration des LayoutWizzards angegeben. Der Aufbau dieser Datei sieht dabei folgendermaßen aus:

<!-- Goobi Plugin configuration file -->
<config_plugin>
	<config>
		<!-- which projects to use for (can be more then one, otherwise use *) -->
        <project>*</project>
        <!-- which steps to use for (can be more then one, otherwise use *) -->
        <step>*</step>
        
        <!-- The absolute path to the layoutwizzard_config.xml to use -->
	    <layout-wizzard-config-path>
	        /opt/digiverso/LayoutWizzard/layoutwizzard_config.xml
	    </layout-wizzard-config-path>
	    
	    <!-- The initial view of the LayoutWizzard Plugin. Can be one of
	    	* PREVIEW: The preview page of the plugin, displaying all pages in a vertical list
	    	* SINGLEVIEW: The single view page of the plugin, displaying all settings and the first page
	    	* SIMPLECROP: A zoomable cropping view for processes with few large images. Does not support spne cropping-->
	    <startPage>PREVIEW</startPage>
	    
	    <!-- The initial viewing mode if the PREVIEW view. One of 
	    	* ALTERNATING to see only left/right images per page
	        * DOUBLE_PAGE to see opposite pages next to each other -->
	    <previewMode>ALTERNATING</previewMode>
	    
	    <!-- Config for appearance of single/large image -->
		<singleImage>
			<!-- Config for frame around the crop area -->
			<cropFrame>
				<!-- Thickness of frame -->
				<linewidth>2</linewidth>
				<!-- Color of frame -->
				<linecolor>#00fa9a</linecolor>
				<!-- Radius around the frame in which the frame can be selected for drag/resize -->
				<clickradius>20</clickradius>
				<!-- The color filling the area outside the crop frame in the Save View -->
				<fillcolor>#ffffff</fillcolor>
			</cropFrame>
			<!-- Config for line marking the spine position -->
			<spineMarker>
				<!-- Thickness of line -->
				<linewidth>2</linewidth>
				<!-- Color of line -->
				<linecolor>#ff0000</linecolor>
				<!-- Radius around the line in which the line can be selected for dragging -->
				<clickradius>20</clickradius>
			</spineMarker>
		</singleImage>
	    <!-- Config for appearance of images in preview mode -->
		<preview>
			<!-- Config for frame around the crop area -->
			<cropFrame>
				<!-- Thickness of frame -->
				<linewidth>2</linewidth>
				<!-- Color of frame -->
				<linecolor>#00fa9a</linecolor>
				<!-- Radius around the frame in which the frame can be selected for drag/resize -->
				<clickradius>20</clickradius>
				<!-- The color filling the area outside the crop frame in the Save View -->
				<fillcolor>#f1f2f3</fillcolor>
			</cropFrame>
			<!-- Config for line marking the spine position -->
			<spineMarker>
				<!-- Thickness of line -->
				<linewidth>2</linewidth>
				<!-- Color of line -->
				<linecolor>#ff0000</linecolor>
				<!-- Radius around the line in which the line can be selected for dragging -->
				<clickradius>20</clickradius>
			</spineMarker>
		</preview>
		
		<!-- Display cropping control elements in preview mode -->
	    <previewCroppingOptions>
	        <show>true</show>
	    </previewCroppingOptions>
	    
	    <!-- Display the option to select page orientation in preview mode (may be prone to errors) -->
	    <previewOrientationSelect>
	        <show>false</show>
	    </previewOrientationSelect>
	    
	    <!-- Options for Global cropping options  -->
	    <globalCroppingOptions>
	    	<!-- Display Global cropping options in single page mode -->
	        <show>true</show>
	        <!-- Unit to display crop frame coordinates in. One of
	        	* μm
	        	* mm
	        	* cm
	        	* in -->
	        <unit>mm</unit>
	        <!-- Settings for keyboard controls of crop frame. set use="true" to allow changing crop frame using keyboard shortcuts -->
	        <keyboardControls use="true">
	        	<!-- Key(s) to keep pressed when moving the frame. Can be SHIFT, CTRL or ALT -->
	            <moveMaskKey>SHIFT</moveMaskKey>
	            <moveMaskKey>CTRL</moveMaskKey>
	        	<!-- Key(s) to keep pressed when resizing the frame. Can be SHIFT, CTRL or ALT -->
	            <resizeMaskKey>SHIFT</resizeMaskKey>
	            <!-- Amount of units (see above) to move the frame for each key press event -->
	            <stepSize>0.1</stepSize>
	        </keyboardControls>
	    </globalCroppingOptions>
	    
	    <!-- Display information about the the cropping/deskewing value of the current step -->
	    <info show="true">
	    	<!-- Display format for spine location. {f} is a floating number, {u} the appropriate unit -->
	        <spine>
	            <format>Falz: {f}{u}</format>
	        </spine>
	    </info>
    </config>
</config_plugin>

LayoutWizzard-Konfiguration

Die eigentliche Konfigurationsdatei gibt für den Vorgang der Layoutanalyse verschiedene Parameter vor. Diese Parameter sind beispielhaft in der folgenden Konfigurationsdatei aufgeführt. Sie befindet sich, wie in der Plugin-Konfigurationsdatei definiert, unter folgendem Pfad:

/opt/digiverso/intranda/LayoutWizzard/layoutwizzard_config.xml

Beispielhaft hat diese Konfigurationsdatei den folgenden Inhalt:

<!-- intranda Layout Wizzard configuration file -->
<config>
    <contentServerUrl>http://demo03.intranda.com/goobi/cs/cs</contentServerUrl>
    <defaultOutputFolderSuffix>media</defaultOutputFolderSuffix>
    <analysisImagesBasePath>/home/florian/LayoutWizzard/samples/</analysisImagesBasePath>
    <previews>
        <previewsPerPage>100</previewsPerPage>
        <maxPreviewsCached>10000</maxPreviewsCached>
        <previewWidth>700</previewWidth>
        <imageHeightLarge>800</imageHeightLarge>
    </previews>
    <outliers>
        <errorMultiplier>3.0</errorMultiplier>
        <weightExponent>2.0</weightExponent>
    </outliers>
    <saving>
        <defaultCompression quality="85">NONE</defaultCompression>
        <overwriteExistingImages>true</overwriteExistingImages>
    </saving>
    <analysis id="firstPageLeft">
        <firstPageOrientation>LEFT</firstPageOrientation>
    </analysis>
    <analysis id="firstPageRight">
        <firstPageOrientation>RIGHT</firstPageOrientation>
    </analysis>
    <analysis>
        <analysisStep name="PAGESKEW" type="edges" use="true">
            <saveAnalysisImages visibility="INVISIBLE" path="DESKEW">false</saveAnalysisImages>
            <deskewerMode visibility="VISIBLE">ALL_EDGES</deskewerMode>
            <lineFinderMode>CONTOURS</lineFinderMode>
            <lineGroupingMode>GROUP_BY_DISTANCE</lineGroupingMode>
            <featureSizeThreshold>10.0</featureSizeThreshold>
            <analysisImageSize>300</analysisImageSize>
            <lowerCannyThreshold>70</lowerCannyThreshold>
            <cannyRatio>2</cannyRatio>
            <distanceResolution>1</distanceResolution>
            <angleResolution>1</angleResolution>
            <minHoughLineLength>10</minHoughLineLength>
            <houghLineThreshold>50</houghLineThreshold>
            <maxHoughLineGapSize>2</maxHoughLineGapSize>
            <maxLineAngleDeviation>5</maxLineAngleDeviation>
            <maxLineDistance>7</maxLineDistance>
            <rimAreaToIgnoreLines>0.0</rimAreaToIgnoreLines>
        </analysisStep>
        <analysisStep name="CONTENTAREA" use="true">
            <analysisImageSize>0</analysisImageSize>
            <saveAnalysisImages visibility="INVISIBLE" path="edgeDetection">false</saveAnalysisImages>
            <bitonalThreshold>150</bitonalThreshold>
            <bitonalInvert>false</bitonalInvert>
            <featureSizeThreshold>10.0</featureSizeThreshold>
            <contentPadding visibility="VISIBLE">0</contentPadding>
        </analysisStep>
        <analysisStep name="BOOKSPINE" use="true">
            <analysisImageSize>400</analysisImageSize>
            <saveAnalysisImages visibility="INVISIBLE" path="spineDetection">false</saveAnalysisImages>
            <lineFinderMode>CONTOURS</lineFinderMode>
            <lineGroupingMode visibility="INVISIBLE">GROUP_BY_DISTANCE</lineGroupingMode>
            <croppingAggressiveness visibility="VISIBLE">BALANCED</croppingAggressiveness>
            <lowerCannyThreshold>40</lowerCannyThreshold>
            <cannyRatio>2</cannyRatio>
            <distanceResolution>1</distanceResolution>
            <angleResolution>1</angleResolution>
            <minHoughLineLength>20</minHoughLineLength>
            <houghLineThreshold>10</houghLineThreshold>
            <maxHoughLineGapSize>4</maxHoughLineGapSize>
            <maxLineAngleDeviation>5</maxLineAngleDeviation>
            <maxLineDistance>5</maxLineDistance>
            <featureSizeThreshold>0.1</featureSizeThreshold>
            <rimAreaToIgnoreLines>0.0125</rimAreaToIgnoreLines>
            <maxGroupAngleDeviation visibility="INVISIBLE">10</maxGroupAngleDeviation>
            <spineOffset visibility="VISIBLE">5</spineOffset>
        </analysisStep>
    </analysis>
</config>

Details über die Anpassung der Konfigurationen finden sich im Abschnitt zur Konfiguration.

Da die Installation, Konfiguration sowie die technische Arbeitsweise umfangreichere Erläuterungen benötigen, sind diese in jeweilig einzelnen Kapiteln dieser Dokumentation beschrieben. Folgende Kapitel zu den technischen Details stehen zur Verfügung:

Die zentrale Konfiguration des LayoutWizzards findet in einer eigenständigen Konfigurationsdatei statt. Diese kann an einem beliebigen Ort im Dateisystem liegen, da ihr Pfad in jedem Programmbestandteil des LayoutWizzards angegeben werden kann. Üblicherweise lautet der Pfad zu dieser zentralen Konfigurationsdatei folgendermaßen:

Der Inhalt einer solchen Konfiguration sieht beispielhaft wie folgt aus:

Die Konfiguration besteht aus einigen allgemeinen Einstellungen und mehreren <analysis>Blöcken. Die <analysis> Blöcke regeln im Wesentlichen die Einstellungen für die automatische Analyse. Verschiedene Projekte oder Vorgänge können dabei unterschiedliche Einstellungen verwenden, indem Sie der automatischen Analyse die id des <analysis> Blocks übergeben.

Allgemeine Einstellungen betreffen immer alle Vorgänge und werden auch nicht durch vorgangsspezifische Einstellungen überschrieben.

Allgemeine Einstellungen

Die folgende Liste an allgemeinen Konfigurationspfaden ist nicht vollständig. Sie enthält jedoch alle Konfigurationen die individuell für eine Installation angepasst werden müssen.

Analysis-Konfiguration

Jeder <analysis> Block hat ein Attribut id, das regelt, welcher Block für eine bestimmte Analyse verwendet wird. Der letzte Block muss die id="default" haben. Einstellungen aus diesem Block werden immer verwendet, wenn einem Analyseaufruf keinen Analyse-Id übergeben wird, oder wenn eine Einstellung nicht im eigentlich verwendeten Block konfiguriert ist. Alle anderen Blöcke bestehen entsprechend aus der Teilmenge an Konfigurationen, die von der default-Konfiguration abweichen.

Folgende Einstellungen können in jedem <analysis> Block existieren:

Die Einstellungen in den <analysisStep> Blöcken betreffen spezifische Parameter der Analyse-Algorithmen. Sie werden hier nicht weiter beschrieben. Benutzer können jedoch in der Oberfläche potentiell jeden Parameter anpassen. Sollten sich so vorgenommene Einstellungen genug bewähren, um in die Konfiguration übernommen zu werden, kann der entsprechende Block in der Konfigurationsdatei auf den neuen Wert gesetzt werden. Der passende Parameter-Block kann hierbei ermittelt werden, indem der <analysisStep> zum jeweiligen Analyse-Schritt in der Konfigurationsdatei herausgefunden und dort der Block mit dem internen Parameternamen geändert wird. Der interne Parametername wird in der Oberfläche als Tooltip angezeigt, wenn der Mauszeiger über das Label des veränderten Parameters gehalten wird.

Zusätzlich können alle Analyse-Parameter-Blöcke das Attribut visibility besitzen, das die Sichtbarkeit des Parameters in der Oberfläche regelt. Fehlt dieses Attribut wird der default-Wert HIDDEN verwendet.