update of xsd (adding new "compression"-elements) (#4)

* update "compression-elements" * bump version * add changelog * add link to PR * cosmetic * update
ZEISS · Dec 8, 2023 · 7eaea81 · 7eaea81
1 parent 237474f
commit 7eaea81
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 5 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -5,7 +5,7 @@
 cmake_minimum_required(VERSION 3.15)
 
 project(CZICheck 
-      VERSION 0.1.0
+      VERSION 0.1.1
       HOMEPAGE_URL "https://github.com/ZEISS/czicheck"
       DESCRIPTION "CZICheck is a validator for CZI-documents")
 

diff --git a/CZICheck/checkers/schema/ZEN/flatten/ImageMetadata.xsd b/CZICheck/checkers/schema/ZEN/flatten/ImageMetadata.xsd
@@ -7427,18 +7427,59 @@
           </xs:documentation>
         </xs:annotation>
       </xs:element>
-      <xs:element minOccurs="0" name="OriginalCompressionMethod" type="xs:string">
+      <xs:element name="OriginalCompressionMethod" type="xs:string" minOccurs="0">
         <xs:annotation>
           <xs:documentation>
-            The original compression method used when the file was initially saved.
+            This is an informative text specifying a compression method which is used (at subblock-level) when
+            writing the CZI-document. Note that conceptually, the compression method (and it parametrization) is
+            per subblock, so there is no such thing as a "compression method of the CZI-document". The compression
+            state of each subblock may be different, and it is by no means guaranteed that all subblocks are using
+            the same method or the same parameters.
+            So, this field is meant to give a best effort, global characterization of the compression method used in
+            this document. By its nature, no precise technical assumptions should be based on the content of this field
+            alone.
             Use members of the CompressionMethods type for string content, e.g. "Jpg" or "JpgXr".
           </xs:documentation>
         </xs:annotation>
       </xs:element>
-      <xs:element minOccurs="0" name="OriginalEncodingQuality" type="xs:integer">
+      <xs:element name="OriginalEncodingQuality" type="xs:integer" minOccurs="0">
         <xs:annotation>
           <xs:documentation>
-            The original encoding quality (10..100) used when the file was initially saved and has used a compression method.
+            The original encoding quality (10..100) used when the file was initially saved with compression.
+            Note that this element is mostly present on legacy CZI files. Please refer to the
+            OriginalCompressionParameters element when saving the CZI. The encoding quality can be part of it.
+          </xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="OriginalCompressionParameters" type="xs:string" minOccurs="0">
+        <xs:annotation>
+          <xs:documentation>
+            This is an informative text specifying the compression parameters which were used (at subblock-level) the
+            first time the CZI-document was written. Note that conceptually, the compression parameters are
+            per subblock, so there is no such thing as "compression parameters of the CZI-document". The compression
+            state of each subblock may be different, and it is by no means guaranteed that all subblocks are using
+            the same method or the same parameters.
+            So, this field is meant to give a best effort, global characterization of the compression parameters used in
+            this document. By its nature, no precise technical assumptions should be based on the content of this field
+            alone.
+            The format should be key-value pairs, while each pair is separated with ',' and keys and values are
+            separated with ':', e.g. 'Lossless: False, Quality: 77'.
+          </xs:documentation>
+        </xs:annotation>
+      </xs:element>
+      <xs:element name="CurrentCompressionParameters" type="xs:string" minOccurs="0">
+        <xs:annotation>
+          <xs:documentation>
+            This is an informative text specifying the compression parameters which were used (at subblock-level) the
+            last time the CZI-document was written. Note that conceptually, the compression parameters are
+            per subblock, so there is no such thing as "compression parameters of the CZI-document". The compression
+            state of each subblock may be different, and it is by no means guaranteed that all subblocks are using
+            the same method or the same parameters.
+            So, this field is meant to give a best effort, global characterization of the compression parameters used in
+            this document. By its nature, no precise technical assumptions should be based on the content of this field
+            alone.
+            The format should be key-value pairs, while each pair is separated with ',' and keys and values are
+            separated with ':', e.g. 'Lossless: False, Quality: 77'.
           </xs:documentation>
         </xs:annotation>
       </xs:element>

diff --git a/documentation/version-history.md b/documentation/version-history.md
@@ -0,0 +1,7 @@
+version history                 {#version_history}
+============
+
+ version        |  PR                                                  | comment
+ -------------- | ---------------------------------------------------- | ---------------------------------------------------
+ 0.1.0          |                                                      | initial release
+ 0.1.1          | [4](https://github.com/ZEISS/czicheck/pull/4)        | update of metadata-schema (compression)