Skip to content

Commit

Permalink
Merge pull request #219 from HDFGroup/add_docs_for_topics
Browse files Browse the repository at this point in the history
Resize images
  • Loading branch information
bmribler authored Apr 24, 2024
2 parents 9e34d61 + ac31f16 commit 917c9bf
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: HDF5 Data Flow Pipeline for H5Dread
redirect\_from:
redirect_from: display/HDF5/HDF5+Data+Flow+Pipeline+for+H5Dread
---

# HDF5 Data Flow Pipeline for H5Dread
Expand Down Expand Up @@ -95,11 +95,11 @@ status = H5Sselect\_hyperslab(space\_src, H5S\_SELECT\_SET, start\_src, NULL,

Figure 1 shows a conceptual representation of dataset D with uncompressed data. The desired region and the chunks that contain it are shown in green and yellow, respectively.

![Figure 1: Conceptual representation of dataset D](../images/DataFlow_H5Dread-figure1.jpg){: height="40%"}
![Figure 1: Conceptual representation of dataset D](../images/DataFlow_H5Dread-figure1.jpg)

In Figure 1, the chunks and region of interest are represented by the yellow and green areas of the diagram. Figure 2 shows an enlarged view of the region and chunks, with labels added. The dashed lines delineate individual elements in the dataset. Elements in the region of interest have been labeled so they can be traced through the pipeline process.

![Figure 2: Conceptual representation of region and chunks in dataset D](../images/DataReadPipeline-4Chunks.png){: height="30%"}
![Figure 2: Conceptual representation of region and chunks in dataset D](../images/DataReadPipeline-4Chunks.png)

Figure 3 shows a more accurate depiction of the chunks and elements in the region as they could be laid out on disk. Note that data in each chunk is stored contiguously on disk, and that the chunks have unequal sizes due to compression of the data.

Expand Down
2 changes: 1 addition & 1 deletion documentation/hdf5-docs/advanced_topics_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ redirect_from: display/HDF5/Advanced+Topics+in+HDF5
| [File Space Management](advanced_topics/) | Describes mechanisms to manage space in an HDF5 file |
| [Fine-tuning the Metadata Cache](advanced_topics/) | Describes how to provide better control of the metadata cache |
| [Freeing Memory Allocated by the HDF5 Library](https://docs.hdfgroup.org/hdf5/rfc/RFC%20H5free_memory%20v2.pdf) | Describes how inconsistent memory management can cause heap corruption or resource leaks and possible solutions |
| [HDF5 Data Flow Pipeline for H5Dread](advanced_topics/data_flow_pline_H5Dread.md) | Describes data flow when reading raw data from an HDF5 dataset |
| [HDF5 Data Flow Pipeline for H5Dread](https://github.com/HDFGroup/hdf5doc/blob/master/html/Advanced/DataFlow_H5Dread/DataFlow_H5Dread.pdf) | Describes data flow when reading raw data from an HDF5 dataset |
| [HDF5 Metadata](advanced_topics/) | Provides a comprehensive overview of the types of metadata used in HDF5 |
| [Introduction to Single-Writer_Multiple-Reader (SWMR)](advanced_topics/intro_SWMR.md) | Enables writing to a file while multiple readers are accessing it |
| [Introduction to the Virtual Dataset - VDS](advanced_topics/intro_VDS.md) | Describes how to present data stored in several HDF5 datasets and files as a single dataset and access the data using HDF5 APIs |
Expand Down
Binary file modified documentation/hdf5-docs/images/DataFlow_H5Dread-figure1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/hdf5-docs/images/DataReadPipeline-4Chunks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 917c9bf

Please sign in to comment.