Basic Topography Metadata validations #10
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ptahmose
reviewed
May 3, 2024
ptahmose
reviewed
May 3, 2024
ptahmose
reviewed
May 3, 2024
ptahmose
reviewed
May 3, 2024
ptahmose
reviewed
May 8, 2024
ptahmose
reviewed
May 8, 2024
ptahmose
reviewed
May 8, 2024
ptahmose
reviewed
May 8, 2024
ptahmose
reviewed
May 8, 2024
ptahmose
reviewed
May 8, 2024
m-aXimilian
changed the title
…n class and variable names, and to improve code organization and readability. The class name `CCheckTopgraphyApplianceMetadata` was corrected to `CCheckTopographyApplianceMetadata` in `checkerfactory.cpp` and `checkerTopographyApplianceValidation.cpp` files. The `DimensionView` struct was moved from the global scope to the private scope of the `CCheckTopographyApplianceMetadata` class in `checkerTopographyApplianceValidation.h` for better encapsulation. The variable names `texture_views` and `heightmap_views` were updated to `texture_views_` and `heightmap_views_` to follow the naming convention for private member variables. Here is the list of changes: 1. The class name `CCheckTopgraphyApplianceMetadata` was corrected to `CCheckTopographyApplianceMetadata` in `checkerfactory.cpp` and `checkerTopographyApplianceValidation.cpp` files (spelling correction). 2. The `#include <codecvt>` directive was replaced with `#include <functional>`, `#include <string>`, and `#include <vector>` in `checkerTopographyApplianceValidation.cpp` (library inclusion). 3. The variable names `texture_views` and `heightmap_views` were changed to `texture_views_` and `heightmap_views_` in `checkerTopographyApplianceValidation.cpp` (naming convention). 4. The character `'0'` was replaced with `'\0'` in the `IsValid` method of the `DimensionView` struct in `checkerTopographyApplianceValidation.cpp` (correct representation of null character). 5. The `DimensionView` struct was moved from the global scope to the private scope of the `CCheckTopographyApplianceMetadata` class in `checkerTopographyApplianceValidation.h` (code organization). 6. The comment for the `CCheckTopographyApplianceMetadata` class was updated in `checkerTopographyApplianceValidation.h` (documentation update). 7. The `kHeighMapItemKey` constant was corrected to `kHeightMapItemKey` in `checkerTopographyApplianceValidation.h` (spelling correction). 8. The lambda function `enumChildrenLabmda` was renamed to `enumChildrenLambda` in `checkerTopographyApplianceValidation.cpp` (spelling correction).
…ZEISS/czicheck into 8-specialized-checker-for-topology-data
ptahmose
approved these changes
May 8, 2024
ptahmose
requested changes
May 8, 2024
There was a problem hiding this comment.
...we forgot the bump the version number (check CMakeLists.txt in repo's root folder, line 8). I'd guess - this change adds a new feature, so the minor-version-number should be incremented -> "0.2.0". And please add an entry to documentation/version-history.md.
|
@ptahmose Thank you very much for fixing all the typos and ugliness!! Very much appreciated! I updated the version number and the version history according to your comment. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Extended Depth of Focus (EDF) images are described in a czi-image by means of "Appliance" metadata items called "TopographyDataItem". It is important for the consuming application that the data specified there defines channels (indices) where "Textures" (the subblock that contain image pixeldata) and "HeightMaps" (the subblock that contain height information) can be found. At the same time, there should not be any additional information in these sections that is not defined by the czi specification.
This PR adds a basic metadata check for these topography sections. It implements the following checks:
Fixes #8
Type of change
How Has This Been Tested?
Malformed czi images were added to the testdata source. These are used with 2 new automated tests validating the introduced changes.
Checklist: