![]() |
HDF5
1.15.0.fb38a8b
API Reference
|
Functions/Subroutines | |
subroutine | h5screate_simple_f (rank, dims, space_id, hdferr, maxdims) |
Creates a new simple data space and opens it for access. More... | |
subroutine | h5sclose_f (space_id, hdferr) |
Releases and terminates access to a dataspace. More... | |
subroutine | h5screate_f (classtype, space_id, hdferr) |
Creates a new dataspace of a specified type. More... | |
subroutine | h5scopy_f (space_id, new_space_id, hdferr) |
Creates an exact copy of a dataspace. More... | |
subroutine | h5sget_select_hyper_nblocks_f (space_id, num_blocks, hdferr) |
Get number of hyperslab blocks. More... | |
subroutine | h5sget_select_hyper_blocklist_f (space_id, startblock, num_blocks, buf, hdferr) |
Gets the list of hyperslab blocks currently selected. More... | |
subroutine | h5sget_select_bounds_f (space_id, start, END, hdferr) |
Gets the bounding box containing the current selection. More... | |
subroutine | h5sget_select_elem_npoints_f (space_id, num_points, hdferr) |
Gets the number of element points in the current selection. More... | |
subroutine | h5sget_select_elem_pointlist_f (space_id, startpoint, num_points, buf, hdferr) |
Gets the list of element points currently selected. More... | |
subroutine | h5sselect_elements_f (space_id, OPERATOR, rank, num_elements, coord, hdferr) |
Selects elements to be included in the selection for a dataspace. More... | |
subroutine | h5sselect_all_f (space_id, hdferr) |
Selects the entire dataspace. More... | |
subroutine | h5sselect_none_f (space_id, hdferr) |
Resets the selection region to include no elements. More... | |
subroutine | h5sselect_valid_f (space_id, status, hdferr) |
Verifies that the selection is within the extent of the dataspace. More... | |
subroutine | h5sget_simple_extent_npoints_f (space_id, npoints, hdferr) |
Determines the number of elements in a dataspace. More... | |
subroutine | h5sget_select_npoints_f (space_id, npoints, hdferr) |
Determines the number of elements in a dataspace selection. More... | |
subroutine | h5sget_simple_extent_ndims_f (space_id, rank, hdferr) |
Determines the dimensionality of a dataspace. More... | |
subroutine | h5sget_simple_extent_dims_f (space_id, dims, maxdims, hdferr) |
Retrieves dataspace dimension size and maximum size. More... | |
subroutine | h5sget_simple_extent_type_f (space_id, classtype, hdferr) |
Determine the current class of a dataspace. More... | |
subroutine | h5sset_extent_simple_f (space_id, rank, current_size, maximum_size, hdferr) |
Sets or resets the size of an existing dataspace. More... | |
subroutine | h5sis_simple_f (space_id, status, hdferr) |
Determines whether a dataspace is a simple dataspace. More... | |
subroutine | h5soffset_simple_f (space_id, offset, hdferr) |
Sets the offset of a simple dataspace. More... | |
subroutine | h5sextent_copy_f (dest_space_id, source_space_id, hdferr) |
Copies the extent of a dataspace. More... | |
subroutine | h5sset_extent_none_f (space_id, hdferr) |
Removes the extent from a dataspace. More... | |
subroutine | h5sselect_hyperslab_f (space_id, OPERATOR, start, count, hdferr, stride, BLOCK) |
Selects a hyperslab region to add to the current selected region. More... | |
subroutine | h5sget_select_type_f (space_id, TYPE, hdferr) |
Retrieve the type of selection. More... | |
subroutine | h5sdecode_f (buf, obj_id, hdferr) |
Decode a binary object description of data space and return a new object handle. More... | |
subroutine | h5sencode_f (obj_id, buf, nalloc, hdferr, fapl_id) |
Encode a data space object description into a binary buffer. More... | |
subroutine | h5sextent_equal_f (space1_id, space2_id, equal, hdferr) |
Determines whether two dataspace extents are equal. More... | |
subroutine | h5sget_regular_hyperslab_f (space_id, start, stride, count, block, hdferr) |
Retrieves a regular hyperslab selection. More... | |
subroutine | h5sis_regular_hyperslab_f (space_id, IsRegular, hdferr) |
Retrieves a regular hyperslab selection. More... | |
Variables | |
integer(hsize_t) | h5s_unlimited_f |
H5S_UNLIMITED. More... | |
integer(hid_t) | h5s_all_f |
H5S_ALL. More... | |
integer | h5s_scalar_f |
H5S_SCALAR. More... | |
integer | h5s_simple_f |
H5S_SIMPLE. More... | |
integer | h5s_null_f |
H5S_NULL. More... | |
integer | h5s_select_noop_f |
H5S_SELECT_NOOP. More... | |
integer | h5s_select_set_f |
H5S_SELECT_SET. More... | |
integer | h5s_select_or_f |
H5S_SELECT_OR. More... | |
integer | h5s_select_and_f |
H5S_SELECT_AND. More... | |
integer | h5s_select_xor_f |
H5S_SELECT_XOR. More... | |
integer | h5s_select_notb_f |
H5S_SELECT_NOTB. More... | |
integer | h5s_select_nota_f |
H5S_SELECT_NOTA. More... | |
integer | h5s_select_append_f |
H5S_SELECT_APPEND. More... | |
integer | h5s_select_prepend_f |
H5S_SELECT_PREPEND. More... | |
integer | h5s_select_invalid_f |
H5S_SELECT_INVALID. More... | |
integer | h5s_sel_error_f |
H5S_SEL_ERROR. More... | |
integer | h5s_sel_none_f |
H5S_SEL_NONE. More... | |
integer | h5s_sel_points_f |
H5S_SEL_POINTS. More... | |
integer | h5s_sel_hyperslabs_f |
H5S_SEL_HYPERSLABS. More... | |
integer | h5s_sel_all_f |
H5S_SEL_ALL. More... | |
subroutine h5s::h5sclose_f | ( | integer(hid_t), intent(in) | space_id, |
integer, intent(out) | hdferr | ||
) |
Releases and terminates access to a dataspace.
space_id | Identifier of dataspace to release. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sclose()
subroutine h5s::h5scopy_f | ( | integer(hid_t), intent(in) | space_id, |
integer(hid_t), intent(out) | new_space_id, | ||
integer, intent(out) | hdferr | ||
) |
Creates an exact copy of a dataspace.
space_id | Dataspace identifier. |
new_space_id | Identifier of dataspace's copy. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Scopy()
subroutine h5s::h5screate_f | ( | integer, intent(in) | classtype, |
integer(hid_t), intent(out) | space_id, | ||
integer, intent(out) | hdferr | ||
) |
Creates a new dataspace of a specified type.
classtype | The type of the dataspace to be created. Possible values are:
|
space_id | Dataspace identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Screate()
subroutine h5s::h5screate_simple_f | ( | integer, intent(in) | rank, |
integer(hsize_t), dimension(1:rank), intent(in) | dims, | ||
integer(hid_t), intent(out) | space_id, | ||
integer, intent(out) | hdferr, | ||
integer(hsize_t), dimension(1:rank), intent(in), optional | maxdims | ||
) |
Creates a new simple data space and opens it for access.
rank | Number of dimensions. |
dims | An array of the size of each dimension. |
space_id | Dataspace identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
maxdims | An array of the maximum size of each dimension. |
See C API: H5Screate_simple()
subroutine h5s::h5sdecode_f | ( | character(len=*), intent(in) | buf, |
integer(hid_t), intent(out) | obj_id, | ||
integer, intent(out) | hdferr | ||
) |
Decode a binary object description of data space and return a new object handle.
buf | Buffer for the data space object to be decoded. |
obj_id | Object ID. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sdecode()
subroutine h5s::h5sencode_f | ( | integer(hid_t), intent(in) | obj_id, |
character(len=*), intent(out) | buf, | ||
integer(size_t), intent(inout) | nalloc, | ||
integer, intent(out) | hdferr, | ||
integer(hid_t), intent(in), optional | fapl_id | ||
) |
Encode a data space object description into a binary buffer.
obj_id | Identifier of the object to be encoded. |
buf | Buffer for the object to be encoded into. |
nalloc | The size of the buffer needed. |
hdferr | Returns 0 if successful and -1 if it fails. |
fapl_id | File access property list identifier. |
See C API: H5Sencode2()
subroutine h5s::h5sextent_copy_f | ( | integer(hid_t), intent(in) | dest_space_id, |
integer(hid_t), intent(in) | source_space_id, | ||
integer, intent(out) | hdferr | ||
) |
Copies the extent of a dataspace.
dest_space_id | The identifier for the dataspace to which the extent is copied. |
source_space_id | The identifier for the dataspace from which the extent is copied. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sextent_copy()
subroutine h5s::h5sextent_equal_f | ( | integer(hid_t), intent(in) | space1_id, |
integer(hid_t), intent(in) | space2_id, | ||
logical, intent(out) | equal, | ||
integer, intent(out) | hdferr | ||
) |
Determines whether two dataspace extents are equal.
space1_id | First dataspace identifier. |
space2_id | Second dataspace identifier. |
Equal | .TRUE. if equal, .FALSE. if unequal. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sextent_equal()
subroutine h5s::h5sget_regular_hyperslab_f | ( | integer(hid_t), intent(in) | space_id, |
integer(hsize_t), dimension(*), intent(out), target | start, | ||
integer(hsize_t), dimension(*), intent(out), target | stride, | ||
integer(hsize_t), dimension(*), intent(out), target | count, | ||
integer(hsize_t), dimension(*), intent(out), target | block, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves a regular hyperslab selection.
space_id | The identifier of the dataspace. |
start | Offset of the start of the regular hyperslab. |
stride | Stride of the regular hyperslab. |
count | Number of blocks in the regular hyperslab. |
block | Size of a block in the regular hyperslab. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sget_regular_hyperslab()
subroutine h5s::h5sget_select_bounds_f | ( | integer(hid_t), intent(in) | space_id, |
integer(hsize_t), dimension(*), intent(out) | start, | ||
integer(hsize_t), dimension(*), intent(out) | END, | ||
integer, intent(out) | hdferr | ||
) |
Gets the bounding box containing the current selection.
space_id | Dataspace identifier. |
start | Starting coordinates of bounding box. |
end | Ending coordinates of bounding box, i.e., the coordinates of the diagonally opposite corner. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sget_select_bounds()
subroutine h5s::h5sget_select_elem_npoints_f | ( | integer(hid_t), intent(in) | space_id, |
integer(hssize_t), intent(out) | num_points, | ||
integer, intent(out) | hdferr | ||
) |
Gets the number of element points in the current selection.
space_id | Dataspace identifier. |
num_points | Number of element points in the current dataspace selection |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sget_select_elem_npoints()
subroutine h5s::h5sget_select_elem_pointlist_f | ( | integer(hid_t), intent(in) | space_id, |
integer(hsize_t), intent(in) | startpoint, | ||
integer(hsize_t), intent(in) | num_points, | ||
integer(hsize_t), dimension(*), intent(out) | buf, | ||
integer, intent(out) | hdferr | ||
) |
Gets the list of element points currently selected.
space_id | Dataspace identifier. |
startpoint | Element point to start with. |
num_points | Number of element points to get. |
buf | Buffer with element points selected. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sget_select_elem_pointlist()
subroutine h5s::h5sget_select_hyper_blocklist_f | ( | integer(hid_t), intent(in) | space_id, |
integer(hsize_t), intent(in) | startblock, | ||
integer(hsize_t), intent(in) | num_blocks, | ||
integer(hsize_t), dimension(*), intent(out) | buf, | ||
integer, intent(out) | hdferr | ||
) |
Gets the list of hyperslab blocks currently selected.
space_id | Dataspace identifier. |
startblock | Hyperslab block to start with. |
num_blocks | Number of blocks to get. |
buf | Buffer to hold block list. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sget_select_hyper_blocklist()
subroutine h5s::h5sget_select_hyper_nblocks_f | ( | integer(hid_t), intent(in) | space_id, |
integer(hssize_t), intent(out) | num_blocks, | ||
integer, intent(out) | hdferr | ||
) |
Get number of hyperslab blocks.
space_id | Dataspace identifier. |
num_blocks | Number of hyperslab blocks in the current hyperslab selection. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sget_select_hyper_nblocks()
subroutine h5s::h5sget_select_npoints_f | ( | integer(hid_t), intent(in) | space_id, |
integer(hssize_t), intent(out) | npoints, | ||
integer, intent(out) | hdferr | ||
) |
Determines the number of elements in a dataspace selection.
space_id | Dataspace identifier. |
npoints | Number of points in the dataspace selection. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sget_select_npoints()
subroutine h5s::h5sget_select_type_f | ( | integer(hid_t), intent(inout) | space_id, |
integer, intent(out) | TYPE, | ||
integer, intent(out) | hdferr | ||
) |
Retrieve the type of selection.
space_id | Dataspace identifier with selection. |
type | Selection type flag, valid values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sget_select_type()
subroutine h5s::h5sget_simple_extent_dims_f | ( | integer(hid_t), intent(in) | space_id, |
integer(hsize_t), dimension(*), intent(out) | dims, | ||
integer(hsize_t), dimension(*), intent(out) | maxdims, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves dataspace dimension size and maximum size.
space_id | Dataspace identifier. |
dims | Array to store size of each dimension. |
maxdims | Array to store maximum size of each dimension. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sget_simple_extent_dims()
subroutine h5s::h5sget_simple_extent_ndims_f | ( | integer(hid_t), intent(in) | space_id, |
integer, intent(out) | rank, | ||
integer, intent(out) | hdferr | ||
) |
Determines the dimensionality of a dataspace.
space_id | Dataspace identifier. |
rank | Number of dataspace dimensions. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sget_simple_extent_ndims()
subroutine h5s::h5sget_simple_extent_npoints_f | ( | integer(hid_t), intent(in) | space_id, |
integer(hsize_t), intent(out) | npoints, | ||
integer, intent(out) | hdferr | ||
) |
Determines the number of elements in a dataspace.
space_id | Dataspace identifier. |
npoints | Number of elements in the dataspace. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sget_simple_extent_npoints()
subroutine h5s::h5sget_simple_extent_type_f | ( | integer(hid_t), intent(in) | space_id, |
integer, intent(out) | classtype, | ||
integer, intent(out) | hdferr | ||
) |
Determine the current class of a dataspace.
space_id | Dataspace identifier. |
classtype | Class type, possible values are:
|
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sget_simple_extent_type()
subroutine h5s::h5sis_regular_hyperslab_f | ( | integer(hid_t), intent(in) | space_id, |
logical | IsRegular, | ||
integer, intent(out) | hdferr | ||
) |
Retrieves a regular hyperslab selection.
space_id | The identifier of the dataspace. |
IsRegular | TRUE or FALSE for hyperslab selection if successful. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sis_regular_hyperslab()
subroutine h5s::h5sis_simple_f | ( | integer(hid_t), intent(in) | space_id, |
logical, intent(out) | status, | ||
integer, intent(out) | hdferr | ||
) |
Determines whether a dataspace is a simple dataspace.
space_id | Dataspace identifier. |
status | Flag to indicate if dataspace is simple or not (TRUE or FALSE). |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sis_simple()
subroutine h5s::h5soffset_simple_f | ( | integer(hid_t), intent(in) | space_id, |
integer(hssize_t), dimension(*), intent(in) | offset, | ||
integer, intent(out) | hdferr | ||
) |
Sets the offset of a simple dataspace.
space_id | Dataspace identifier. |
offset | The offset at which to position the selection. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Soffset_simple()
subroutine h5s::h5sselect_all_f | ( | integer(hid_t), intent(in) | space_id, |
integer, intent(out) | hdferr | ||
) |
Selects the entire dataspace.
space_id | Identifier for the dataspace in which selection being made. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sselect_all()
subroutine h5s::h5sselect_elements_f | ( | integer(hid_t), intent(in) | space_id, |
integer, intent(in) | OPERATOR, | ||
integer, intent(in) | rank, | ||
integer(size_t), intent(in) | num_elements, | ||
integer(hsize_t), dimension(rank,num_elements), intent(in) | coord, | ||
integer, intent(out) | hdferr | ||
) |
Selects elements to be included in the selection for a dataspace.
space_id | Dataspace identifier. |
operator | Flag, valid values are:
|
rank | Number of dataspace dimensions. |
num_elements | Number of elements to be selected. |
coord | 2D (rank x num_elements) array with the elements coordinates ( 1-based); in C the array is stored in 2D as (num_element x rank). |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sselect_elements()
subroutine h5s::h5sselect_hyperslab_f | ( | integer(hid_t), intent(in) | space_id, |
integer, intent(in) | OPERATOR, | ||
integer(hsize_t), dimension(*), intent(in) | start, | ||
integer(hsize_t), dimension(*), intent(in) | count, | ||
integer, intent(out) | hdferr, | ||
integer(hsize_t), dimension(:), intent(in), optional | stride, | ||
integer(hsize_t), dimension(:), intent(in), optional | BLOCK | ||
) |
Selects a hyperslab region to add to the current selected region.
space_id | Dataspace identifier. |
operator | Flag, valid values are:
|
start | Array with hyperslab offsets. |
count | Number of blocks included in the hyperslab. |
hdferr | Returns 0 if successful and -1 if it fails. |
stride | Array with hyperslab strides. |
block | Array with hyperslab block sizes. |
See C API: H5Sselect_hyperslab()
subroutine h5s::h5sselect_none_f | ( | integer(hid_t), intent(in) | space_id, |
integer, intent(out) | hdferr | ||
) |
Resets the selection region to include no elements.
space_id | The identifier for the dataspace in which the selection is being reset. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sselect_none()
subroutine h5s::h5sselect_valid_f | ( | integer(hid_t), intent(in) | space_id, |
logical, intent(out) | status, | ||
integer, intent(out) | hdferr | ||
) |
Verifies that the selection is within the extent of the dataspace.
space_id | Identifier for the dataspace for which selection is verified |
status | TRUE if the selection is contained within the extent, FALSE otherwise. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sselect_valid()
subroutine h5s::h5sset_extent_none_f | ( | integer(hid_t), intent(in) | space_id, |
integer, intent(out) | hdferr | ||
) |
Removes the extent from a dataspace.
space_id | Dataspace identifier. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sset_extent_none()
subroutine h5s::h5sset_extent_simple_f | ( | integer(hid_t), intent(in) | space_id, |
integer, intent(in) | rank, | ||
integer(hsize_t), dimension(rank), intent(in) | current_size, | ||
integer(hsize_t), dimension(rank), intent(in) | maximum_size, | ||
integer, intent(out) | hdferr | ||
) |
Sets or resets the size of an existing dataspace.
space_id | Dataspace identifier. |
rank | Dataspace number of dimensions. |
current_size | Array with the new sizes of dimensions. |
maximum_size | Array with the new maximum sizes of dimensions. |
hdferr | Returns 0 if successful and -1 if it fails. |
See C API: H5Sset_extent_simple()
integer(hid_t) h5s_all_f |
H5S_ALL.
integer h5s_null_f |
H5S_NULL.
integer h5s_scalar_f |
H5S_SCALAR.
integer h5s_sel_all_f |
H5S_SEL_ALL.
integer h5s_sel_error_f |
H5S_SEL_ERROR.
integer h5s_sel_hyperslabs_f |
H5S_SEL_HYPERSLABS.
integer h5s_sel_none_f |
H5S_SEL_NONE.
integer h5s_sel_points_f |
H5S_SEL_POINTS.
integer h5s_select_and_f |
H5S_SELECT_AND.
integer h5s_select_append_f |
H5S_SELECT_APPEND.
integer h5s_select_invalid_f |
H5S_SELECT_INVALID.
integer h5s_select_noop_f |
H5S_SELECT_NOOP.
integer h5s_select_nota_f |
H5S_SELECT_NOTA.
integer h5s_select_notb_f |
H5S_SELECT_NOTB.
integer h5s_select_or_f |
H5S_SELECT_OR.
integer h5s_select_prepend_f |
H5S_SELECT_PREPEND.
integer h5s_select_set_f |
H5S_SELECT_SET.
integer h5s_select_xor_f |
H5S_SELECT_XOR.
integer h5s_simple_f |
H5S_SIMPLE.
integer(hsize_t) h5s_unlimited_f |
H5S_UNLIMITED.