HDF5 documents and links Introduction to HDF5 HDF5 User Guide Other High-level API documents |
And in this document, the
HDF5 Reference Manual
H5DS H5IM H5LT H5PT H5TB H5 H5A H5D H5E H5F H5G H5I H5L H5O H5P H5R H5S H5T H5Z Tools Datatypes |
The C Interfaces:
If dimname is specified, then an attribute called NAME is created, with the value dimname.
Fails if:
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.)
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. |
Entries are created in the DIMENSION_LIST and REFERENCE_LIST attributes, as defined in section 4.2.
Fails if:
Note: The Dimension Scale dsid can be attached to the same dimension more than once, which has no effect.
hid_t did; | IN: the dataset |
hid_t dsid; | IN: the scale to be attached |
unsigned int idx; | IN: the dimension of did that dsid is associated with. |
Fails if:
Note that a scale may be associated with more than dimension of the same dataset. If so, the detach operation only deletes one of the associations, for did.
hid_t did; | IN: the dataset |
hid_t dsid; | IN: the scale to be detached |
unsigned int idx; | IN: the dimension of did to detach |
Fails if:
hid_t did; | IN: the dataset |
hid_t dsid; | IN: the scale to be attached |
unsigned int idx; | IN: the dimension of did that dsid is associated with. |
The operation receives the Dimension Scale dataset identifier, dsid, and the pointer to the operator data passed in to H5DDiterate_scales, visitor_data.
The return values from an operator are:
H5DSiterate_scales assumes that the scales of the dimension identified by dim remain unchanged through the iteration. If the membership changes during the iteration, the function's behavior is undefined.
hid_t did; | IN: the dataset |
unsigned dim; | IN: the dimension of dataset did |
int *idx; | IN/OUT: input the index to start iterating, output the next index to visit. If NULL, start at the first position. |
H5DS_iterate_t visitor; | IN: the visitor function |
void *visitor_data; | IN: arbitrary data to pass to the visitor function. |
Fails if:
hid_t did; | IN: the dataset |
unsigned int idx; | IN: the dimension |
char *label; | IN: the label |
If did has no label, the return value of label is NULL.
Fails if:
hid_t did; | IN: the dataset |
unsigned int idx; | IN: the dimension |
char *label; | OUT: the label |
size_t size; | IN: the length of the label buffer. |
int did; | IN: dimension scale identifier |
char *name; | OUT: the name, or NULL if there is no name set. |
size_t size; | IN: the maximum characters to copy into name. |
hid_t did; | IN: the data set to query |
hid_t did; | IN: the data set to query |
unsigned int idx; | IN: the dimension of did to query. |
HDF5 documents and links Introduction to HDF5 HDF5 User Guide Other High-level API documents |
And in this document, the
HDF5 Reference Manual
H5DS H5IM H5LT H5PT H5TB H5 H5A H5D H5E H5F H5G H5I H5L H5O H5P H5R H5S H5T H5Z Tools Datatypes |