Catalog of Functionality > PV-WAVE Foundation > HDF
  

HDF
HDF Routines
GETNCERR
Retrieves the current value of the “ncerr” variable as discussed in the error section of the NetCDF User’s Guide.
GETNCOPTS
Retrieves the current value of the ncopts variable as discussed in the error section of the NetCDF User’s Guide.
HDFGET24
Obtains an HDF Raster 24 image.
HDFGETANN
Obtains HDF object (e.g., an SDS, Raster 8 image, etc.) annotations, either a label or a description.
HDFGETFILEANN
Obtains an HDF file annotation, either label or description.
HDFGETNT
Obtains the HDF number type (i.e., data type) and descriptive number type string for the current HDF Scientific Data Set.
HDFGETR8
Obtains an HDF Raster 8 image and associated palette.
HDFGETRANGE
Gets the maximum and minimum range for the current HDF Scientific Data Set.
HDFGETSDS
Gets an HDF Scientific Data Set.
HDFLCT
Loads an HDF palette as a PV‑WAVE color table.
HDFPUT24
Puts an HDF Raster 24 image into an HDF file.
HDFPUTFILEANN
Inserts HDF file labels and file descriptions (annotations) into a file.
HDFPUTR8
Writes an 8 bit image to an HDF file.
HDFPUTSDS
Writes a Scientific Data Set to an HDF file.
HDFSCAN
Scans an HDF file and prints a simple list of file contents by HDF object type.
HDFSETNT
Computes and sets the HDF number type (i.e., data type) and descriptive number type string for the specified data array.
HDF_STARTUP
A batch file used to initialize the HDF interface.
HDF_TEST
Runs the PV‑WAVE HDF test suite.
SETNCOPTS
Sets the value of the ncopts variable and defines the level of error reporting for the netCDF functions as discussed in the error section of the NetCDF User’s Guide.
HDF5 Attribute Interface
H5ACLOSE
Closes the specified attribute.
H5ACREATE
Creates a dataset as an attribute of another group, dataset, or named datatype.
H5ADELETE
Deletes an attribute from a specified location.
H5AGET_NAME
Gets an attribute name.
H5AGET_NUM_ATTRS
Determines the number of attributes attached to an object.
H5AGET_SPACE
Gets a copy of the dataspace for an attribute.
H5AGET_TYPE
Gets an attribute datatype.
H5AOPEN_IDX
Opens the attribute specified by its index.
H5AOPEN_NAME
Opens an attribute specified by name.
H5AREAD
Reads an attribute.
H5AWRITE
Writes data to an attribute.
HDF5 Dataset Interface
H5DCLOSE
Closes the specified dataset.
H5DCREATE
Creates a new dataset and links it to a location in the file.
H5DEXTEND
Extends a dataset.
H5DGET_CREATE_PLIST
Returns an identifier for a copy of the dataset creation property list for a dataset.
H5DGET_SPACE
Returns an identifier for a copy of the dataspace for a dataset.
H5DGET_STORAGE_SIZE
Returns the amount of storage allocated for a dataset.
H5DGET_TYPE
Returns an identifier for a copy of the datatype for a dataset.
H5DOPEN
Opens an existing dataset.
H5DREAD
Reads data from a dataset.
H5DWRITE
Writes data to a dataset.
HDF5 Error Interface
H5EPRINT
Prints an error stack in a default manner.
H5ESET_AUTO
Turns automatic error printing on or off.
HDF5 File Interface
H5FCLOSE
Terminates access to an HDF5 file.
H5FCREATE
Creates an HDF5 file.
H5FFLUSH
Flushes all buffers associated with a file to disk.
H5FGET_ACCESS_PLIST
Returns a file access property list identifier.
H5FGET_CREATE_PLIST
Returns a file creation property list identifier.
H5FIS_HDF5
Determines whether a file is in the HDF5 format.
H5FMOUNT
Mounts a file.
H5FOPEN
Opens an existing HDF5 file.
H5FREOPEN
Returns a new identifier for a previously-opened HDF5 file.
H5FUNMOUNT
Unmounts a file.
HDF5 Group Interface
H5GCLOSE
Closes the specified group.
H5GCREATE
Creates a new empty group and links it to a location in the file.
H5GGET_COMMENT
Retrieves comment for specified object
H5GGET_LINKVAL
Returns the name of the object that the symbolic link points to.
H5GGET_NUM_OBJS
Returns number of objects in the group specified by its identifier
H5GGET_OBJINFO
Returns information about an object.
H5GGET_OBJNAME_BY_IDX
Returns a name of an object specified by an index.
H5GGET_OBJTYPE_BY_IDX
Returns the type of an object specified by an index.
H5GLINK
Creates a link of the specified type from new_name to current_name.
H5GMOVE
Renames an object within an HDF5 file.
H5GOPEN
Opens an existing group with a group access property list.
H5GSET_COMMENT
Sets comment for specified object.
H5GUNLINK
Removes the link to an object from a group.
HDF5 Identifier Interface
H5IGET_NAME
Retrieves a name of an object based on the object identifier.
H5IGET_TYPE
Retrieves the type of an object.
HDF5 Property List Interface
H5PCLOSE
Terminates access to a property list.
H5PCOPY
Copies an existing property list to create a new property list.
H5PCREATE
Creates a new property as an instance of a property list class.
H5PEQUAL
Compares two property lists or classes for equality.
H5PGET_ALIGNMENT
Retrieves the current settings for alignment properties from a file access property list.
H5PGET_BTREE_RATIOS
Gets B-tree split ratios for a dataset transfer property list.
H5PGET_CACHE
Queries the raw data chunk cache parameters.
H5PGET_CHUNK
Retrieves the size of chunks for the raw data of a chunked layout dataset.
H5PGET_CLASS
Returns the property list class for a property list.
H5PGET_DRIVER
Returns low-level driver identifier.
H5PGET_EXTERNAL
Returns information about an external file.
H5PGET_EXTERNAL_COUNT
Returns the number of external files for a dataset.
H5PGET_FAPL_CORE
Queries core file driver properties.
H5PGET_FAPL_FAMILY
Returns file access property list information.
H5PGET_FILL_VALUE
Retrieves a dataset fill value.
H5PGET_ISTORE_K
Queries the 1/2 rank of an indexed storage B-tree.
H5PGET_LAYOUT
Returns the layout of the raw data for a dataset.
H5PGET_META_BLOCK_SIZE
Returns the current metadata block size setting.
H5PGET_PRESERVE
Checks status of the dataset transfer property list.
H5PGET_SIEVE_BUF_SIZE
Returns maximum data sieve buffer size.
H5PGET_SIZES
Retrieves the size of the offsets and lengths used in an HDF5 file.
H5PGET_SMALL_DATA_BLOCK_SIZE
Retrieves the current small data block size setting.
H5PGET_SYM_K
Retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size.
H5PGET_USERBLOCK
Retrieves the size of a user block.
H5PGET_VERSION
Retrieves the version information of various objects for a file creation property list.
H5PSET_ALIGNMENT
Sets alignment properties of a file access property list.
H5PSET_BTREE_RATIOS
Sets B-tree split ratios for a dataset transfer property list.
H5PSET_CACHE
Sets the raw data chunk cache parameters.
H5PSET_CHUNK
Sets the size of the chunks used to store a chunked layout dataset.
H5PSET_DEFLATE
Sets deflate (GNU gzip) compression method and compression level.
H5PSET_EXTERNAL
Adds an external file to the list of external files.
H5PSET_FAPL_CORE
Modifies the file access property list to use the H5FD_CORE driver.
H5PSET_FAPL_FAMILY
Sets the file access property list to use the family driver.
H5PSET_FAPL_SEC2
Sets the sec2 driver.
H5PSET_FAPL_SPLIT
Emulates the old split file driver.
H5PSET_FAPL_STDIO
Sets the standard I/O driver.
H5PSET_FILL_VALUE
Sets the fill value for a dataset.
H5PSET_ISTORE_K
Sets the size of the parameter used to control the B-trees for indexing chunked datasets.
H5PSET_LAYOUT
Sets the type of storage used to store the raw data for a dataset.
H5PSET_META_BLOCK_SIZE
Sets the minimum metadata block size.
H5PSET_SIEVE_BUF_SIZE
Sets the maximum size of the data sieve buffer.
H5PSET_SIZES
Sets the byte size of the offsets and lengths used to address objects in an HDF5 file.
H5PSET_SMALL_DATA_BLOCK_SIZE
Sets the size of a contiguous block reserved for small data.
H5PSET_SYM_K
Sets the size of parameters used to control the symbol table nodes.
H5PSET_USERBLOCK
Sets user block size.
HDF5 Dataspace Interface
H5SCLOSE
Releases and terminates access to a dataspace.
H5SCOPY
Creates an exact copy of a dataspace.
H5SCREATE
Creates a new dataspace of a specified type.
H5SCREATE_SIMPLE
Creates a new simple dataspace and opens it for access.
H5SEXTENT_COPY
Copies the extent of a dataspace.
H5SGET_SELECT_BOUNDS
Gets the bounding box containing the current selection.
H5SGET_SELECT_ELEM_NPOINTS
Gets the number of element points in the current selection.
H5SGET_SELECT_ELEM_POINTLIST
Gets the list of element points currently selected.
H5SGET_SELECT_HYPER_BLOCKLIST
Gets the list of hyperslab blocks currently selected.
H5SGET_SELECT_HYPER_NBLOCKS
Get number of hyperslab blocks.
H5SGET_SELECT_NPOINTS
Determines the number of elements in a dataspace selection.
H5SGET_SIMPLE_EXTENT_DIMS
Retrieves dataspace dimension size and maximum size.
H5SGET_SIMPLE_EXTENT_NDIMS
Determines the dimensionality of a dataspace.
H5SGET_SIMPLE_EXTENT_NPOINTS
Determines the number of elements in a dataspace.
H5SGET_SIMPLE_EXTENT_TYPE
Determines the current class of a dataspace.
H5SIS_SIMPLE
Determines whether a dataspace is a simple dataspace.
H5SOFFSET_SIMPLE
Sets the offset of a simple dataspace.
H5SSELECT_ALL
Selects an entire dataspace.
H5SSELECT_ELEMENTS
Selects array elements to be included in the selection for a dataspace.
H5SSELECT_HYPERSLAB
Selects a hyperslab region to add to the current selected region.
H5SSELECT_NONE
Resets the selection region to include no elements.
H5SSELECT_VALID
Verifies that the selection is within the extent of the dataspace.
H5SSET_EXTENT_NONE
Removes the extent from a dataspace.
H5SSET_EXTENT_SIMPLE
Sets or resets the size of an existing dataspace.
HDF5 Data Type Interface
H5TARRAY_CREATE
Creates an array datatype object.
H5TCLOSE
Releases a datatype.
H5TCOMMIT
Commits a transient datatype to a file, creating a new named datatype.
H5TCOMMITTED
Determines whether a datatype is a named type or a transient type.
H5TCOPY
Copies an existing datatype.
H5TCREATE
Creates a new datatype.
H5TENUM_CREATE
Creates a new enumeration datatype.
H5TENUM_INSERT
Inserts a new enumeration datatype member.
H5TENUM_NAMEOF
Returns the symbol name corresponding to a specified member of an enumeration datatype.
H5TENUM_VALUEOF
Returns the value corresponding to a specified member of an enumeration datatype.
H5TEQUAL
Determines whether two datatype identifiers refer to the same datatype.
H5TGET_ARRAY_DIMS
Retrieves sizes of array dimensions.
H5TGET_ARRAY_NDIMS
Returns the rank of an array datatype.
H5TGET_CLASS
Returns the datatype class identifier.
H5TGET_CSET
Retrieves the character set type of a string datatype.
H5TGET_EBIAS
Retrieves the exponent bias of a floating-point type.
H5TGET_FIELDS
Retrieves floating point datatype bit field information.
H5TGET_INPAD
Retrieves the internal padding type for unused bits in floating-point datatypes.
H5TGET_MEMBER_CLASS
Returns datatype class of compound datatype member.
H5TGET_MEMBER_INDEX
Retrieves the index of a compound or enumeration datatype member.
H5TGET_MEMBER_NAME
Retrieves the name of a compound or enumeration datatype member.
H5TGET_MEMBER_OFFSET
Retrieves the offset of a field of a compound datatype.
H5TGET_MEMBER_TYPE
Returns the datatype of the specified member.
H5TGET_MEMBER_VALUE
Returns the value of an enumeration datatype member.
H5TGET_NMEMBERS
Retrieves the number of elements in a compound or enumeration datatype.
H5TGET_NORM
Retrieves mantissa normalization of a floating-point datatype.
H5TGET_OFFSET
Retrieves the bit offset of the first significant bit.
H5TGET_ORDER
Returns the byte order of an atomic datatype.
H5TGET_PAD
Retrieves the padding type of the least and most-significant bit padding.
H5TGET_PRECISION
Returns the precision of an atomic datatype.
H5TGET_SIGN
Retrieves the sign type for an integer type.
H5TGET_SIZE
Returns the size of a datatype.
H5TGET_STRPAD
Retrieves the storage mechanism for a string datatype.
H5TGET_SUPER
Returns the base datatype from which a datatype is derived.
H5TINSERT
Adds a new member to a compound datatype.
H5TIS_VARIABLE_STR
Determines whether datatype is a variable-length string.
H5TLOCK
Locks a datatype.
H5TOPEN
Opens a named datatype.
H5TSET_CSET
Sets character set to be used.
H5TSET_EBIAS
Sets the exponent bias of a floating-point type.
H5TSET_FIELDS
Sets locations and sizes of floating point bit fields.
H5TSET_INPAD
Fills unused internal floating point bits.
H5TSET_NORM
Sets the mantissa normalization of a floating-point datatype.
H5TSET_OFFSET
Sets the bit offset of the first significant bit.
H5TSET_ORDER
Sets the byte order of a datatype.
H5TSET_PAD
Sets the least and most-significant bits padding types.
H5TSET_PRECISION
Sets the precision of an atomic datatype.
H5TSET_SIGN
Sets the sign property for an integer type.
H5TSET_SIZE
Sets the total size for an atomic datatype.
H5TSET_STRPAD
Defines the storage mechanism for character strings.
H5TVLEN_CREATE
Creates a new variable-length datatype.
HDF5 General Functions
H5CHECK_VERSION
Verifies that HDF5 library versions are consistent.
H5CLOSE
Flushes all data to disk, closes all open identifiers, and cleans up memory.
H5GET_LIBVERSION
Returns the HDF library release number.

Version 2017.0
Copyright © 2017, Rogue Wave Software, Inc. All Rights Reserved.