Please, help us to better serve our user community by answering the following short survey: https://www.hdfgroup.org/website-survey/
HDF5 1.14.5
API Reference
Loading...
Searching...
No Matches
Fortran High Level Dimension Scales (H5DS) Interface

Detailed Description

See also
HDF5 Dimension Scales APIs (H5DS), C-HL API
HDF5 High Level Dimension Scales, User Guide

Modules

module  h5ds
 This module contains Fortran interfaces for H5DS.
 

Functions/Subroutines

subroutine h5dsset_scale_f (dsid, errcode, dimname)
 Convert dataset dsid to a dimension scale, with optional name, dimname.
 
subroutine h5dsattach_scale_f (did, dsid, idx, errcode)
 Attach dimension scale dsid to dimension idx of dataset did.
 
subroutine h5dsdetach_scale_f (did, dsid, idx, errcode)
 Detach dimension scale dsid from the dimension idx of dataset did.
 
subroutine h5dsis_attached_f (did, dsid, idx, is_attached, errcode)
 Report if dimension scale dsid is currently attached to dimension idx of dataset did.
 
subroutine h5dsis_scale_f (did, is_scale, errcode)
 Determines whether did is a Dimension Scale.
 
subroutine h5dsset_label_f (did, idx, label, errcode)
 Set label for the dimension idx of did to the value label.
 
subroutine h5dsget_label_f (did, idx, label, size, errcode)
 Read the label for dimension idx of did into buffer label.
 
subroutine h5dsget_scale_name_f (did, name, size, errcode)
 Read the name of scale did into buffer name.
 
subroutine h5dsget_num_scales_f (did, idx, num_scales, errcode)
 Determines how many Dimension Scales are attached to dimension idx of did.
 

Function/Subroutine Documentation

◆ h5dsattach_scale_f()

subroutine h5dsattach_scale_f ( integer(hid_t), intent(in)  did,
integer(hid_t), intent(in)  dsid,
integer, intent(in)  idx,
integer  errcode 
)

Attach dimension scale dsid to dimension idx of dataset did.

Parameters
didThe dataset.
dsidThe scale to be attached.
idxThe dimension of did that dsid is associated with.
errcodeReturns 0 if successful and -1 if it fails.

See C API: H5DSattach_scale()

◆ h5dsdetach_scale_f()

subroutine h5dsdetach_scale_f ( integer(hid_t), intent(in)  did,
integer(hid_t), intent(in)  dsid,
integer, intent(in)  idx,
integer  errcode 
)

Detach dimension scale dsid from the dimension idx of dataset did.

Parameters
didThe dataset.
dsidThe scale to be detached.
idxThe dimension of did to detach.
errcodeReturns 0 if successful and -1 if it fails.

◆ h5dsget_label_f()

subroutine h5dsget_label_f ( integer(hid_t), intent(in)  did,
integer, intent(in)  idx,
character(len=*), intent(inout)  label,
integer(size_t), intent(inout)  size,
integer  errcode 
)

Read the label for dimension idx of did into buffer label.

Parameters
didThe dataset.
idxThe dimension.
labelThe label.
sizeThe length of the label buffer.
errcodeReturns 0 if successful and -1 if it fails.

See C API: H5DSget_label()

◆ h5dsget_num_scales_f()

subroutine h5dsget_num_scales_f ( integer(hid_t), intent(in)  did,
integer, intent(in)  idx,
integer, intent(inout)  num_scales,
integer  errcode 
)

Determines how many Dimension Scales are attached to dimension idx of did.

Parameters
didThe dataset to query.
idxThe dimension of did to query.
num_scalesNumber of Dimension Scales associated with did.
errcodeReturns 0 if successful and -1 if it fails.

See C API: H5DSget_num_scales()

◆ h5dsget_scale_name_f()

subroutine h5dsget_scale_name_f ( integer(hid_t), intent(in)  did,
character(len=*), intent(inout)  name,
integer(size_t), intent(inout)  size,
integer  errcode 
)

Read the name of scale did into buffer name.

Parameters
didDimension scale identifier.
nameBuffer to contain the returned name.
sizeSize in bytes, of the name buffer.
errcodeReturns 0 if successful and -1 if it fails.

See C API: H5DSget_scale_name()

◆ h5dsis_attached_f()

subroutine h5dsis_attached_f ( integer(hid_t), intent(in)  did,
integer(hid_t), intent(in)  dsid,
integer, intent(in)  idx,
logical, intent(out)  is_attached,
integer  errcode 
)

Report if dimension scale dsid is currently attached to dimension idx of dataset did.

Parameters
didThe dataset.
dsidThe scale to be attached.
idxThe dimension of did that dsid is associated with.
is_attachedIf dimension scale dsid is currently attached to dimension idx of dataset did.
errcodeReturns 0 if successful and -1 if it fails.

See C API: H5DSis_attached()

◆ h5dsis_scale_f()

subroutine h5dsis_scale_f ( integer(hid_t), intent(in)  did,
logical, intent(out)  is_scale,
integer, intent(out)  errcode 
)

Determines whether did is a Dimension Scale.

Parameters
didThe data set to query.
is_scaleIf is a Dimension Scale.
errcodeReturns 0 if successful and -1 if it fails.

See C API: H5DSis_scale()

◆ h5dsset_label_f()

subroutine h5dsset_label_f ( integer(hid_t), intent(in)  did,
integer, intent(in)  idx,
character(len=*), intent(in)  label,
integer  errcode 
)

Set label for the dimension idx of did to the value label.

Parameters
didThe data set.
idxThe dimension.
labelThe label.
errcodeReturns 0 if successful and -1 if it fails.

See C API: H5DSset_label()

◆ h5dsset_scale_f()

subroutine h5dsset_scale_f ( integer(hid_t), intent(in)  dsid,
integer  errcode,
character(len=*), intent(in), optional  dimname 
)

Convert dataset dsid to a dimension scale, with optional name, dimname.

Parameters
dsidThe dataset to be made a Dimemsion Scale.
errcodeReturns 0 if successful and -1 if it fails.
dimnameThe dimension name

See C API: H5DSset_scale()