HDF5 property list interface.
Create a new property list as an instance of a class; classes are:
Bases: h5py._objects.ObjectID
Base class for all property lists and classes
Compare this property list (or class) to another for equality.
Bases: h5py.h5p.PropID
An HDF5 property list class.
Bases: h5py.h5p.PropID
Base class for property list instance objects. Provides methods which are common across all HDF5 property list classes.
Create a new copy of an existing property list object.
Determine the class of a property list object.
Bases: h5py.h5p.PropInstanceID
Generic object creation property list.
Bases: h5py.h5p.PropInstanceID
Generic object copy property list
Set flags for object copying process. Legal flags are from the h5o.COPY* family:
Bases: h5py.h5p.PropCreateID
File creation property list.
Determine addressing offsets and lengths for objects in an HDF5 file, in bytes. Return value is a 2-tuple with values:
Determine the user block size, in bytes.
Determine version information of various file attributes. Elements are:
Set the addressing offsets and lengths for objects in an HDF5 file, in bytes.
Set the file user block size, in bytes. Must be a power of 2, and at least 512.
Bases: h5py.h5p.PropInstanceID
File access property list
Get the metadata and raw data chunk cache settings. See the HDF5 docs for element definitions. Return is a 4-tuple with entries:
Return an integer identifier for the driver used by this list. Although HDF5 implements these as full-fledged objects, they are treated as integers by Python. Built-in drivers identifiers are listed in module h5fd; they are:
Determine settings for the h5fd.CORE (memory-resident) file driver. Tuple elements are:
Determine family driver settings. Tuple values are:
Get the compatibility level for file format. Returned values are from:
Get the current maximum size of the data sieve buffer (in bytes).
Set the metadata (mdc) and raw data chunk (rdcc) cache properties. See the HDF5 docs for a full explanation.
Use the h5fd.CORE (memory-resident) file driver.
Set up the family driver.
Enable the use of the logging driver. See the HDF5 documentation for details. Flag constants are stored in module h5fd.
Select the “section-2” driver (h5fd.SEC2).
Select the “stdio” driver (h5fd.STDIO)
Set the file-close degree, which determines library behavior when a file is closed when objects are still open. Legal values:
Set the compatibility level for file format. Legal values are:
Set the maximum size of the data sieve buffer (in bytes). This buffer can improve I/O performance for hyperslab I/O, by combining reads and writes into blocks of the given size. The default is 64k.
Bases: h5py.h5p.PropCreateID
Dataset creation property list.
Determine if all the filters in the pipelist are available to the library.
Determine the status of the dataset fill value. Return values are:
Get the storage space allocation time. One of h5d.ALLOC_TIME*.
Obtain the dataset chunk size, as a tuple.
Determine when fill values are written to the dataset. Legal values (defined in module h5d) are:
Read the dataset fill value into a NumPy array. It will be converted to match the array dtype. If the array has nonzero rank, only the first element will contain the value.
Get information about a filter, identified by its index. Tuple elements are:
Get information about a filter, identified by its code (one of h5z.FILTER*). If the filter doesn’t exist, returns None. Tuple elements are:
Determine the storage strategy of a dataset; legal values are:
Determine the number of filters in the pipeline.
Remove a filter from the pipeline. The class code is one of h5z.FILTER*.
Set the storage space allocation time. One of h5d.ALLOC_TIME*.
Set the dataset chunk size. It’s up to you to provide values which are compatible with your dataset.
Enable deflate (gzip) compression, at the given level. Valid levels are 0-9, default is 5.
Define when fill values are written to the dataset. Legal values (defined in module h5d) are:
Set the dataset fill value. The object provided should be an 0-dimensional NumPy array; otherwise, the value will be read from the first element.
Set a filter in the pipeline. Params are:
One of the following:
Enable Fletcher32 error correction on this list.
Set dataset storage strategy; legal values are:
Enable to use of the shuffle filter. Use this immediately before the deflate filter to increase the compression ratio.
Enable SZIP compression. See the HDF5 docs for argument meanings, and general restrictions on use of the SZIP format.
Bases: h5py.h5p.PropCreateID
Link creation property list
Get the character encoding for link names. Legal values are:
Determine if missing intermediate groups are automatically created.
Set the character encoding for link names. Legal values are:
Set whether missing intermediate groups are automatically created.
Bases: h5py.h5p.PropInstanceID
Link access property list
Get the file access property list used when opening external files.
Get the external link prefix
Get the maximum traversal depth for soft links
Set the file access property list used when opening external files.
Set the external link prefix.
Set the maximum traversal depth for soft links
Bases: h5py.h5p.PropCreateID
Group creation property list