Bilder validieren

Note

Verfügbar ab Kitodo.Production 3.9.0

Kitodo.Production kann sowohl Originaldateien als auch Derviate automatisiert auf bestimmte Merkmale hin überprüfen. Dies kann entweder als Teil einer Aufgabe des Typs "Bilder validieren" geschehen, oder nach dem Upload einer Datei im Metadateneditor. Um festzulegen, welche Dateien auf welche Merkmale geprüft werden sollen, müssen zunächst Validierungskonfigurationen angelegt und einem oder mehreren Ordnern zugewiesen werden. Mit einem Klick auf "Bilder validieren" werden alle Dateien aller Unterordner eines Vorgangs validiert. Im Anschluss erscheint ein Dialog über den Erfolg oder Misserfolg der Validierung.

LZA Validierungskonfigurationen anlegen

Eine Validierungskonfiguration entscheidet darüber, welche Prüfkriterien auf eine Datei angewendet werden. Sie können eine Konfiguration im Bereich Projekte mit einem Klick auf Neu und Neue LZA Validierungskonfiguration hinzufügen.

Ein eingeloggter Nutzer kann die Validierungskonfigurationen nur einsehen und bearbeiten, wenn er die passenden Berechtigungen besitzt:

• Alle LZA Validierungskonfigurationen anzeigen - ob die Liste der Konfigurationen einsehbar ist
• LZA Validierungskonfiguration anzeigen - ob die Details einer Konfiguration einsehbar sind
• LZA Validierungskonfiguration bearbeiten - ob die Konfiguration geändert werden darf
• LZA Validierungskonfiguration hinzufügen - ob neue Konfigurationen hinzugefügt werden dürfen
• LZA Validierungskonfiguration löschen - ob eine Konfiguration entfernt werden darf

Eine Validierungskonfiguration besteht aus den folgenden Informationen:

• Titel - eine allgemeine Beschreibung der Konfiguration
• Dateityp - der Dateityp bzw. das Dateiformat der Dateien, die geprüft werden sollen
• Ob das Abschließen einer Aufgabe verhindert werden soll, falls bei der Validierung ein Fehler auftritt
• Ob das Hochladen einer neuen Datei verhindert werden soll, falls bei der Validierung ein Fehler auftritt
• eine Liste von Prüfkriterien

Die Liste der Prüfkriterien entscheidet, welche Dateimerkmale einen schwerwiegenden Fehler implizieren und welche Merkmale eine optionale Warnung auslösen sollen. Die genauen Prüfkriterien hängen vom Dateiformat ab. Je nach Format können verschiedene Kriterien geprüft werden. Aktuell werden die folgenden Dateitypen unterstützt:

• TIFF - mithilfe von JHove
• JPEG - mithilfe von JHove
• JPEG 2000 - mithilfe von JHove
• GIF - mithilfe von JHove
• PDF - mithilfe von JHove

Prüfkriterien für die Validierung mit JHove

Die Software JHove ist in der Lage, verschiedene Dateitypen zu validieren und Dateimerkmale zu extrahieren. Die von JHove extrahierten Dateimerkmale können dann durch Hinzufügen passender Prüfkriterien kontrolliert werden.

Für alle von JHove unterstützten Dateiformate stehen die folgenden Eigenschaften zur Verfügung:

• wellFormed - ob eine Datei den syntaktischen Anforderungen an das Dateiformat entspricht (mögliche Werte sind true, false oder undetermined)
• valid - ob eine Datei syntaktisch korrekt ist und zusätzliche semantische Anforderungen des Dateiformats erfüllt (mögliche Werte sind true, false oder undetermined)

Des Weiteren können Dateityp-spezifische Merkmale geprüft werden. Dafür müssen Sie zunächst identifizieren, wie die Merkmale von JHove genannt werden. Installieren Sie JHove auf Ihrem PC, starten Sie die Anwendung jhove-gui, wählen Sie den passenden Dateityp im Menü aus (siehe Configuration - Select Module) und öffnen Sie dann eine Mediendatei. Es erscheinen die extrahierten Dateimerkmale vergleichbar zu folgendem Beispiel:

Aufgrund der Komplexität der extrahierten Dateimerkmale und deren hierarchischer Struktur können leider nicht alle Merkmale in Kitodo.Production verwendet werden. Zur Vereinfachung werden die Merkmale allein anhand des tiefst liegenden Namens der Eigenschaft identifiziert. Das Merkmal RepInfo.TIFFMetadata.IFDs.IFD.Entries.NisoImageMetadata.ColorSpace wird also nur anhand des Namens ColorSpace in Kitodo.Production identifiziert. Sollte eine Datei mehrere Merkmale des gleichen Namens in verschiedenen Hierarchieebenen enthalten, so ist der Wert des Merkmals unbestimmt und kann je nach Verarbeitungsreihenfolge den einen oder anderen Wert annehmen.

Folgende Merkmale sind vermutlich häufig relevant:

• Version - die Version der Tiff-Spezifikation mit Werten 4, 5, 6
• ColorSpace - der Farbraum des Tiff-Bildes mit Werten wie RGB, CMYK, YCbCr, transparency mask
• ImageWidth - die Breite des Bildes
• ImageLength - die Höhe des Bildes

Einige Bildmerkmale der NISO-Spezifikation sind im Datenformat "Rational" abgespeichert. Das heißt, eine rationale Zahl wird als Bruch mit Zähler und Nenner gespeichert, z.B. 30000 (Zähler) / 100 (Nenner). Um die Prüfung dieser Merkmale zu vereinfachen, werden die Werte auch als ganze Zahl und Gleitkommazahl zur Verfügung gestellt, falls diese berechenbar sind (Nenner != 0). Die passenden Bildmerkmale sind mit dem Suffix _long (ganze Zahl) und _double (Gleitkommazahl) versehen. Die Eigenschaft XSamlingFrequency wird also auch als XSamlingFrequency_long und XSamlingFrequency_double bereitgestellt.

Einige Bildmerkmale der NISO-Spezifikation sind als Liste bzw. Array abgespeichert. Vergleichswerte für Listen können im Schema [Wert1, Wert2, Wert3] angegeben werden. Für das Bildmerkmal BitsPerSample könnte z.B. [16, 16, 16, 16] angegeben werden, um zu prüfen, dass das Bild in 4-Channeln zu je 16bit kodiert ist.

Hinzufügen eines Prüfkriteriums

Basierend auf den von JHove extrahierten Dateimerkmalen können verschiedenste Prüfkriterien definiert werden.

Bestimmen Sie dazu die folgenden Angaben:

• Eigenschaft - der Name des Dateimerkmals, z.B. valid, ColorSpace (Groß- und Kleinschreibung wird ignoriert)
• Vergleichsoperation - die angewendete Prüfoperation, z.B.
  • ist exakt - prüft, ob das extrahierte Merkmal exakt dem angegebenen Wert entspricht
  • eines von - prüft, ob das extrahierte Merkmal einem der angegebenen Werten entspricht
  • keines von - prüft, dass das extrahierte Merkmal keines der angegebenen Werten entspricht
  • nicht leer - prüft, ob das extrahierte Merkmal irgendeinen nicht-leeren Wert hat
  • größer als - prüft, ob das extrahierte Merkmal eine Zahl und größer als die angebene Zahl ist (oder gleich, >=)
  • kleiner als - prüft, ob das extrahierte Merkmal eine Zahl und kleiner als die angebene Zahl ist (oder gleich, <=)
  • im Interval von - prüft, ob das extrahierte Merkmal eine Zahl ist und im Intervall der zwei angegebenen Zahlen liegt (inklusive der Grenzen)
  • passt zu - prüft, ob das extrahierte Merkmale zu dem angegebenen regulären Ausdruck passt (siehe Dokumentation, ohne Berücksichtigung von Groß- und Kleinschreibung)
• Vergleichswerte - die Werte, die zur Prüfung herangezogen werden
• Schweregrad - der Schweregrad, falls das Prüfkriterium nicht erfüllt ist
  • Fehler - das Nichteinhalten des Prüfkriteriums zählt als Fehler und unterbricht je nach Einstellung das Abschließen einer Aufgabe oder das Hochladen einer Datei
  • Warnung - das Nichteinhalten des Prüfkriteriums hat keine weiteren Auswirkungen, aber wird dem Nutzer angezeigt

Dateinamen prüfen

Zur Prüfung des Dateinamens wird zusätzlich zu den extrahierten Eigenschaften auch der Dateiname der Datei inklusive Dateiendung (z.B. 00000001.tif) unter der Eigenschaft filename bereitgestellt. Mithilfe der Vergleichsoperation passt zu können Sie damit prüfen, dass der Dateiname einem bestimmten Muster folgt (ohne Berücksichtigung der Groß- und Kleinschreibung).

Das Muster muss als regulärer Ausdruck angegeben werden (siehe Dokumentation). Typische Muster für Dateinamen könnten z.B. sein:

• ^\d{8}\.tif$ - 8-stellige Zahl mit Tif-Dateiendung (die Reihenfolge wird nicht geprüft)
• ^.*\.tif$ - eine beliebiger Dateiname mit Tif-Dateiendung
• ^image-\d+\.jpg$ - erlaubt die Dateien image-1.jpg, image-2.jpg, ... image-101.jpg, usw.

LZA Validierungskonfigurationen zuordnen

Eine Validierungskonfiguration kann einem oder mehreren Ordnern eines Projekts zugeordnet werden. Sie können die Zuordnung auf der Seite Projekt bearbeiten im Tab METS Parameter im Dialog Unterordner bearbeiten vornehmen.

Folgende Optionen stehen zur Verfügung:

• Inhalt validieren - ob die Validierung grundsätzlich stattfindet
• LZA Validierungskonfiguration - die Konfiguration, die angewendet werden soll

Es werden nur Validierungskonfigurationen aufgelistet, die dem Dateityp des Unterordners entsprechen. Ist die Option Inhalt validieren aktiv, aber keine Konfiguration ausgewählt, findet keine inhaltsbezogene Validierung statt. Aus historischen Gründen steuert diese Option jedoch auch, ob eine Prüfung der Dateinamen stattfindet, falls in der Kitodo-Konfiguration (image.prefix) das Muster für 8-stellige fortlaufende Zahlen (\\d{8}) festgelegt ist.

Validieren der Bilder in einer Aufgabe

Die Bilder eines Vorgangs können in einer Aufgabe validiert werden, wenn für die Aufgabe im Workflow die Eigenschaft Validate Images hinterlegt ist.

Beim Bearbeiten der Aufgabe erscheint dann die Option Bilder validieren.

Nach der Validierung aller Dateien aller Unterordner erscheint ein Bericht mit dem Ergebnis der Validierung.

Es werden nur Fehler oder Warnungen aufgelistet. Dateien, die alle Prüfkriterien erfüllen, werden nicht angezeigt. Um die Anzeige nicht zu überfordern, werden außerdem nur maximal 5 Dateien pro Ordner und maximal 3 Ordner mit Fehlern aufgelistet.

Ist für eine Aufgabe die Eigenschaft Validate on Exit im Workflow aktiv, findet die Validierung auch beim Abschließen der Aufgabe statt, wenn in der Validierungskonfiguration zusätzlich die passende Option Abschließen verhindern ausgewählt ist. Beim fehlerhaften Abschließen einer Aufgabe wird jedoch kein Bericht angezeigt. Es erscheint lediglich die Fehlermeldung zum zuerst gefundenen Problem.

Der Konfigurationsparameter image.prefix

Ist für eine Aufgabe die Eigenschaft Validate on Exit im Workflow aktiv, aber keine Validierungskonfiguration hinterlegt oder die Option Abschließen verhindern deaktiviert, werden trotzdem die Dateinamen geprüft, falls in der Kitodo-Konfiguration das Muster (image.prefix) für 8-stellige fortlaufende Zahlen (\\d{8}) festgelegt ist.

Ist ein anderes Muster als das Muster für 8-stellige fortlaufende Zahlen (\\d{8}) hinterlegt, findet keine Prüfung auf Basis des Konfigurationsparameter image.prefix statt.

Validieren der Bilder nach dem Upload

Ist für den Unterordner, der die Originaldateien enthält, die Option Inhalt validieren und eine Validierungskonfiguration hinterlegt, findet beim Upload neuer Dateien im Metadateneditor eine Validierung statt.

Nachdem die Medien hochgeladen wurden, erscheint das Ergebnis der Validierung in einem Dialog, sollten Fehler oder Warnungen aufgetreten sein. Sind alle hochgeladenen Dateien valide, erscheint kein Dialog.

Ist in der Validierungskonfiguration hinterlegt, dass das Hochladen einer Datei abgebrochen werden soll, falls ein Validierungsfehler auftritt, wird die fehlerhafte Datei automatisch gelöscht und nicht zum Vorgang bzw. zum Metadateneditor hinzugefügt.