HDF5 1.14.5
API Reference
|
Modules | |
module | h5d |
This module contains Fortran interfaces for H5D functions. | |
Functions/Subroutines | |
subroutine | h5dcreate_f (loc_id, name, type_id, space_id, dset_id, hdferr, dcpl_id, lcpl_id, dapl_id) |
Creates a dataset at the specified location. | |
subroutine | h5dcreate_async_f (loc_id, name, type_id, space_id, dset_id, es_id, hdferr, dcpl_id, lcpl_id, dapl_id, file, func, line) |
Asynchronously creates a dataset at the specified location. | |
subroutine | h5dopen_f (loc_id, name, dset_id, hdferr, dapl_id) |
Opens an existing dataset. | |
subroutine | h5dopen_async_f (loc_id, name, dset_id, es_id, hdferr, dapl_id, file, func, line) |
Asynchronously opens an existing dataset. | |
subroutine | h5dclose_f (dset_id, hdferr) |
Closes a dataset. | |
subroutine | h5dclose_async_f (dset_id, es_id, hdferr, file, func, line) |
Asynchronously closes a dataset. | |
subroutine | h5dget_type_f (dataset_id, datatype_id, hdferr) |
Returns an identifier for a copy of the datatype for a dataset. | |
subroutine | h5dset_extent_f (dataset_id, fsize, hdferr) |
Extends a dataset with unlimited dimension. | |
subroutine | h5dset_extent_async_f (dataset_id, fsize, es_id, hdferr, file, func, line) |
Asynchronously extends a dataset with unlimited dimension. | |
subroutine | h5dget_create_plist_f (dataset_id, plist_id, hdferr) |
Returns an identifier for a copy of the dataset creation property list for a dataset. | |
subroutine | h5dget_storage_size_f (dataset_id, size, hdferr) |
Returns the amount of storage requires by a dataset. | |
subroutine | h5dvlen_get_max_len_f (dataset_id, type_id, space_id, len, hdferr) |
Returns maximum length of the VL array elements. | |
subroutine | h5dget_space_status_f (dset_id, flag, hdferr) |
Returns the status of data space allocation. | |
subroutine | h5dcreate_anon_f (loc_id, type_id, space_id, dset_id, hdferr, dcpl_id, dapl_id) |
Creates a dataset in a file without linking it into the file structure. | |
subroutine | h5dread_vl_f (dset_id, mem_type_id, buf, dims, len, hdferr, mem_space_id, file_space_id, xfer_prp) |
Reads variable-length data. F2003 API h5dread_f should be used instead. | |
subroutine | h5dwrite_vl_f (dset_id, mem_type_id, buf, dims, len, hdferr, mem_space_id, file_space_id, xfer_prp) |
Writes variable-length data. F2003 API h5dwrite_f should be used instead. | |
subroutine | h5dget_offset_f (dset_id, offset, hdferr) |
Returns dataset address in file. | |
subroutine | h5dget_space_f (dataset_id, dataspace_id, hdferr) |
Returns an identifier for a copy of the dataspace for a dataset. | |
subroutine | h5dget_space_async_f (dataset_id, dataspace_id, es_id, hdferr, file, func, line) |
Asynchronously returns an identifier for a copy of the dataspace for a dataset. | |
subroutine | h5dget_access_plist_f (dset_id, plist_id, hdferr) |
Returns a copy of the dataset creation property list. | |
subroutine | h5dvlen_reclaim_f (type_id, space_id, plist_id, buf, hdferr) |
Reclaims VL datatype memory buffers. | |
subroutine | h5dread_async_f (dset_id, mem_type_id, buf, es_id, hdferr, mem_space_id, file_space_id, xfer_prp, file, func, line) |
Asynchronously reads raw data from a dataset into a buffer. | |
subroutine | h5dwrite_async_f (dset_id, mem_type_id, buf, es_id, hdferr, mem_space_id, file_space_id, xfer_prp, file, func, line) |
Asynchronously writes raw data from a buffer to a dataset. | |
subroutine | h5dwrite_f (dset_id, mem_type_id, buf, hdferr, mem_space_id, file_space_id, xfer_prp) |
Writes raw data from a buffer to a dataset. | |
subroutine | h5dread_f (dset_id, mem_type_id, buf, hdferr, mem_space_id, file_space_id, xfer_prp) |
Reads raw data from a dataset into a buffer (Passes Pointer). | |
subroutine | h5dwrite_f___f90_version (dset_id, mem_type_id, buf, dims, hdferr, mem_space_id, file_space_id, xfer_prp) |
There is no direct Fortran90 counterpart for the C function H5Dwrite. Instead, that functionality is provided by two Fortran90 subroutines: | |
subroutine | h5dread_f___f90_version (dset_id, mem_type_id, buf, dims, hdferr, mem_space_id, file_space_id, xfer_prp) |
There is no direct Fortran90 counterpart for the C function H5Dread. Instead, that functionality is provided by two Fortran90 subroutines: | |
subroutine | h5dfill_f (fill_value, space_id, buf, hdferr) |
Fills dataspace elements with a fill value in a memory buffer. Only INTEGER, CHARACTER, REAL and DOUBLE PRECISION datatypes of the fillvalues and buffers are supported. Buffer and fillvalue are assumed to have the same datatype. Only one-dimesional buffers are supported. | |
subroutine | h5dfill_f (fill_value, fill_type_id, buf, buf_type_id, space_id, hdferr) |
Fills dataspace elements with a fill value in a memory buffer. | |
subroutine | h5dread_multi_f (count, dset_id, mem_type_id, mem_space_id, file_space_id, buf, hdferr, xfer_prp) |
Reads data from a file to memory buffers for multiple datasets. | |
subroutine | h5dwrite_multi_f (count, dset_id, mem_type_id, mem_space_id, file_space_id, buf, hdferr, xfer_prp) |
Writes data in memory to a file for multiple datasets. | |
subroutine | h5dread_chunk_f (dset_id, offset, filters, buf, hdferr, dxpl_id) |
Reads a raw data chunk directly from a dataset in a file into a buffer. | |
subroutine | h5dwrite_chunk_f (dset_id, filters, offset, data_size, buf, hdferr, dxpl_id) |
Writes a raw data chunk from a buffer directly to a dataset in a file. | |
Variables | |
integer | h5d_compact_f |
H5D_COMPACT. | |
integer | h5d_contiguous_f |
H5D_CONTIGUOUS. | |
integer | h5d_chunked_f |
H5D_CHUNKED. | |
integer | h5d_alloc_time_error_f |
H5D_ALLOC_TIME_ERROR. | |
integer | h5d_alloc_time_default_f |
H5D_ALLOC_TIME_DEFAULT. | |
integer | h5d_alloc_time_early_f |
H5D_ALLOC_TIME_EARLY. | |
integer | h5d_alloc_time_late_f |
H5D_ALLOC_TIME_LATE. | |
integer | h5d_alloc_time_incr_f |
H5D_ALLOC_TIME_INCR. | |
integer | h5d_space_sts_error_f |
H5D_SPACE_STS_ERROR. | |
integer | h5d_space_sts_not_allocated_f |
H5D_SPACE_STS_NOT_ALLOCATED. | |
integer | h5d_space_sts_part_allocated_f |
H5D_SPACE_STS_PART_ALLOCATED. | |
integer | h5d_space_sts_allocated_f |
H5D_SPACE_STS_ALLOCATED. | |
integer | h5d_fill_time_error_f |
H5D_FILL_TIME_ERROR. | |
integer | h5d_fill_time_alloc_f |
H5D_FILL_TIME_ALLOC. | |
integer | h5d_fill_time_never_f |
H5D_FILL_TIME_NEVER. | |
integer | h5d_fill_value_error_f |
H5D_FILL_VALUE_ERROR. | |
integer | h5d_fill_value_undefined_f |
H5D_FILL_VALUE_UNDEFINED. | |
integer | h5d_fill_value_default_f |
H5D_FILL_VALUE_DEFAULT. | |
integer | h5d_fill_value_user_defined_f |
H5D_FILL_VALUE_USER_DEFINED. | |
integer(size_t) | h5d_chunk_cache_nslots_dflt_f |
H5D_CHUNK_CACHE_NSLOTS_DEFAULT. | |
integer(size_t) | h5d_chunk_cache_nbytes_dflt_f |
H5D_CHUNK_CACHE_NBYTES_DEFAULT. | |
integer | h5d_chunk_cache_w0_dflt_f |
H5D_CHUNK_CACHE_W0_DEFAULT. | |
integer | h5d_mpio_no_collective_f |
H5D_MPIO_NO_COLLECTIVE. | |
integer | h5d_mpio_chunk_independent_f |
H5D_MPIO_CHUNK_INDEPENDENT. | |
integer | h5d_mpio_chunk_collective_f |
H5D_MPIO_CHUNK_COLLECTIVE. | |
integer | h5d_mpio_chunk_mixed_f |
H5D_MPIO_CHUNK_MIXED. | |
integer | h5d_mpio_contig_collective_f |
H5D_MPIO_CONTIGUOUS_COLLECTIVE. | |
integer | h5d_vds_error_f |
H5D_VDS_ERROR. | |
integer | h5d_vds_first_missing_f |
H5D_VDS_FIRST_MISSING. | |
integer | h5d_vds_last_available_f |
H5D_VDS_LAST_AVAILABLE. | |
integer | h5d_virtual_f |
H5D_VIRTUAL. | |
integer | h5d_selection_io_mode_default_f |
H5D_SELECTION_IO_MODE_DEFAULT. | |
integer | h5d_selection_io_mode_off_f |
H5D_SELECTION_IO_MODE_OFF. | |
integer | h5d_selection_io_mode_on_f |
H5D_SELECTION_IO_MODE_ON. | |
integer | h5d_mpio_collective_f |
H5D_MPIO_COLLECTIVE. | |
integer | h5d_mpio_set_independent_f |
H5D_MPIO_SET_INDEPENDENT. | |
integer | h5d_mpio_datatype_conversion_f |
H5D_MPIO_DATATYPE_CONVERSION. | |
integer | h5d_mpio_data_transforms_f |
H5D_MPIO_DATA_TRANSFORMS. | |
integer | h5d_mpio_mpi_opt_types_env_var_disabled_f |
H5D_MPIO_MPI_OPT_TYPES_ENV_VAR_DISABLED. | |
integer | h5d_mpio_not_simple_or_scalar_dataspaces_f |
H5D_MPIO_NOT_SIMPLE_OR_SCALAR_DATASPACES. | |
integer | h5d_mpio_not_contiguous_or_chunked_dataset_f |
H5D_MPIO_NOT_CONTIGUOUS_OR_CHUNKED_DATASET. | |
integer | h5d_mpio_parallel_filtered_writes_disabled_f |
H5D_MPIO_PARALLEL_FILTERED_WRITES_DISABLED. | |
integer | h5d_mpio_error_while_checking_collective_possible_f |
H5D_MPIO_ERROR_WHILE_CHECKING_COLLECTIVE_POSSIBLE. | |
integer | h5d_mpio_no_selection_io_f |
H5D_MPIO_NO_SELECTION_IO. | |
integer | h5d_mpio_no_collective_max_cause_f |
H5D_MPIO_NO_COLLECTIVE_MAX_CAUSE. | |
integer | h5d_sel_io_disable_by_api_f |
H5D_SEL_IO_DISABLE_BY_API. | |
integer | h5d_sel_io_not_contiguous_or_chunked_dataset_f |
H5D_SEL_IO_NOT_CONTIGUOUS_OR_CHUNKED_DATASET. | |
integer | h5d_sel_io_contiguous_sieve_buffer_f |
H5D_SEL_IO_CONTIGUOUS_SIEVE_BUFFER. | |
integer | h5d_sel_io_no_vector_or_selection_io_cb_f |
H5D_SEL_IO_NO_VECTOR_OR_SELECTION_IO_CB. | |
integer | h5d_sel_io_page_buffer_f |
H5D_SEL_IO_PAGE_BUFFER. | |
integer | h5d_sel_io_dataset_filter_f |
H5D_SEL_IO_DATASET_FILTER. | |
integer | h5d_sel_io_chunk_cache_f |
H5D_SEL_IO_CHUNK_CACHE. | |
integer | h5d_sel_io_tconv_buf_too_small_f |
H5D_SEL_IO_TCONV_BUF_TOO_SMALL. | |
integer | h5d_sel_io_bkg_buf_too_small_f |
H5D_SEL_IO_BKG_BUF_TOO_SMALL. | |
integer | h5d_sel_io_default_off_f |
H5D_SEL_IO_DEFAULT_OFF. | |
integer | h5d_mpio_no_selection_io_causes_f |
H5D_MPIO_NO_SELECTION_IO_CAUSES. | |
integer | h5d_mpio_no_chunk_optimization_f |
H5D_MPIO_NO_CHUNK_OPTIMIZATION. | |
integer | h5d_mpio_link_chunk_f |
H5D_MPIO_LINK_CHUNK. | |
integer | h5d_mpio_multi_chunk_f |
H5D_MPIO_MULTI_CHUNK. | |
integer | h5d_scalar_io_f |
Scalar (or legacy MPIO) I/O was performed. | |
integer | h5d_vector_io_f |
Vector I/O was performed. | |
integer | h5d_selection_io_f |
Selection I/O was performed. | |
subroutine h5dclose_async_f | ( | integer(hid_t), intent(in) | dset_id, |
integer(hid_t), intent(in) | es_id, | ||
integer, intent(out) | hdferr, | ||
type(c_ptr), intent(in), optional | file, | ||
type(c_ptr), intent(in), optional | func, | ||
integer, intent(in), optional | line | ||
) |
Asynchronously closes a dataset.
dset_id | Dataset identifier |
es_id | Event set identifier |
hdferr | Returns 0 if successful and -1 if it fails. |
file | Pointer to filename the async subroutine is being called from, filename must be null character terminated |
func | Pointer to function name the async subroutine is being called in, func must be null character terminated |
line | Line number the async subroutine is being called at |
See C API: H5Dclose_async()
subroutine h5dclose_f | ( | integer(hid_t), intent(in) | dset_id, |
integer, intent(out) | hdferr | ||
) |
Closes a dataset.
dset_id | Dataset identifier |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Dclose()
subroutine h5dcreate_anon_f | ( | integer(hid_t), intent(in) | loc_id, |
integer(hid_t), intent(in) | type_id, | ||
integer(hid_t), intent(in) | space_id, | ||
integer(hid_t), intent(out) | dset_id, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | dcpl_id, | ||
integer(hid_t), intent(in), optional | dapl_id | ||
) |
Creates a dataset in a file without linking it into the file structure.
loc_id | Identifier of the file or group within which to create the dataset. |
type_id | Identifier of the datatype to use when creating the dataset. |
space_id | Identifier of the dataspace to use when creating the dataset. |
dset_id | Dataset identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
dcpl_id | Dataset creation property list identifier. |
dapl_id | Dataset access property list identifier. |
See C API: H5Dcreate_anon()
subroutine h5dcreate_async_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | name, | ||
integer(hid_t), intent(in) | type_id, | ||
integer(hid_t), intent(in) | space_id, | ||
integer(hid_t), intent(out) | dset_id, | ||
integer(hid_t), intent(in) | es_id, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | dcpl_id, | ||
integer(hid_t), intent(in), optional | lcpl_id, | ||
integer(hid_t), intent(in), optional | dapl_id, | ||
type(c_ptr), intent(in), optional | file, | ||
type(c_ptr), intent(in), optional | func, | ||
integer, intent(in), optional | line | ||
) |
Asynchronously creates a dataset at the specified location.
loc_id | File or group identifier |
name | Dataset name |
type_id | Dataset datatype identifier |
space_id | Dataset dataspace identifier |
dset_id | Dataset identifier |
es_id | Event set identifier |
hdferr | Returns 0 if successful and -1 if it fails. |
dcpl_id | Dataset creation property list |
lcpl_id | Link creation property list |
dapl_id | Dataset access property list |
file | Pointer to filename the async subroutine is being called from, filename must be null character terminated |
func | Pointer to function name the async subroutine is being called in, func must be null character terminated |
line | Line number the async subroutine is being called at |
See C API: H5Dcreate_async()
subroutine h5dcreate_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | name, | ||
integer(hid_t), intent(in) | type_id, | ||
integer(hid_t), intent(in) | space_id, | ||
integer(hid_t), intent(out) | dset_id, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | dcpl_id, | ||
integer(hid_t), intent(in), optional | lcpl_id, | ||
integer(hid_t), intent(in), optional | dapl_id | ||
) |
Creates a dataset at the specified location.
loc_id | File or group identifier |
name | Dataset name |
type_id | Dataset datatype identifier |
space_id | Dataset dataspace identifier |
dset_id | Dataset identifier |
hdferr | Returns 0 if successful and -1 if it fails. |
dcpl_id | Dataset creation property list |
lcpl_id | Link creation property list |
dapl_id | Dataset access property list |
See C API: H5Dcreate2()
subroutine h5dfill_f | ( | type(c_ptr), intent(in) | fill_value, |
integer(hid_t), intent(in) | fill_type_id, | ||
type(c_ptr), intent(in) | buf, | ||
integer(hid_t), intent(in) | buf_type_id, | ||
integer(hid_t), intent(in) | space_id, | ||
hdferr | |||
) |
Fills dataspace elements with a fill value in a memory buffer.
fill_value | Pointer to the fill value to be used. |
fill_type_id | Fill value datatype identifier, |
buf | Pointer to the memory buffer containing the selection to be filled. |
buf_type_id | Datatype of dataspace elements to be filled. |
space_id | Dataspace identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Dfill()
subroutine h5dfill_f | ( | type(type), intent(in) | fill_value, |
integer(hid_t), intent(in) | space_id, | ||
type(type), dimension(*), intent(out) | buf, | ||
integer, intent(out) | hdferr | ||
) |
Fills dataspace elements with a fill value in a memory buffer. Only INTEGER, CHARACTER, REAL and DOUBLE PRECISION datatypes of the fillvalues and buffers are supported. Buffer and fillvalue are assumed to have the same datatype. Only one-dimesional buffers are supported.
fill_value | Fill value. |
space_id | Identifier of the memory datatype. |
buf | Buffer to receive data read from file. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Dfill()
subroutine h5dget_access_plist_f | ( | integer(hid_t), intent(in) | dset_id, |
integer(hid_t), intent(out) | plist_id, | ||
integer, intent(out) | hdferr | ||
) |
Returns a copy of the dataset creation property list.
dset_id | Dataset identifier. |
plist_id | Dataset access property list identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Dget_access_plist()
subroutine h5dget_create_plist_f | ( | integer(hid_t), intent(in) | dataset_id, |
integer(hid_t), intent(out) | plist_id, | ||
integer, intent(out) | hdferr | ||
) |
Returns an identifier for a copy of the dataset creation property list for a dataset.
dataset_id | Dataset identifier |
plist_id | Creation property list identifier |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Dget_create_plist()
subroutine h5dget_offset_f | ( | integer(hid_t), intent(in) | dset_id, |
integer(haddr_t), intent(out) | offset, | ||
integer, intent(out) | hdferr | ||
) |
Returns dataset address in file.
dset_id | Dataset identifier. |
offset | The offset in bytes. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Dget_offset()
subroutine h5dget_space_async_f | ( | integer(hid_t), intent(in) | dataset_id, |
integer(hid_t), intent(out) | dataspace_id, | ||
integer(hid_t), intent(in) | es_id, | ||
integer, intent(out) | hdferr, | ||
type(c_ptr), intent(in), optional | file, | ||
type(c_ptr), intent(in), optional | func, | ||
integer, intent(in), optional | line | ||
) |
Asynchronously returns an identifier for a copy of the dataspace for a dataset.
dataset_id | Dataset identifier. |
dataspace_id | Dataspace identifier. |
es_id | Event set identifier |
hdferr | Returns 0 if successful and -1 if it fails. |
file | Pointer to filename the async subroutine is being called from, filename must be null character terminated |
func | Pointer to function name the async subroutine is being called in, func must be null character terminated |
line | Line number the async subroutine is being called at |
See C API: H5Dget_space_async()
subroutine h5dget_space_f | ( | integer(hid_t), intent(in) | dataset_id, |
integer(hid_t), intent(out) | dataspace_id, | ||
integer, intent(out) | hdferr | ||
) |
Returns an identifier for a copy of the dataspace for a dataset.
dataset_id | Dataset identifier. |
dataspace_id | Dataspace identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Dget_space()
subroutine h5dget_space_status_f | ( | integer(hid_t), intent(in) | dset_id, |
integer, intent(out) | flag, | ||
integer, intent(out) | hdferr | ||
) |
Returns the status of data space allocation.
dset_id | Dataset identifier |
flag | Status; may have one of the following values:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Dget_space_status()
subroutine h5dget_storage_size_f | ( | integer(hid_t), intent(in) | dataset_id, |
integer(hsize_t), intent(out) | size, | ||
integer, intent(out) | hdferr | ||
) |
Returns the amount of storage requires by a dataset.
dataset_id | Dataset identifier |
size | Datastorage size |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Dget_storage_size()
subroutine h5dget_type_f | ( | integer(hid_t), intent(in) | dataset_id, |
integer(hid_t), intent(out) | datatype_id, | ||
integer, intent(out) | hdferr | ||
) |
Returns an identifier for a copy of the datatype for a dataset.
dataset_id | Dataset identifier |
datatype_id | Dataspace identifier |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Dget_type()
subroutine h5dopen_async_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | name, | ||
integer(hid_t), intent(out) | dset_id, | ||
integer(hid_t), intent(in) | es_id, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | dapl_id, | ||
type(c_ptr), intent(in), optional | file, | ||
type(c_ptr), intent(in), optional | func, | ||
integer, intent(in), optional | line | ||
) |
Asynchronously opens an existing dataset.
loc_id | File or group identifier |
name | Dataset name |
dset_id | Dataset identifier |
es_id | Event set identifier |
hdferr | Returns 0 if successful and -1 if it fails. |
dapl_id | Dataset access property list |
file | Pointer to filename the async subroutine is being called from, filename must be null character terminated |
func | Pointer to function name the async subroutine is being called in, func must be null character terminated |
line | Line number the async subroutine is being called at |
See C API: H5Dopen_async()
subroutine h5dopen_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | name, | ||
integer(hid_t), intent(out) | dset_id, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | dapl_id | ||
) |
Opens an existing dataset.
loc_id | File or group identifier |
name | Dataset name |
dset_id | Dataset identifier |
hdferr | Returns 0 if successful and -1 if it fails. |
dapl_id | Dataset access property list |
See C API: H5Dopen2()
subroutine h5dread_async_f | ( | integer(hid_t), intent(in) | dset_id, |
integer(hid_t), intent(in) | mem_type_id, | ||
type(c_ptr), intent(in) | buf, | ||
integer(hid_t), intent(in) | es_id, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | mem_space_id, | ||
integer(hid_t), intent(in), optional | file_space_id, | ||
integer(hid_t), intent(in), optional | xfer_prp, | ||
type(c_ptr), intent(in), optional | file, | ||
type(c_ptr), intent(in), optional | func, | ||
integer, intent(in), optional | line | ||
) |
Asynchronously reads raw data from a dataset into a buffer.
dset_id | Identifier of the dataset read from. |
mem_type_id | Identifier of the memory datatype. |
buf | Buffer to receive data read from file. |
es_id | Event set identifier |
hdferr | Returns 0 if successful and -1 if it fails. |
mem_space_id | Identifier of the memory dataspace. |
file_space_id | Identifier of dataset's dataspace in the file. (Default: H5S_ALL_F) |
xfer_prp | Identifier of a transfer property list for this I/O operation. |
file | Pointer to filename the async subroutine is being called from, filename must be null character terminated |
func | Pointer to function name the async subroutine is being called in, func must be null character terminated |
line | Line number the async subroutine is being called at |
See C API: H5Dread_async()
subroutine h5dread_chunk_f | ( | integer(hid_t), intent(in) | dset_id, |
integer(hsize_t), dimension(:), intent(in) | offset, | ||
integer, intent(inout) | filters, | ||
type(c_ptr) | buf, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | dxpl_id | ||
) |
Reads a raw data chunk directly from a dataset in a file into a buffer.
dset_id | Identifier of the dataset to read from |
offset | Logical position of the chunk's first element in the dataspace, 0-based indices |
filters | Mask for identifying the filters in use |
buf | Buffer containing data to be read from the chunk |
hdferr | Returns 0 if successful and -1 if it fails. |
dxpl_id | Dataset transfer property list identifier |
See C API: H5Dread_chunk()
subroutine h5dread_f | ( | integer(hid_t), intent(in) | dset_id, |
integer(hid_t), intent(in) | mem_type_id, | ||
type(c_ptr), intent(in) | buf, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | mem_space_id, | ||
integer(hid_t), intent(in), optional | file_space_id, | ||
integer(hid_t), intent(in), optional | xfer_prp | ||
) |
Reads raw data from a dataset into a buffer (Passes Pointer).
dset_id | Identifier of the dataset read from. |
mem_type_id | Identifier of the memory datatype. |
buf | Buffer to receive data read from file. |
hdferr | Returns 0 if successful and -1 if it fails. |
mem_space_id | Identifier of the memory dataspace. |
file_space_id | Identifier of dataset's dataspace in the file. (Default: H5S_ALL_F) |
xfer_prp | Identifier of a transfer property list for this I/O operation. |
See C API: H5Dread()
subroutine h5dread_f___f90_version | ( | integer(hid_t), intent(in) | dset_id, |
integer(hid_t), intent(in) | mem_type_id, | ||
type(type), intent(inout) | buf, | ||
integer(hsize_t), dimension(*), intent(in) | dims, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | mem_space_id, | ||
integer(hid_t), intent(in), optional | file_space_id, | ||
integer(hid_t), intent(in), optional | xfer_prp | ||
) |
There is no direct Fortran90 counterpart for the C function H5Dread. Instead, that functionality is provided by two Fortran90 subroutines:
dset_id | Identifier of the dataset read from. |
mem_type_id | Identifier of the memory datatype. |
buf | Buffer to receive data read from file, may be a scalar or an array. |
dims | Array to hold corresponding dimension sizes of data buffer buf. dim(k) has value of the k-th. dimension of buffer buf. Values are ignored if buf is a scalar. |
hdferr | Returns 0 if successful and -1 if it fails. |
mem_space_id | Identifier of the memory dataspace. (Default: H5S_ALL_F) |
file_space_id | Identifier of dataset's dataspace in the file. (Default: H5S_ALL_F) |
xfer_prp | Identifier of a transfer property list for this I/O operation. (Default: H5P_DEFAULT_F) |
subroutine h5dread_multi_f | ( | integer(size_t), intent(in) | count, |
integer(hid_t), dimension(*), intent(in) | dset_id, | ||
integer(hid_t), dimension(*), intent(in) | mem_type_id, | ||
integer(hid_t), dimension(*), intent(in) | mem_space_id, | ||
integer(hid_t), dimension(*), intent(in) | file_space_id, | ||
type(c_ptr), dimension(*), intent(in) | buf, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | xfer_prp | ||
) |
Reads data from a file to memory buffers for multiple datasets.
count | Number of datasets to write to. |
dset_id | Identifier of the dataset to write to. |
mem_type_id | Identifier of the memory datatype. |
mem_space_id | Identifier of the memory dataspace. |
file_space_id | Identifier of the dataset's dataspace in the file. |
buf | Buffer with data to be written to the file. |
hdferr | Returns 0 if successful and -1 if it fails. |
xfer_prp | Identifier of a transfer property list for this I/O operation. |
See C API: H5Dread_multi()
subroutine h5dread_vl_f | ( | integer(hid_t), intent(in) | dset_id, |
integer(hid_t), intent(in) | mem_type_id, | ||
type(type), dimension(dims(1),dims(2)), intent(inout) | buf, | ||
integer(hsize_t), dimension(2), intent(in) | dims, | ||
integer(size_t), dimension(*), intent(inout) | len, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | mem_space_id, | ||
integer(hid_t), intent(in), optional | file_space_id, | ||
integer(hid_t), intent(in), optional | xfer_prp | ||
) |
Reads variable-length data. F2003 API h5dread_f should be used instead.
dset_id | Dataset identifier. |
mem_type_id | Memory datatype identifier. |
buf | Data buffer; may be a scalar or an array, TYPE(TYPE) must be one of the following:
|
dims | Array to hold corresponding dimension sizes of data buffer buf, dim(k) has value of the k-th dimension of buffer buf. Values are ignored if buf is a scalar. |
len | Array to store length of each element. |
hdferr | Returns 0 if successful and -1 if it fails. |
mem_space_id | Memory dataspace identifier, default value is H5S_ALL_F. |
file_space_id | File dataspace identifier, default value is H5S_ALL_F. |
xfer_prp | Transfer property list identifier, default value is H5P_DEFAULT_F. |
subroutine h5dset_extent_async_f | ( | integer(hid_t), intent(in) | dataset_id, |
integer(hsize_t), dimension(*), intent(in) | fsize, | ||
integer(hid_t), intent(in) | es_id, | ||
integer, intent(out) | hdferr, | ||
type(c_ptr), intent(in), optional | file, | ||
type(c_ptr), intent(in), optional | func, | ||
integer, intent(in), optional | line | ||
) |
Asynchronously extends a dataset with unlimited dimension.
dataset_id | Dataset identifier |
fsize | Array containing the new magnitude of each dimension |
es_id | Event set identifier |
hdferr | Returns 0 if successful and -1 if it fails. |
file | Pointer to filename the async subroutine is being called from, filename must be null character terminated |
func | Pointer to function name the async subroutine is being called in, func must be null character terminated |
line | Line number the async subroutine is being called at |
See C API: H5Dset_extent_async()
subroutine h5dset_extent_f | ( | integer(hid_t), intent(in) | dataset_id, |
integer(hsize_t), dimension(*), intent(in) | fsize, | ||
integer, intent(out) | hdferr | ||
) |
Extends a dataset with unlimited dimension.
dataset_id | Dataset identifier |
fsize | Array containing the new magnitude of each dimension |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Dset_extent()
subroutine h5dvlen_get_max_len_f | ( | integer(hid_t), intent(in) | dataset_id, |
integer(hid_t), intent(in) | type_id, | ||
integer(hid_t), intent(in) | space_id, | ||
integer(size_t), intent(out) | len, | ||
integer, intent(out) | hdferr | ||
) |
Returns maximum length of the VL array elements.
dataset_id | Dataset identifier |
type_id | Datatype identifier |
space_id | Dataspace identifier |
len | Buffer size |
hdferr | Returns 0 if successful and -1 if it fails. |
subroutine h5dvlen_reclaim_f | ( | integer(hid_t), intent(in) | type_id, |
integer(hid_t), intent(in) | space_id, | ||
integer(hid_t), intent(in) | plist_id, | ||
type(c_ptr), intent(in) | buf, | ||
integer, intent(out) | hdferr | ||
) |
Reclaims VL datatype memory buffers.
type_id | Identifier of the datatype. |
space_id | Identifier of the dataspace. |
plist_id | Identifier of the property list used to create the buffer. |
buf | Pointer to the buffer to be reclaimed. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Dvlen_reclaim()
subroutine h5dwrite_async_f | ( | integer(hid_t), intent(in) | dset_id, |
integer(hid_t), intent(in) | mem_type_id, | ||
type(c_ptr), intent(in) | buf, | ||
integer(hid_t), intent(in) | es_id, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | mem_space_id, | ||
integer(hid_t), intent(in), optional | file_space_id, | ||
integer(hid_t), intent(in), optional | xfer_prp, | ||
type(c_ptr), intent(in), optional | file, | ||
type(c_ptr), intent(in), optional | func, | ||
integer, intent(in), optional | line | ||
) |
Asynchronously writes raw data from a buffer to a dataset.
dset_id | Identifier of the dataset to write to. |
mem_type_id | Identifier of the memory datatype. |
buf | Buffer with data to be written to the file. |
es_id | Event set identifier |
hdferr | Returns 0 if successful and -1 if it fails. |
mem_space_id | Identifier of the memory dataspace. |
file_space_id | Identifier of the dataset's dataspace in the file. |
xfer_prp | Identifier of a transfer property list for this I/O operation. |
file | Pointer to filename the async subroutine is being called from, filename must be null character terminated |
func | Pointer to function name the async subroutine is being called in, func must be null character terminated |
line | Line number the async subroutine is being called at |
See C API: H5Dwrite_async()
subroutine h5dwrite_chunk_f | ( | integer(hid_t), intent(in) | dset_id, |
integer, intent(in) | filters, | ||
integer(hsize_t), dimension(:), intent(in) | offset, | ||
integer(size_t), intent(in) | data_size, | ||
type(c_ptr) | buf, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | dxpl_id | ||
) |
Writes a raw data chunk from a buffer directly to a dataset in a file.
dset_id | Identifier of the dataset to write to |
filters | Mask for identifying the filters in use |
offset | Logical position of the chunk's first element in the dataspace, 0-based indices |
data_size | Size of the actual data to be written in bytes |
buf | Buffer containing data to be written to the chunk |
hdferr | Returns 0 if successful and -1 if it fails. |
dxpl_id | Dataset transfer property list identifier |
See C API: H5Dwrite_chunk()
subroutine h5dwrite_f | ( | integer(hid_t), intent(in) | dset_id, |
integer(hid_t), intent(in) | mem_type_id, | ||
type(c_ptr), intent(in) | buf, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | mem_space_id, | ||
integer(hid_t), intent(in), optional | file_space_id, | ||
integer(hid_t), intent(in), optional | xfer_prp | ||
) |
Writes raw data from a buffer to a dataset.
dset_id | Identifier of the dataset to write to. |
mem_type_id | Identifier of the memory datatype. |
buf | Buffer with data to be written to the file. |
hdferr | Returns 0 if successful and -1 if it fails. |
mem_space_id | Identifier of the memory dataspace. |
file_space_id | Identifier of the dataset's dataspace in the file. |
xfer_prp | Identifier of a transfer property list for this I/O operation. |
See C API: H5Dwrite()
subroutine h5dwrite_f___f90_version | ( | integer(hid_t), intent(in) | dset_id, |
integer(hid_t), intent(in) | mem_type_id, | ||
type(type), intent(in) | buf, | ||
intent(in) | dims, | ||
hdferr, | |||
integer(hid_t), intent(in), optional | mem_space_id, | ||
integer(hid_t), intent(in), optional | file_space_id, | ||
integer(hid_t), intent(in), optional | xfer_prp | ||
) |
There is no direct Fortran90 counterpart for the C function H5Dwrite. Instead, that functionality is provided by two Fortran90 subroutines:
dset_id | Identifier of the dataset to write to. |
mem_type_id | Identifier of the memory datatype. |
buf | Data buffer; may be a scalar or an array. |
dims | Array to hold corresponding dimension sizes of data buffer buf; dim(k) has value. of the k-th dimension of buffer buf; values are ignored if buf is a scalar. |
hdferr | Returns 0 if successful and -1 if it fails. |
mem_space_id | Identifier of the memory dataspace. Default value is H5S_ALL_F. |
file_space_id | Identifier of the dataset's dataspace in the file. Default value is H5S_ALL_F. |
xfer_prp | Identifier of a transfer property list for this I/O operation. Default value is H5P_DEFAULT_F. |
subroutine h5dwrite_multi_f | ( | integer(size_t), intent(in) | count, |
integer(hid_t), dimension(*), intent(in) | dset_id, | ||
integer(hid_t), dimension(*), intent(in) | mem_type_id, | ||
integer(hid_t), dimension(*), intent(in) | mem_space_id, | ||
integer(hid_t), dimension(*), intent(in) | file_space_id, | ||
type(c_ptr), dimension(*), intent(in) | buf, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | xfer_prp | ||
) |
Writes data in memory to a file for multiple datasets.
count | Number of datasets to write to. |
dset_id | Identifier of the dataset to write to. |
mem_type_id | Identifier of the memory datatype. |
mem_space_id | Identifier of the memory dataspace. |
file_space_id | Identifier of the dataset's dataspace in the file. |
buf | Buffer with data to be written to the file. |
hdferr | Returns 0 if successful and -1 if it fails. |
xfer_prp | Identifier of a transfer property list for this I/O operation. |
See C API: H5Dwrite_multi()
subroutine h5dwrite_vl_f | ( | integer(hid_t), intent(in) | dset_id, |
integer(hid_t), intent(in) | mem_type_id, | ||
type(type), dimension(dims(1),dims(2)), intent(in) | buf, | ||
integer(hsize_t), dimension(2), intent(in) | dims, | ||
integer(size_t), dimension(*), intent(in) | len, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | mem_space_id, | ||
integer(hid_t), intent(in), optional | file_space_id, | ||
integer(hid_t), intent(in), optional | xfer_prp | ||
) |
Writes variable-length data. F2003 API h5dwrite_f should be used instead.
dset_id | Dataset identifier. |
mem_type_id | Memory datatype identifier. |
buf | Data buffer; may be a scalar or an array, TYPE(TYPE) must be one of the following:
|
dims | Array to hold corresponding dimension sizes of data buffer buf, dim(k) has value of the k-th dimension of buffer buf. Values are ignored if buf is a scalar. |
len | Array to store length of each element. |
hdferr | Returns 0 if successful and -1 if it fails. |
mem_space_id | Memory dataspace identifier, default value is H5S_ALL_F. |
file_space_id | File dataspace identifier, default value is H5S_ALL_F. |
xfer_prp | Transfer property list identifier, default value is H5P_DEFAULT_F. |
integer h5d_alloc_time_default_f |
H5D_ALLOC_TIME_DEFAULT.
integer h5d_alloc_time_early_f |
H5D_ALLOC_TIME_EARLY.
integer h5d_alloc_time_error_f |
H5D_ALLOC_TIME_ERROR.
integer h5d_alloc_time_incr_f |
H5D_ALLOC_TIME_INCR.
integer h5d_alloc_time_late_f |
H5D_ALLOC_TIME_LATE.
integer(size_t) h5d_chunk_cache_nbytes_dflt_f |
H5D_CHUNK_CACHE_NBYTES_DEFAULT.
integer(size_t) h5d_chunk_cache_nslots_dflt_f |
H5D_CHUNK_CACHE_NSLOTS_DEFAULT.
integer h5d_chunk_cache_w0_dflt_f |
H5D_CHUNK_CACHE_W0_DEFAULT.
integer h5d_chunked_f |
H5D_CHUNKED.
integer h5d_compact_f |
H5D_COMPACT.
integer h5d_contiguous_f |
H5D_CONTIGUOUS.
integer h5d_fill_time_alloc_f |
H5D_FILL_TIME_ALLOC.
integer h5d_fill_time_error_f |
H5D_FILL_TIME_ERROR.
integer h5d_fill_time_never_f |
H5D_FILL_TIME_NEVER.
integer h5d_fill_value_default_f |
H5D_FILL_VALUE_DEFAULT.
integer h5d_fill_value_error_f |
H5D_FILL_VALUE_ERROR.
integer h5d_fill_value_undefined_f |
H5D_FILL_VALUE_UNDEFINED.
integer h5d_fill_value_user_defined_f |
H5D_FILL_VALUE_USER_DEFINED.
integer h5d_mpio_chunk_collective_f |
H5D_MPIO_CHUNK_COLLECTIVE.
integer h5d_mpio_chunk_independent_f |
H5D_MPIO_CHUNK_INDEPENDENT.
integer h5d_mpio_chunk_mixed_f |
H5D_MPIO_CHUNK_MIXED.
integer h5d_mpio_collective_f |
H5D_MPIO_COLLECTIVE.
integer h5d_mpio_contig_collective_f |
H5D_MPIO_CONTIGUOUS_COLLECTIVE.
integer h5d_mpio_data_transforms_f |
H5D_MPIO_DATA_TRANSFORMS.
integer h5d_mpio_datatype_conversion_f |
H5D_MPIO_DATATYPE_CONVERSION.
integer h5d_mpio_error_while_checking_collective_possible_f |
H5D_MPIO_ERROR_WHILE_CHECKING_COLLECTIVE_POSSIBLE.
integer h5d_mpio_link_chunk_f |
H5D_MPIO_LINK_CHUNK.
integer h5d_mpio_mpi_opt_types_env_var_disabled_f |
H5D_MPIO_MPI_OPT_TYPES_ENV_VAR_DISABLED.
integer h5d_mpio_multi_chunk_f |
H5D_MPIO_MULTI_CHUNK.
integer h5d_mpio_no_chunk_optimization_f |
H5D_MPIO_NO_CHUNK_OPTIMIZATION.
integer h5d_mpio_no_collective_f |
H5D_MPIO_NO_COLLECTIVE.
integer h5d_mpio_no_collective_max_cause_f |
H5D_MPIO_NO_COLLECTIVE_MAX_CAUSE.
integer h5d_mpio_no_selection_io_causes_f |
H5D_MPIO_NO_SELECTION_IO_CAUSES.
integer h5d_mpio_no_selection_io_f |
H5D_MPIO_NO_SELECTION_IO.
integer h5d_mpio_not_contiguous_or_chunked_dataset_f |
H5D_MPIO_NOT_CONTIGUOUS_OR_CHUNKED_DATASET.
integer h5d_mpio_not_simple_or_scalar_dataspaces_f |
H5D_MPIO_NOT_SIMPLE_OR_SCALAR_DATASPACES.
integer h5d_mpio_parallel_filtered_writes_disabled_f |
H5D_MPIO_PARALLEL_FILTERED_WRITES_DISABLED.
integer h5d_mpio_set_independent_f |
H5D_MPIO_SET_INDEPENDENT.
integer h5d_scalar_io_f |
Scalar (or legacy MPIO) I/O was performed.
integer h5d_sel_io_bkg_buf_too_small_f |
H5D_SEL_IO_BKG_BUF_TOO_SMALL.
integer h5d_sel_io_chunk_cache_f |
H5D_SEL_IO_CHUNK_CACHE.
integer h5d_sel_io_contiguous_sieve_buffer_f |
H5D_SEL_IO_CONTIGUOUS_SIEVE_BUFFER.
integer h5d_sel_io_dataset_filter_f |
H5D_SEL_IO_DATASET_FILTER.
integer h5d_sel_io_default_off_f |
H5D_SEL_IO_DEFAULT_OFF.
integer h5d_sel_io_disable_by_api_f |
H5D_SEL_IO_DISABLE_BY_API.
integer h5d_sel_io_no_vector_or_selection_io_cb_f |
H5D_SEL_IO_NO_VECTOR_OR_SELECTION_IO_CB.
integer h5d_sel_io_not_contiguous_or_chunked_dataset_f |
H5D_SEL_IO_NOT_CONTIGUOUS_OR_CHUNKED_DATASET.
integer h5d_sel_io_page_buffer_f |
H5D_SEL_IO_PAGE_BUFFER.
integer h5d_sel_io_tconv_buf_too_small_f |
H5D_SEL_IO_TCONV_BUF_TOO_SMALL.
integer h5d_selection_io_f |
Selection I/O was performed.
integer h5d_selection_io_mode_default_f |
H5D_SELECTION_IO_MODE_DEFAULT.
integer h5d_selection_io_mode_off_f |
H5D_SELECTION_IO_MODE_OFF.
integer h5d_selection_io_mode_on_f |
H5D_SELECTION_IO_MODE_ON.
integer h5d_space_sts_allocated_f |
H5D_SPACE_STS_ALLOCATED.
integer h5d_space_sts_error_f |
H5D_SPACE_STS_ERROR.
integer h5d_space_sts_not_allocated_f |
H5D_SPACE_STS_NOT_ALLOCATED.
integer h5d_space_sts_part_allocated_f |
H5D_SPACE_STS_PART_ALLOCATED.
integer h5d_vds_error_f |
H5D_VDS_ERROR.
integer h5d_vds_first_missing_f |
H5D_VDS_FIRST_MISSING.
integer h5d_vds_last_available_f |
H5D_VDS_LAST_AVAILABLE.
integer h5d_vector_io_f |
Vector I/O was performed.
integer h5d_virtual_f |
H5D_VIRTUAL.