 |
HDF5 1.14.5
API Reference
|
|
HDF5 1.14.5
API Reference
|
HDF5 property lists are the main vehicle to configure the behavior of HDF5 API functions.
Typically, property lists are created by instantiating one of the built-in or user-defined property list classes. After adding suitable properties, property lists are used when opening or creating HDF5 items, or when reading or writing data. Property lists can be modified by adding or changing properties. Property lists are deleted by closing the associated handles.
HDF5 properties and property lists make it possible to shape or modify an HDF5 file, group, dataset, attribute, committed datatype, or even an I/O stream, in a number of ways. For example, you can do any of the following:
Some properties enable an HDF5 application to take advantage of the capabilities of a specific computing environment while others make a file more compact; some speed the reading or writing of data while others enable more record-keeping at a per-object level. HDF5 offers nearly one hundred specific properties that can be used in literally thousands of combinations to maximize the usability of HDF5-stored data.
At the most basic level, a property list is a collection of properties, represented by name/value pairs that can be passed to various HDF5 functions, usually modifying default settings. A property list inherits a set of properties and values from a property list class. But that statement hardly provides a complete picture; in the rest of this section and in the next section, Property List Classes, Property Lists, and Properties , we will discuss these things in much more detail. After reading that material, the reader should have a reasonably complete understanding of how properties and property lists can be used in HDF5 applications.
The HDF5 property environment |
The remaining sections in this chapter discuss the following topics:
The discussions and function listings in this chapter focus on general property operations, object and link properties, and related functions.
File, group, dataset, datatype, and attribute properties are discussed in the chapters devoted to those features, where that information will be most convenient to users. For example, HDF5 Datasets discusses dataset creation property lists and functions, dataset access property lists and functions, and dataset transfer property lists and functions. This chapter does not duplicate those discussions.
Generic property operations are an advanced feature and are beyond the scope of this guide.
This chapter assumes an understanding of the following chapters of this HDF5 User Guide
HDF5 property lists and the property list interface Property Lists (H5P) provide a mechanism for storing characteristics of objects in an HDF5 file and economically passing them around in an HDF5 application. In this capacity, property lists significantly reduce the burden of additional function parameters throughout the HDF5 API. Another advantage of property lists is that features can often be added to HDF5 by adding only property list functions to the API; this is particularly true when all other requirements of the feature can be accomplished internally to the library.
For instance, a file creation operation needs to know several things about a file, such as the size of the userblock or the sizes of various file data structures. Bundling this information as a property list simplifies the interface by reducing the number of parameters to the function H5Fcreate.
As illustrated in the figure above ("The HDF5 property environment"), the HDF5 property environment is a three-level hierarchy:
The following subsections discuss property list classes, property lists, and properties in more detail.
A property list class defines the roles that property lists of that class can play. Each class includes all properties that are valid for that class with each property set to its default value. HDF5 offers a property lists class for each of the following situations.
| Property List Class | For further discussion | |
|---|---|---|
| File creation (FCPL) | H5P_FILE_CREATE | See various sections of The HDF5 File |
| File access (FAPL) | H5P_FILE_ACCESS | Used only as H5P_DEFAULT. |
| File mount (FMPL) | H5P_FILE_MOUNT | For more information, see File Mount Properties |
| Object creation (OCPL) | H5P_OBJECT_CREATE | See Object Creation Properties |
| Object copy (OCPYPL) | H5P_OBJECT_COPY | |
| Group creation (GCPL) | H5P_GROUP_CREATE | See Programming Model for Groups |
| Group access (GAPL) | H5P_GROUP_ACCESS | |
| Link creation (LCPL) | H5P_LINK_CREATE | See examples in Programming Model for Properties and Property Lists and Link Creation Properties |
| Link access (LAPL) | H5P_LINK_ACCESS | |
| Dataset creation (DCPL) | H5P_DATASET_CREATE | See Programming Model for Datasets |
| Dataset access (DAPL) | H5P_DATASET_ACCESS | |
| Dataset transfer (DXPL) | H5P_DATASET_XFER | |
| Datatype creation (TCPL) | H5P_DATATYPE_CREATE | See various sections of HDF5 Datatypes |
| String creation (STRCPL) | H5P_STRING_CREATE | See Programming Model for Datasets and Programming Model for Datatypes |
| Attribute creation (ACPL) | H5P_ATTRIBUTE_CREATE | See Working with Attributes. |
Note: In the table above, the abbreviations to the right of each property list class name in this table are widely used in both HDF5 programmer documentation and HDF5 source code. For example, File Creation Properties (FCPL) is the file creation property list, Object Creation Properties (OCPL) is the object creation property list, Object Copy Properties (OCPYPL) is object copy property list, and String Creation Properties (STRCPL) is the string creation property list. These abbreviations may appear in either uppercase or lowercase.
The “HDF5 property list class inheritance hierarchy” figure, immediately following, illustrates the inheritance hierarchy of HDF5's property list classes. Properties are defined at the root of the HDF5 property environment (Property List Class Root in the figure below). Property list classes then inherit properties from that root, either directly or indirectly through a parent class. In every case, a property list class inherits only the properties relevant to its role. For example, the Object Creation Properties (OCPL) inherits all properties that are relevant to the creation of any object while the Group Creation Properties (GCPL) inherits only those properties that are relevant to group creation.
HDF5 property list class inheritance hierarchy |
Note: In the figure above, property list classes displayed in black are directly accessible through the programming interface; the root of the property environment and the String Creation Properties and Object Creation Properties property list classes, in gray above, are not user-accessible. The red empty set symbol indicates that the File Mount Properties (FMPL) is an empty class; that is, it has no set table properties. For more information, see File Mount Properties. Abbreviations used in this figure are defined in the preceding table, Property list classes in HDF5.
A property list is a collection of related properties that are used together in specific circumstances. A new property list created from a property list class inherits the properties of the property list class and each property's default value. A fresh dataset creation property list, for example, includes all of the HDF5 properties relevant to the creation of a new dataset.
Property lists are implemented as containers holding a collection of name/value pairs. Each pair specifies a property name and a value for the property. A property list usually contains information for one to many properties.
HDF5's default property values are designed to be reasonable for general use cases. Therefore, an application can often use a property list without modification. On the other hand, adjusting property list settings is a routine action and there are many reasons for an application to do so.
A new property list may either be derived from a property list class or copied from an existing property list. When a property list is created from a property list class, it contains all the properties that are relevant to the class, with each property set to its default value. A new property list created by copying an existing property list will contain the same properties and property values as the original property list. In either case, the property values can be changed as needed through the HDF5 API.
Property lists can be freely reused to create consistency. For example, a single set of file, group, and dataset creation property lists might be created at the beginning of a project and used to create hundreds, thousands, even millions, of consistent files, file structures, and datasets over the project's life. When such consistency is important to a project, this is an economical means of providing it.
A property is the basic element of the property list hierarchy. HDF5 offers nearly one hundred properties controlling things ranging from file access rights, to the storage layout of a dataset, through optimizing the use of a parallel computing environment.
Further examples include the following:
| Purpose | Examples | Property List |
|---|---|---|
| Specify the driver to be used to open a file | A POSIX driver or an MPI IO driver | File Access Properties |
| Specify filters to be applied to a dataset | Gzip compression or checksum evaluation | Dataset Creation Properties |
| Specify whether to record key times associated with an object | Creation time and/or last-modified time | Object Creation Properties |
| Specify the access mode for a file opened via an external link | Read-only or read-write | Link Access Properties |
Each property is initialized with a default value. For each property, there are one or more dedicated H5Pset_*calls that can be used to change that value.
Properties fall into one of several major categories: creation properties, access properties, and transfer properties.
Creation properties control permanent object characteristics. These characteristics must be established when an object is created, cannot change through the life of the object (they are immutable), and the property setting usually has a permanent presence in the file.
|
Whether a dataset is stored in a compact, contiguous, or chunked layout |
|
Creation of intermediate groups when adding an object to an HDF5 file |
|
Whether an HDF5 file is a single file or a set of tightly related files that form a virtual HDF5 file |
|
To enable error detection when creating a dataset |
Access properties control transient object characteristics. These characteristics may change with the circumstances under which an object is accessed.
|
The driver used to open a file |
|
Optimization settings in specialized environments |
Transfer properties apply only to datasets and control transient aspects of data I/O. These characteristics may change with the circumstances under which data is accessed.
|
To enable error detection when reading a dataset |
|
Various properties to optimize chunked data I/O on parallel computing systems |
The programming model for HDF5 property lists is actually quite simple:
There are nuances, of course, but that is the basic process.
In some cases, you will not have to define property lists at all. If the default property settings are sufficient for your application, you can tell HDF5 to use the default property list.
The following sections first discuss the use of default property lists, then each step of the programming model, and finally a few less frequently used property list operations.
Default property lists can simplify many routine HDF5 tasks because you do not always have to create every property list you use.
An application that would be well-served by HDF5's default property settings can use the default property lists simply by substituting the value H5P_DEFAULT for a property list identifier. HDF5 will then apply the default property list for the appropriate property list class.
For example, the function H5Dcreate2 calls for a link creation property list, a dataset creation property list, and a dataset access property list. If the default properties are suitable for a dataset, this call can be made as
HDF5 will then apply the default link creation, dataset creation, and dataset access property lists correctly.
Of course, you would not want to do this without considering where it is appropriate, as there may be unforeseen consequences. Consider, for example, the use of chunked datasets. Optimal chunking is quite dependent on the makeup of the dataset and the most common access patterns, both of which must be taken into account in setting up the size and shape of chunks.
The steps of the property list programming model are described in the sub-sections below.
A new property list can be created either as an instance of a property list class or by copying an existing property list. Consider the following examples. A new dataset creation property list is first created "from scratch" with H5Pcreate. A second dataset creation property list is then created by copying the first one with H5Pcopy.
The new dataset creation property list is created as an instance of the property list class H5P_DATASET_CREATE.
The new dataset creation property list's identifier is returned in dcplA_id and the property list is initialized with default dataset creation property values.
A list of valid classes appears in the table Property list classes in HDF5.
A new dataset creation property list, dcplB_id, is created as a copy of dcplA_id and is initialized with dataset creation property values currently in dcplA_id.
At this point, dcplA_id and dcplB_id are identical; they will both contain any modified property values that were changed in dcplA_id before dcplB_id was created. They may, however, diverge as additional property values are reset in each.
While we are creating property lists, let's create a link creation property list; we will need this property list when the new dataset is linked into the file below:
This section describes how to set property values.
Later in this section, the dataset creation property lists dcplA_id and dcplB_id created in the section above will be used respectively to create chunked and contiguous datasets. To set this up, we must set the layout property in each property list. The following example sets dcplA_id for chunked datasets and dcplB_id for contiguous datasets:
Since dcplA_id specifies a chunked layout, we must also set the number of dimensions and the size of the chunks. The example below specifies that datasets created with dcplA_id will be 3-dimensional and that the chunk size will be 100 in each dimension:
These datasets will be created with UTF-8 encoded names. To accomplish that, the following example sets the character encoding property in the link creation property list to create link names with UTF-8 encoding:
dcplA_id can now be used to create chunked datasets and dcplB_id to create contiguous datasets. And with the use of lcplAB_id, they will be created with UTF-8 encoded names.
Once the required property lists have been created, they can be used to control various HDF5 processes. For illustration, consider dataset creation.
Assume that the datatype dtypeAB and the dataspaces dspaceA and dspaceB have been defined and that the location identifier locAB_id specifies the group AB in the current HDF5 file. We have already created the required link creation and dataset creation property lists. For the sake of illustration, we assume that the default dataset access property list meets our application requirements. The following calls would create the datasets dsetA and dsetB in the group AB. The raw data in dsetA will be contiguous while dsetB raw data will be chunked; both datasets will have UTF-8 encoded link names:
Generally, creating or opening anything in an HDF5 file results in an HDF5 identifier. These identifiers are of HDF5 type hid_t and include things like file identifiers, often expressed as file_id; dataset identifiers, dset_id; and property list identifiers, plist_id. To reduce the risk of memory leaks, all of these identifiers must be closed once they are no longer needed.
Property list identifiers are no exception to this rule, and H5Pclose is used for this purpose. The calls immediately following would close the property lists created and used in the examples above.
A few property list operations fall outside of the programming model described above. This section describes those operations.
Occasionally an application will have a property list but not know the corresponding property list class. A call such as in the following example will retrieve the unknown class of a known property list:
Upon this function's return, PList_Class will contain the value H5P_DATASET_CREATE indicating that dcplA_id is a dataset creation property list.
After a file has been created, another application may work on the file without knowing how the creation properties for the file were set up. Retrieving these property values is often unnecessary; HDF5 can read the data and knows how to deal with any properties it encounters.
But sometimes an application must do something that requires knowing the creation property settings. HDF5 makes the acquisition of this information fairly straight-forward; for each property setting call, H5Pset_*, there is a corresponding H5Pget_*call to retrieve the property's current setting.
Consider the following examples which illustrate the determination of dataset layout and chunking settings:
The application must first identify the creation property list with the appropriate get creation property list call. There is one such call for each kind of object.
H5Dget_create_plist will return a property list identifier for the creation property list that was used to create the dataset. Call it DCPL1_id.
H5Pset_layout sets a dataset's layout to be compact, contiguous, or chunked.
H5Pget_layout called with DCPL1_id will return the dataset's layout, either H5D_COMPACT, H5D_CONTIGUOUS, or H5D_CHUNKED.
H5Pset_chunk sets the rank of a dataset, that is the number of dimensions it will have, and the maximum size of each dimension.
H5Pget_chunk, also called with DCPL1_id, will return the rank of the dataset and the maximum size of each dimension.
If a creation property value has not been explicitly set, these H5Pget_calls will return the property's default value.
Access property settings are quite different from creation properties. Since access property settings are not retained in an HDF5 file or object, there is normally no knowledge of the settings that were used in the past. On the other hand, since access properties do not affect characteristics of the file or object, this is not normally an issue. For more information, see "Access and Creation Property Exceptions."
One circumstance under which an application might need to determine access property settings might be when a file or object is already open but the application does not know the property list settings. In that case, the application can use the appropriate get access property list call to retrieve a property list identifier. For example, if the dataset dsetA from the earlier examples is still open, the following call would return an identifier for the dataset access property list in use:
The application could then use the returned property list identifier to analyze the property settings
HDF5's generic property interface provides tools for managing the entire property hierarchy and for the creation and management of user-defined property lists and properties. This interface also makes it possible for an application or a driver to create, modify, and manage custom properties, property lists, and property list classes. A comprehensive list of functions for this interface appears under "Generic Property Operations (Advanced)" in the "H5P: Property List Interface" section of the HDF5 Reference Manual.
Further discussion of HDF5's generic property interface and user-defined properties and property lists is beyond the scope of this document.
General property functions, generic property functions and macros, property functions that are used with multiple types of objects, and object and link property functions are listed below.
Property list functions that apply to a specific type of object are listed in the chapter that discusses that object. For example, the HDF5 Datasets chapter has two property list function listings: one for dataset creation property list functions and one for dataset access property list functions. As has been stated, this chapter is not intended to describe every property list function.
Property Lists (H5P) reference manual
Property lists are ubiquitous in an HDF5 environment and are therefore discussed in many places in HDF5 documentation. The following sections and listings in the HDF5 User Guide are of particular interest:
All property list functions are described in the Property Lists (H5P) section of the HDF5 Reference Manual. The function index at the top of the page provides a categorized listing grouped by property list class. Those classes are listed below:
Additional categories not related to the class structure are as follows:
The general property functions can be used with any property list; the generic property functions constitute an advanced feature.
The in-memory file image feature of HDF5 uses property lists in a manner that differs substantially from their use elsewhere in HDF5. Those who plan to use in-memory file images must study "File Image Operations" (PDF) in the Advanced Topics in HDF5collection.
While the file mount property list class H5P_FILE_MOUNT is a valid HDF5 property list class, no file mount properties are defined by the HDF5 Library. References to a file mount property list should always be expressed as H5P_DEFAULT, meaning the default file mount property list.
There are a small number of exceptions to the rule that creation properties are always retained in a file or object and access properties are never retained.
The following properties are file access properties but they are not transient; they have permanent and different effects on a file. They could be validly classified as file creation properties as they must be set at creation time to properly create the file. But they are access properties because they must also be set when a file is reopened to properly access the file.
| Property | Related function |
|---|---|
| Family file driver | H5Pset_fapl_family |
| Split file driver | H5Pset_fapl_split |
| Core file driver | H5Pset_fapl_core |
The following is a link creation property, but it is not relevant after an object has been created and is not retained in the file or object.
| Property | Related function |
|---|---|
| Create missing intermediate groups | H5Pset_create_intermediate_group |
Previous Chapter HDF5 Error Handling - Next Chapter The HDF5 Virtual Object Layer (VOL)
1.9.7 