![]() |
HDF5
1.15.0.9c85c6e
API Reference
|
Functions/Subroutines | |
subroutine | h5tbmake_table_f (table_title, loc_id, dset_name, nfields, nrecords, type_size, field_names, field_offset, field_types, chunk_size, compress, errcode) |
Creates (DOES NOT WRITE) a dataset named dset_name attached to the object specified by the identifier loc_id . More... | |
subroutine | h5tbmake_table_f (table_title, loc_id, dset_name, nfields, nrecords, type_size, field_names, field_offset, field_types, chunk_size, fill_data, compress, data, errcode) |
Creates and writes a dataset named dset_name attached to the object specified by the identifier loc_id . More... | |
subroutine | h5tbread_table_f (loc_id, dset_name, nfields, dst_size, dst_offset, dst_sizes, dst_buf, errcode) |
Reads a table. More... | |
subroutine | h5tbwrite_field_name_f (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode) |
Overwrites field. More... | |
subroutine | h5tbread_field_name_f (loc_id, dset_name, field_name, start, nrecords, type_size, buf, errcode) |
Reads one or several fields. The fields are identified by name. More... | |
subroutine | h5tbwrite_field_index_f (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode) |
Overwrites a field. More... | |
subroutine | h5tbread_field_index_f (loc_id, dset_name, field_index, start, nrecords, type_size, buf, errcode) |
Reads field. The fields are identified by index. More... | |
subroutine | h5tbinsert_field_f (loc_id, dset_name, field_name, field_type, position, buf, errcode) |
Insert a new field into a table. More... | |
subroutine | h5tbdelete_field_f (loc_id, dset_name, field_name, errcode) |
Deletes a field from a table. More... | |
subroutine | h5tbget_table_info_f (loc_id, dset_name, nfields, nrecords, errcode) |
Gets the table dimensions. More... | |
subroutine | h5tbget_field_info_f (loc_id, dset_name, nfields, field_names, field_sizes, field_offsets, type_size, errcode, maxlen_out) |
Gets information about a table. More... | |
subroutine h5tb::h5tbdelete_field_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | dset_name, | ||
character(len=*), intent(in) | field_name, | ||
integer | errcode | ||
) |
Deletes a field from a table.
loc_id | Location identifier. The identifier may be that of a file or group. |
dset_name | The name of the table. |
field_name | The name of the field to delete. |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5TBdelete_field()
subroutine h5tb::h5tbget_field_info_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | dset_name, | ||
integer(hsize_t), intent(in) | nfields, | ||
character(len=*), dimension(nfields), intent(inout) | field_names, | ||
integer(size_t), dimension(nfields), intent(inout) | field_sizes, | ||
integer(size_t), dimension(nfields), intent(inout) | field_offsets, | ||
integer(size_t), intent(inout) | type_size, | ||
integer | errcode, | ||
integer(size_t), optional | maxlen_out | ||
) |
Gets information about a table.
loc_id | Location identifier. The identifier may be that of a file or group. |
dset_name | The name of the dataset to read. |
nfields | The number of fields. |
field_names | An array containing the names of the fields. |
field_sizes | An array containing the size of the fields. |
field_offsets | An array containing the offsets of the fields. |
type_size | The size of the HDF5 datatype associated with the table (i.e., the size in bytes of the HDF5 compound datatype used to define a row, or record, in the table). |
errcode | Returns 0 if successful and -1 if it fails. |
maxlen_out | Maximum character length of the field names. |
See C API: H5TBget_field_info()
subroutine h5tb::h5tbget_table_info_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | dset_name, | ||
integer(hsize_t), intent(inout) | nfields, | ||
integer(hsize_t), intent(inout) | nrecords, | ||
integer | errcode | ||
) |
Gets the table dimensions.
loc_id | Location identifier. The identifier may be that of a file or group. |
dset_name | The name of the dataset to read. |
nfields | The number of fields. |
nrecords | The number of records. |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5TBget_table_info()
subroutine h5tb::h5tbinsert_field_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | dset_name, | ||
character(len=*), intent(in) | field_name, | ||
integer(hid_t), intent(in) | field_type, | ||
integer, intent(in) | position, | ||
type(type), dimension(*), intent(in) | buf, | ||
integer | errcode | ||
) |
Insert a new field into a table.
loc_id | Location identifier. The identifier may be that of a file or group. |
dset_name | The name of the table. |
field_name | The name of the field to insert. |
field_type | The data type of the field. |
position | The zero based index position where to insert the field. |
buf | Buffer with data. |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5TBinsert_field()
subroutine h5tb::h5tbmake_table_f | ( | character(len=*), intent(in) | table_title, |
integer(hid_t), intent(in) | loc_id, | ||
character(len=*), intent(in) | dset_name, | ||
integer(hsize_t), intent(in) | nfields, | ||
integer(hsize_t), intent(in) | nrecords, | ||
integer(size_t), intent(in) | type_size, | ||
character(len=*), dimension(1:nfields), intent(in) | field_names, | ||
integer(size_t), dimension(1:nfields), intent(in) | field_offset, | ||
integer(hid_t), dimension(1:nfields), intent(in) | field_types, | ||
integer(hsize_t), intent(in) | chunk_size, | ||
integer, intent(in) | compress, | ||
integer | errcode | ||
) |
Creates (DOES NOT WRITE) a dataset named dset_name
attached to the object specified by the identifier loc_id
.
table_title | The title of the table. |
loc_id | Location identifier. The identifier may be that of a file or group. |
dset_name | The name of the dataset to create. |
nfields | The number of fields. |
nrecords | The number of records. |
type_size | The size in bytes of the structure associated with the table. Obtained with sizeof or storage_size. |
field_names | An array containing the names of the fields. |
field_offset | An array containing the offsets of the fields. |
field_types | An array containing the type of the fields. |
chunk_size | The chunk size. |
compress | Flag that turns compression on or off. |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5TBmake_table()
subroutine h5tb::h5tbmake_table_f | ( | character(len=*), intent(in) | table_title, |
integer(hid_t), intent(in) | loc_id, | ||
character(len=*), intent(in) | dset_name, | ||
integer(hsize_t), intent(in) | nfields, | ||
integer(hsize_t), intent(in) | nrecords, | ||
integer(size_t), intent(in) | type_size, | ||
character(len=*), dimension(1:nfields), intent(in) | field_names, | ||
integer(size_t), dimension(1:nfields), intent(in) | field_offset, | ||
integer(hid_t), dimension(1:nfields), intent(in) | field_types, | ||
integer(hsize_t), intent(in) | chunk_size, | ||
type(c_ptr), intent(in) | fill_data, | ||
integer, intent(in) | compress, | ||
type(c_ptr), intent(in) | data, | ||
integer | errcode | ||
) |
Creates and writes a dataset named dset_name
attached to the object specified by the identifier loc_id
.
table_title | The title of the table |
loc_id | Location identifier. The identifier may be that of a file or group. |
dset_name | The name of the dataset to create |
nfields | The number of fields |
nrecords | The number of records |
type_size | The size in bytes of the structure associated with the table; This value is obtained with sizeof(). |
field_names | An array containing the names of the fields |
field_offset | An array containing the offsets of the fields |
field_types | An array containing the type of the fields |
chunk_size | The chunk size |
fill_data | Fill values data |
compress | Flag that turns compression on or off |
data | Buffer with data to be written to the table |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5TBmake_table()
subroutine h5tb::h5tbread_field_index_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | dset_name, | ||
integer, intent(in) | field_index, | ||
integer(hsize_t), intent(in) | start, | ||
integer(hsize_t), intent(in) | nrecords, | ||
integer(size_t), intent(in) | type_size, | ||
type(type), dimension(*), intent(inout) | buf, | ||
integer | errcode | ||
) |
Reads field. The fields are identified by index.
loc_id | Location identifier. The identifier may be that of a file or group. |
dset_name | The name of the dataset to read. |
field_index | The indexes of the fields to read. |
start | The start record to read from. |
nrecords | The number of records to read. |
type_size | The size in bytes of the structure associated with the table. Obtained with sizeof or storage_size. |
buf | Buffer with data. |
errcode | Returns 0 if successful and -1 if it fails. |
See similar C API: H5TBread_fields_index()
subroutine h5tb::h5tbread_field_name_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | dset_name, | ||
character(len=*), intent(in) | field_name, | ||
integer(hsize_t), intent(in) | start, | ||
integer(hsize_t), intent(in) | nrecords, | ||
integer(size_t), intent(in) | type_size, | ||
type(type), dimension(*), intent(inout) | buf, | ||
integer | errcode | ||
) |
Reads one or several fields. The fields are identified by name.
loc_id | Location identifier. The identifier may be that of a file or group. |
dset_name | The name of the dataset to read. |
field_name | An array containing the names of the fields to read. |
start | The start record to read from. |
nrecords | The number of records to read. |
type_size | The size in bytes of the structure associated with the table. Obtained with sizeof or storage_size. |
buf | Buffer with data |
errcode | Returns 0 if successful and -1 if it fails. |
See similar C API: H5TBread_fields_name()
subroutine h5tb::h5tbread_table_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | dset_name, | ||
integer(hsize_t), intent(in) | nfields, | ||
integer(size_t), intent(in) | dst_size, | ||
integer(size_t), dimension(1:nfields), intent(in) | dst_offset, | ||
integer(size_t), dimension(1:nfields), intent(in) | dst_sizes, | ||
type(c_ptr) | dst_buf, | ||
integer | errcode | ||
) |
Reads a table.
loc_id | Location identifier. The identifier may be that of a file or group. |
dset_name | The name of the dataset to read |
nfields | Number of fields, i.e., size of dst_offset and dst_sizes arrays. |
dst_size | The size of the structure type, as calculated by sizeof or storage_size |
dst_offset | An array containing the offsets of the fields. These offsets can be calculated with H5OFFSETOF. |
dst_sizes | An array containing the sizes of the fields. These sizes can be calculated with sizeof or storage_size. |
dst_buf | Pointer to buffer with data. |
errcode | Returns 0 if successful and -1 if it fails. |
See C API: H5TBread_table()
subroutine h5tb::h5tbwrite_field_index_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | dset_name, | ||
integer, intent(in) | field_index, | ||
integer(hsize_t), intent(in) | start, | ||
integer(hsize_t), intent(in) | nrecords, | ||
integer(size_t), intent(in) | type_size, | ||
integer, dimension(*), intent(in) | buf, | ||
integer | errcode | ||
) |
Overwrites a field.
loc_id | Location identifier. The identifier may be that of a file or group. |
dset_name | The name of the dataset to overwrite. |
field_index | The indexe of the fields to write. |
start | The zero based index record to start writing. |
nrecords | The number of records to write. |
type_size | The size of the structure type, as calculated by sizeof or storage_size. |
buf | Buffer with data. |
errcode | Returns 0 if successful and -1 if it fails. |
See similar C API: H5TBwrite_fields_index()
subroutine h5tb::h5tbwrite_field_name_f | ( | integer(hid_t), intent(in) | loc_id, |
character(len=*), intent(in) | dset_name, | ||
character(len=*), intent(in) | field_name, | ||
integer(hsize_t), intent(in) | start, | ||
integer(hsize_t), intent(in) | nrecords, | ||
integer(size_t), intent(in) | type_size, | ||
type(type), dimension(*), intent(in) | buf, | ||
integer | errcode | ||
) |
Overwrites field.
loc_id | Location identifier. The identifier may be that of a file or group. |
dset_name | The name of the dataset to overwrite |
field_name | The names of the fields to write |
start | The zero index record to start writing |
nrecords | The number of records to write |
type_size | The size of the structure type, as calculated by sizeof or storage_size. |
buf | Buffer with data. |
errcode | Returns 0 if successful and -1 if it fails. |
See similar C API: H5TBwrite_fields_name()