-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Populate image metadata without allocating memory for the entire image content #19830
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
4 tasks
b76cafa
to
8a71919
Compare
mvdbeek
approved these changes
Mar 25, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
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.
The
num_unique_values
metadata element for images was added in #18951. It was later observed that to populate this element, the image was loaded into memory, which required memory allocation in the size of the entire image. In #19760, it was thus proposed to remove thenum_unique_values
metadata element.As described here, it is also possible to populate the
num_unique_values
metadata element without allocating memory for the entire image. There are two orthogonal strategies how this is achieved for TIFF and PNG images in this PR.A hybrid strategy is employed to extract the necessary information from TIFF files without loading them entirely into memory. TIFF files with multiple segments (aka tiles, stripes) are processed by reading the segments one-by-one. This means that only the memory for a single segment needs to be allocated. TIFF files, however, that have only a single segment, are read by memory-mapping the image data into virtual memory. The image data is then read and processed chunk by chunk. In this case, only the memory of the size of a single chunk needs to be allocated.
In addition, this PR cleans up some terminology. There was confusion regarding pages/series in TIFF files.
For PNG images, the pypng library is used to read and process the image data row-by-row. This should allocate only as much memory as required for a single row of the image. The pypng library is added as a dependency (written entirely in Python, comes without further dependencies, only 58kB in size, see on PyPI).
For images other than TIFF and PNG, the
num_unique_values
metadata element is currently not computed.cc @mvdbeek
How to test the changes?
(Select all options that apply)
License