Convert dataset dsid to a dimension scale, with optional name, dimname.
Procedure:
H5DS_SET_SCALE(dsid, dimname)
Signature:
herr_t H5DSset_scale(hid_t dsid, char *dimname)
SUBROUTINE H5DSset_scale_f(dsid, errcode, dimname)
IMPLICIT NONE
INTEGER(hid_t), INTENT(in) :: dsid ! The dataset to be made
! a Dimension Scale
INTEGER :: errcode ! Error code
CHARACTER(LEN=*), INTENT(in), OPTIONAL :: dimname ! The dimension name
END SUBROUTINE H5DSset_scale_f
Parameters:
hid_t dsid; | IN: the dataset to be made a Dimension Scale |
char *dimname; | IN: the dimension name (optional), NULL if the dimension has no name. |
Description:
The dataset dsid is converted to a Dimension Scale dataset, as defined above. Creates the CLASS attribute, set to the value "DIMENSION_SCALE" and an empty REFERENCE_LIST attribute, as described in “HDF5 Dimension Scale Specification” (PDF, see section 4.2).
If dimname is specified, then an attribute called NAME is created, with the value dimname.
Fails if:
- Bad arguments
- If dsid is already a scale
- If dsid is a dataset which already has dimension scales
If the dataset was created with the Table, Image, or Palette interface [9], it is not recommended to convert to a Dimension Scale. (These Datasets will have a CLASS Table, Image, or Palette.)
Returns:
Zero if succeed, negative if fail.
Example:
--- Last Modified: December 04, 2017 | 07:25 AM