Low-level operations on HDF5 file objects.
Open an existing HDF5 file. Keyword “flags” may be:
Keyword fapl may be a file access property list.
Create a new HDF5 file. Keyword “flags” may be:
To keep the behavior in line with that of Python’s built-in functions, the default is ACC_TRUNC. Be careful!
Tell the HDF5 library to flush file buffers to disk. “obj” may be the file identifier, or the identifier of any object residing in the file. Keyword “scope” may be:
Determine if a given file is an HDF5 file. Note this raises an exception if the file doesn’t exist.
Mount an open file on the group “name” under group loc_id. Note that “name” must already exist.
Unmount a file, mounted at “name” under group loc_id.
Determine the name of the file in which the specified object resides.
Get the number of open objects.
Specify what kinds of object to include. May be one of OBJ*, or any bitwise combination (e.g. OBJ_FILE | OBJ_ATTR).
The special value OBJ_ALL matches all object types, and OBJ_LOCAL will only match objects opened through a specific identifier.
Get a list of identifier instances for open objects.
Specify what kinds of object to include. May be one of OBJ*, or any bitwise combination (e.g. OBJ_FILE | OBJ_ATTR).
The special value OBJ_ALL matches all object types, and OBJ_LOCAL will only match objects opened through a specific identifier.
Represents an HDF5 file identifier.
These objects wrap a small portion of the H5F interface; all the H5F functions which can take arbitrary objects in addition to file identifiers are provided as functions in the h5f module.
Properties:
Behavior:
Terminate access through this identifier. Note that depending on what property list settings were used to open the file, the physical file might not be closed until all remaining open identifiers are freed.
Retrieve a copy of the file access property list which manages access to this file.
Retrieve a copy of the file creation property list used to create this file.
Determine the total size (in bytes) of the HDF5 file, including any user block.
Determine the amount of free space in this file. Note that this only tracks free space until the file is closed.
Determine the file’s write intent, either of: - H5F_ACC_RDONLY - H5F_ACC_RDWR
File name on disk (according to h5f.get_name())
Retrieve another identifier for a file (which must still be open). The new identifier is guaranteed to neither be mounted nor contain a mounted file.
Create/truncate file
Create file if it doesn’t exist; fail otherwise
Open in read/write mode
Open in read-only mode