documentation

ZEISS · Aug 13, 2024 · d30e89a · d30e89a
1 parent c97cea9
commit d30e89a
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/documentation/description_of_checkers.md b/documentation/description_of_checkers.md
@@ -80,6 +80,8 @@ Some basic checks of the XML-metadata are performed, which is semantically valid
 used in the subblock's coordinates should be listed (as 'Metadata/Information/Image/Size_') and their size should be given correctly.
 * Under 'Metadata/Information/Image/Channels' there should the same number of 'Channel'-elements as there are channels in the subblock-directory.
 * The pixel-type of a channel should be given correctly under 'Metadata/Information/Image/Channels/Channel[]/PixelType'.
+* If the pixel-type is an integer pixel-type (or the pixel-type is unknown), the presence of the element 'ComponentBitCount' is checked for.
+* In case of pixel-type and ComponentBitCount are given, the combination of both is checked for validity.
 
 ### xmlmetadataschema
 

diff --git a/documentation/version-history.md b/documentation/version-history.md
@@ -9,3 +9,4 @@ version history                 {#version_history}
  0.2.0          | [10](https://github.com/ZEISS/czicheck/pull/10)      | add checker "topographymetadata"
  0.2.1          | [11](https://github.com/ZEISS/czicheck/pull/11)      | disallow DTD-processing (prevent XXE-vulnerability)
  0.3.0          | [11](https://github.com/ZEISS/czicheck/pull/15)      | enable strict parsing
+ 0.4.0          | [19](https://github.com/ZEISS/czicheck/pull/19)      | add check for "ComponentBitCount" to basicxmlmetadata-checker