ncsa.hdf.hdf5lib.H5
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
public class H5
This class is the Java interface for the HDF5 library.
This code is the called by Java programs to access the entry points of the HDF5 1.2 library. Each routine wraps a single HDF5 entry point, generally with the arguments and return codes analogous to the C interface.
For details of the HDF5 library, see the HDF5 Documentation at: http://hdf.ncsa.uiuc.edu/HDF5/
Mapping of arguments for Java
In general, arguments to the HDF Java API are straightforward translations from the 'C' API described in the HDF Reference Manual.
| HDF-5 | Java |
| H5T_NATIVE_INT | int, Integer |
| H5T_NATIVE_SHORT | short, Short |
| H5T_NATIVE_FLOAT | float, Float |
| H5T_NATIVE_DOUBLE | double, Double |
| H5T_NATIVE_CHAR | byte, Byte |
| H5T_C_S1 | java.lang.String |
| void * (i.e., pointer to `Any') | Special -- see HDFArray |
In general, arguments passed IN to Java are the analogous basic types, as above. The exception is for arrays, which are discussed below.
The return value of Java methods is also the analogous type, as above. A major exception to that rule is that all HDF functions that return SUCCEED/FAIL are declared boolean in the Java version, rather than int as in the C. Functions that return a value or else FAIL are declared the equivalent to the C function. However, in most cases the Java method will raise an exception instead of returning an error code. See Errors and Exceptions below.
Java does not support pass by reference of arguments, so arguments that are returned through OUT parameters must be wrapped in an object or array. The Java API for HDF consistently wraps arguments in arrays.
For instance, a function that returns two integers is declared:
h_err_t HDF5dummy( int *a1, int *a2)
For the Java interface, this would be declared:
public synchronized static native int HDF5dummy( int args[] );
where a1 is args[0]
and a2 is args[1], and would be invoked:
H5.HDF5dummy( a );
All the routines where this convention is used will have specific documentation of the details, given below.
HDF5 needs to read and write multi-dimensional arrays of any number type (and records). The HDF5 API describes the layout of the source and destination, and the data for the array passed as a block of bytes, for instance,
herr_t H5Dread(int fid, int filetype, int memtype, int memspace,
void * data);
where ``void *'' means that the data may be any valid numeric type, and is a contiguous block of bytes that is the data for a multi-dimensional array. The other parameters describe the dimensions, rank, and datatype of the array on disk (source) and in memory (destination).
For Java, this ``ANY'' is a problem, as the type of data must
always be declared. Furthermore, multidimensional arrays
are definitely not layed out contiguously
in memory.
It would be infeasible to declare a separate routine for
every combination of number type and dimensionality.
For that reason, the
HDF-5 Constants
The HDF-5 API defines a set of constants and enumerated values.
Most of these values are available to Java programs via the class
HDF5Constants.
For example, the parameters for the h5open() call include two
numeric values, HDFConstants.H5F_ACC_RDWR and
HDF5Constants.H5P_DEFAULT. As would be expected,
these numbers correspond to the C constants H5F_ACC_RDWR
and H5P_DEFAULT.
The HDF-5 API defines a set of values that describe number types and
sizes, such as "H5T_NATIVE_INT" and "hsize_t". These values are
determined at run time by the HDF-5 C library.
To support these parameters,
the Java class
HDF5CDataTypes looks up the values when
initiated. The values can be accessed as public variables of the
Java class, such as:
Error handling and Exceptions
The HDF5 error API (H5E) manages the behavior of the error stack in
the HDF-5 library. This API is omitted from the JHI5. Errors
are converted into Java exceptions. This is totally different from the
C interface, but is very natural for Java programming.
The exceptions of the JHI5 are organized as sub-classes of the class
HDF5Exception. There are two subclasses of
HDF5Exception,
HDF5LibraryException
and
HDF5JavaException. The sub-classes of the former
represent errors from the HDF-5 C library, while sub-classes of the latter
represent errors in the JHI5 wrapper and support code.
The super-class HDF5LibraryException implements the method
'printStackTrace()', which prints out the HDF-5 error stack,
as described in the HDF-5 C API H5Eprint(). This may
be used by Java exception handlers to print out the HDF-5 error stack.
int data_type = HDF5CDataTypes.JH5T_NATIVE_INT;
The Java application uses both types of constants the same way, the only
difference is that the HDF5CDataTypes may have different
values on different platforms.
| Field Summary | |
|---|---|
static java.lang.String |
H5PATH_PROPERTY_KEY
|
| Constructor Summary | |
|---|---|
H5()
|
|
| Method Summary | |
|---|---|
static int |
H5Aclose(int attr_id)
H5Aclose terminates access to the attribute specified by its identifier, attr_id. |
static int |
H5Acopy(int src_aid,
int dst_aid)
H5Acopy copies the content of one attribute to another. |
static int |
H5Acreate(int loc_id,
java.lang.String name,
int type_id,
int space_id,
int create_plist)
H5Acreate creates an attribute which is attached to the object specified with loc_id. |
static int |
H5Adelete(int loc_id,
java.lang.String name)
H5Adelete removes the attribute specified by its name, name, from a dataset, group, or named datatype. |
static long |
H5Aget_name(int attr_id,
long buf_size,
java.lang.String[] name)
H5Aget_name retrieves the name of an attribute specified by the identifier, attr_id. |
static int |
H5Aget_num_attrs(int loc_id)
H5Aget_num_attrs returns the number of attributes attached to the object specified by its identifier, loc_id. |
static int |
H5Aget_space(int attr_id)
H5Aget_space retrieves a copy of the dataspace for an attribute. |
static int |
H5Aget_type(int attr_id)
H5Aget_type retrieves a copy of the datatype for an attribute. |
static int |
H5Aopen_idx(int loc_id,
int idx)
H5Aopen_idx opens an attribute which is attached to the object specified with loc_id. |
static int |
H5Aopen_name(int loc_id,
java.lang.String name)
H5Aopen_name opens an attribute specified by its name, name, which is attached to the object specified with loc_id. |
static int |
H5Aread(int attr_id,
int mem_type_id,
byte[] buf)
H5Aread reads an attribute, specified with attr_id. |
static int |
H5Aread(int attr_id,
int mem_type_id,
java.lang.Object obj)
H5Aread reads an attribute, specified with attr_id. |
static int |
H5AreadVL(int attr_id,
int mem_type_id,
java.lang.String[] buf)
|
static int |
H5Awrite(int attr_id,
int mem_type_id,
byte[] buf)
H5Awrite writes an attribute, specified with attr_id. |
static int |
H5Awrite(int attr_id,
int mem_type_id,
java.lang.Object obj)
H5Awrite writes an attribute, specified with attr_id. |
static int |
H5check_version(int majnum,
int minnum,
int relnum)
H5check_version verifies that the arguments match the version numbers compiled into the library. |
static int |
H5close()
H5close flushes all data to disk, closes all file identifiers, and cleans up all memory used by the library. |
static int |
H5Dchdir_ext(java.lang.String dir_name)
|
static int |
H5Dclose(int dataset_id)
H5Dclose ends access to a dataset specified by dataset_id and releases resources used by it. |
static int |
H5Dcopy(int src_did,
int dst_did)
H5Dcopy copies the content of one dataset to another dataset. |
static int |
H5Dcreate(int loc_id,
java.lang.String name,
int type_id,
int space_id,
int create_plist_id)
H5Dcreate creates a data set with a name, name, in the file or in the group specified by the identifier loc_id. |
static int |
H5Dextend(int dataset_id,
byte[] size)
H5Dextend verifies that the dataset is at least of size size. |
static int |
H5Dextend(int dataset_id,
long[] size)
|
static int |
H5Dget_create_plist(int dataset_id)
H5Dget_create_plist returns an identifier for a copy of the dataset creation property list for a dataset. |
static int |
H5Dget_space_status(int dset_id,
int[] status)
|
static int |
H5Dget_space(int dataset_id)
H5Dget_space returns an identifier for a copy of the dataspace for a dataset. |
static long |
H5Dget_storage_size(int dataset_id)
H5Dget_storage_size returns the amount of storage that is required for the dataset. |
static int |
H5Dget_type(int dataset_id)
H5Dget_type returns an identifier for a copy of the datatype for a dataset. |
static int |
H5Dgetdir_ext(java.lang.String[] dir_name,
int size)
|
static int |
H5Dopen(int loc_id,
java.lang.String name)
H5Dopen opens an existing dataset for access in the file or group specified in loc_id. |
static int |
H5Dread_double(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
double[] buf)
|
static int |
H5Dread_float(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
float[] buf)
|
static int |
H5Dread_int(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
int[] buf)
|
static int |
H5Dread_long(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
long[] buf)
|
static int |
H5Dread_reg_ref(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.String[] buf)
|
static int |
H5Dread_short(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
short[] buf)
|
static int |
H5Dread_string(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.String[] buf)
|
static int |
H5Dread(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
byte[] buf)
H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application memory buffer buf. |
static int |
H5Dread(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object obj)
H5Dread reads a (partial) dataset, specified by its identifier dataset_id, from the file into the application data object. |
static int |
H5DreadVL(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object[] buf)
|
static int |
H5Dvlen_get_buf_size(int dataset_id,
int type_id,
int space_id,
int[] size)
|
static int |
H5Dvlen_reclaim(int type_id,
int space_id,
int xfer_plist_id,
byte[] buf)
|
static int |
H5Dwrite_double(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
double[] buf)
|
static int |
H5Dwrite_float(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
float[] buf)
|
static int |
H5Dwrite_int(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
int[] buf)
|
static int |
H5Dwrite_long(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
long[] buf)
|
static int |
H5Dwrite_short(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
short[] buf)
|
static int |
H5Dwrite(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
byte[] buf)
H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory buffer buf into the file. |
static int |
H5Dwrite(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.Object obj)
H5Dwrite writes a (partial) dataset, specified by its identifier dataset_id, from the application memory data object into the file. |
static int |
H5DwriteString(int dataset_id,
int mem_type_id,
int mem_space_id,
int file_space_id,
int xfer_plist_id,
java.lang.String[] buf)
H5DwriteString writes a (partial) variable length String dataset, specified by its identifier dataset_id, from the application memory buffer buf into the file. |
static int |
H5Eclear()
H5Eclear clears the error stack for the current thread. |
static int |
H5error_off()
Turn off error handling By default, the C library prints the error stack of the HDF-5 C library on stdout. |
static int |
H5Fclose(int file_id)
H5Fclose terminates access to an HDF5 file. |
static int |
H5Fcreate(java.lang.String name,
int flags,
int create_id,
int access_id)
H5Fcreate is the primary function for creating HDF5 files. |
static int |
H5Fflush(int object_id,
int scope)
H5Fflush causes all buffers associated with a file or object to be immediately flushed (written) to disk without removing the data from the (memory) cache. |
static int |
H5Fget_access_plist(int file_id)
H5Fget_access_plist returns the file access property list identifier of the specified file. |
static int |
H5Fget_create_plist(int file_id)
H5Fget_create_plist returns a file creation property list identifier identifying the creation properties used to create this file. |
static long |
H5Fget_filesize(int file_id)
|
static long |
H5Fget_name(int obj_id,
java.lang.String name,
int size)
|
static int |
H5Fget_obj_count(int file_id,
int types)
|
static int |
H5Fget_obj_ids(int file_id,
int types,
int max,
int[] obj_id_list)
|
static boolean |
H5Fis_hdf5(java.lang.String name)
H5Fis_hdf5 determines whether a file is in the HDF5 format. |
static int |
H5Fmount(int loc_id,
java.lang.String name,
int child_id,
int plist_id)
H5Fmount mounts the file specified by child_id onto the group specified by loc_id and name using the mount properties plist_id. |
static int |
H5Fopen(java.lang.String name,
int flags,
int access_id)
H5Fopen opens an existing file and is the primary function for accessing existing HDF5 files. |
static int |
H5Freopen(int file_id)
H5Freopen reopens an HDF5 file. |
static int |
H5Funmount(int loc_id,
java.lang.String name)
Given a mount point, H5Funmount dissassociates the mount point's file from the file mounted there. |
static int |
H5garbage_collect()
H5garbage_collect collects on all free-lists of all types. |
static int |
H5Gclose(int group_id)
H5Gclose releases resources used by a group which was opened by a call to H5Gcreate() or H5Gopen(). |
static int |
H5Gcreate(int loc_id,
java.lang.String name,
int size_hint)
H5Gcreate creates a new group with the specified name at the specified location, loc_id. |
static int |
H5get_libversion(int[] libversion)
H5get_libversion retrieves the major, minor, and release numbers of the version of the HDF library which is linked to the application. |
static int |
H5Gget_comment(int loc_id,
java.lang.String name,
int bufsize,
java.lang.String[] comment)
H5Gget_comment retrieves the comment for the the object name. |
static int |
H5Gget_linkval(int loc_id,
java.lang.String name,
int size,
java.lang.String[] value)
H5Gget_linkval returns size characters of the link value through the value argument if loc_id (a file or group identifier) and name specify a symbolic link. |
static int |
H5Gget_num_objs(int loc_id,
long[] num_obj)
Returns number of objects in the group specified by its identifier |
static int |
H5Gget_obj_info_all(int loc_id,
java.lang.String name,
java.lang.String[] oname,
int[] type)
|
static int |
H5Gget_obj_info_all(int loc_id,
java.lang.String name,
java.lang.String[] oname,
int[] type,
int n)
|
static int |
H5Gget_obj_info_idx(int loc_id,
java.lang.String name,
int idx,
java.lang.String[] oname,
int[] type)
H5Gget_obj_info_idx report the name and type of object with index 'idx' in a Group. |
static int |
H5Gget_objinfo(int loc_id,
java.lang.String name,
boolean follow_link,
HDF5GroupInfo info)
H5Gget_objinfo returns information about the specified object in an HDF5GroupInfo object. |
static int |
H5Gget_objinfo(int loc_id,
java.lang.String name,
boolean follow_link,
long[] fileno,
long[] objno,
int[] link_info,
long[] mtime)
H5Gget_objinfo returns information about the specified object. |
static long |
H5Gget_objname_by_idx(int group_id,
long idx,
java.lang.String[] name,
long size)
Returns a name of an object specified by an index. |
static int |
H5Gget_objtype_by_idx(int group_id,
long idx)
Returns the type of an object specified by an index. |
static int |
H5Glink(int loc_id,
int link_type,
java.lang.String current_name,
java.lang.String new_name)
H5Glink creates a new name for an already existing object. |
static int |
H5Glink2(int curr_loc_id,
java.lang.String current_name,
int link_type,
int new_loc_id,
java.lang.String new_name)
|
static int |
H5Gmove(int loc_id,
java.lang.String src,
java.lang.String dst)
H5Gmove renames an object within an HDF5 file. |
static int |
H5Gn_members(int loc_id,
java.lang.String name)
H5Gn_members report the number of objects in a Group. |
static int |
H5Gopen(int loc_id,
java.lang.String name)
H5Gopen opens an existing group with the specified name at the specified location, loc_id. |
static int |
H5Gset_comment(int loc_id,
java.lang.String name,
java.lang.String comment)
H5Gset_comment sets the comment for the the object name to comment. |
static int |
H5Gunlink(int loc_id,
java.lang.String name)
H5Gunlink removes an association between a name and an object. |
static int |
H5Idec_ref(int obj_id)
|
static int |
H5Iget_file_id(int obj_id)
|
static long |
H5Iget_name(int obj_id,
java.lang.String[] name,
long size)
|
static int |
H5Iget_ref(int obj_id)
|
static int |
H5Iget_type(int obj_id)
H5Iget_type retrieves the type of the object identified by obj_id. |
static int |
H5Iinc_ref(int obj_id)
|
static int |
H5INcreate(java.lang.String grp_name,
int grp_loc_id,
int property_list,
int data_loc_id,
java.lang.String data_loc_name,
java.lang.String field_name,
long max_mem_size)
|
static int |
H5INquery(int dset_id,
java.lang.String[] keys,
java.lang.Object ubounds,
java.lang.Object lbounds,
int nkeys)
|
static int |
H5open()
H5open initialize the library. |
static boolean |
H5Pall_filters_avail(int dcpl_id)
|
static int |
H5Pclose_class(int plid)
Closes an existing property list class |
static int |
H5Pclose(int plist)
H5Pclose terminates access to a property list. |
static int |
H5Pcopy_prop(int dst_id,
int src_id,
java.lang.String name)
H5Pcopy_prop copies a property from one property list or class to another |
static int |
H5Pcopy(int plist)
H5Pcopy copies an existing property list to create a new property list. |
static int |
H5Pcreate_list(int cls)
Creates a new property list class of a given class |
static int |
H5Pcreate(int type)
H5Pcreate creates a new property as an instance of some property list class. |
static int |
H5Pequal(int plid1,
int plid2)
H5Pequal determines if two property lists or classes are equal |
static int |
H5Pexist(int plid,
java.lang.String name)
H5Pexist determines whether a property exists within a property list or class |
static int |
H5Pfill_value_defined(int plist_id,
int[] status)
|
static int |
H5Pget_alignment(int plist,
long[] alignment)
H5Pget_alignment retrieves the current settings for alignment properties from a file access property list. |
static int |
H5Pget_alloc_time(int plist_id,
int[] alloc_time)
|
static int |
H5Pget_btree_ratios(int plist_id,
double[] left,
double[] middle,
double[] right)
H5Pget_btree_ratio Get the B-tree split ratios for a dataset transfer property list. |
static int |
H5Pget_buffer(int plist,
byte[] tconv,
byte[] bkg)
HH5Pget_buffer gets type conversion and background buffers. |
static int |
H5Pget_cache(int plist,
int[] mdc_nelmts,
int[] rdcc_nelmts,
int[] rdcc_nbytes,
double[] rdcc_w0)
Retrieves the maximum possible number of elements in the meta data cache and the maximum possible number of bytes and the RDCC_W0 value in the raw data chunk cache. |
static int |
H5Pget_chunk(int plist,
int max_ndims,
long[] dims)
H5Pget_chunk retrieves the size of chunks for the raw data of a chunked layout dataset. |
static java.lang.String |
H5Pget_class_name(int plid)
H5Pget_class_name retrieves the name of a generic property list class |
static int |
H5Pget_class_parent(int plid)
H5Pget_class_parent retrieves an identifier for the parent class of a property class |
static int |
H5Pget_class(int plist)
H5Pget_class returns the property list class for the property list identified by the plist parameter. |
static int |
H5Pget_edc_check(int plist)
|
static int |
H5Pget_external_count(int plist)
H5Pget_external_count returns the number of external files for the specified dataset. |
static int |
H5Pget_external(int plist,
int idx,
int name_size,
java.lang.String[] name,
long[] size)
H5Pget_external returns information about an external file. |
static long |
H5Pget_family_offset(int fapl_id)
|
static int |
H5Pget_fapl_core(int fapl_id,
int[] increment,
boolean[] backing_store)
|
static int |
H5Pget_fapl_family(int fapl_id,
long[] memb_size,
int[] memb_fapl_id)
|
static int |
H5Pget_fclose_degree(int plist_id)
|
static int |
H5Pget_fill_time(int plist_id,
int[] fill_time)
|
static int |
H5Pget_fill_value(int plist_id,
int type_id,
byte[] value)
H5Pget_fill_value queries the fill value property of a dataset creation property list. |
static int |
H5Pget_fill_value(int plist_id,
int type_id,
java.lang.Object obj)
H5Pget_fill_value queries the fill value property of a dataset creation property list. |
static int |
H5Pget_filter_by_id(int plist_id,
int filter,
int[] flags,
long[] cd_nelmts,
int[] cd_values,
long namelen,
java.lang.String[] name)
|
static int |
H5Pget_filter(int plist,
int filter_number,
int[] flags,
int[] cd_nelmts,
int[] cd_values,
int namelen,
java.lang.String[] name)
H5Pget_filter returns information about a filter, specified by its filter number, in a filter pipeline, specified by the property list with which it is associated. |
static int |
H5Pget_gc_reference(int fapl_id,
boolean[] gc_ref)
|
static int |
H5Pget_gc_references(int fapl_id,
boolean[] gc_ref)
H5Pget_gc_references Returns the current setting for the garbage collection refernces property from a file access property list. |
static int |
H5Pget_hyper_vector_size(int dxpl_id,
long[] vector_size)
|
static int |
H5Pget_istore_k(int plist,
int[] ik)
H5Pget_istore_k queries the 1/2 rank of an indexed storage B-tree. |
static int |
H5Pget_layout(int plist)
H5Pget_layout returns the layout of the raw data for a dataset. |
static int |
H5Pget_nfilters(int plist)
H5Pget_nfilters returns the number of filters defined in the filter pipeline associated with the property list plist. |
static long |
H5Pget_nprops(int plid)
H5Pget_nprops retrieves the number of properties in a property list or class |
static int |
H5Pget_preserve(int plist)
H5Pget_preserve checks the status of the dataset transfer property list. |
static long |
H5Pget_size(int plid,
java.lang.String name)
H5Pget_size retrieves the size of a property's value in bytes |
static int |
H5Pget_sizes(int plist,
int[] size)
H5Pget_sizes retrieves the size of the offsets and lengths used in an HDF5 file. |
static int |
H5Pget_small_data_block_size(int plist,
long[] size)
H5Pget_small_data_block_size retrieves the size of a block of small data in a file creation property list. |
static int |
H5Pget_sym_k(int plist,
int[] size)
H5Pget_sym_k retrieves the size of the symbol table B-tree 1/2 rank and the symbol table leaf node 1/2 size. |
static int |
H5Pget_userblock(int plist,
long[] size)
H5Pget_userblock retrieves the size of a user block in a file creation property list. |
static int |
H5Pget_version(int plist,
int[] version_info)
H5Pget_version retrieves the version information of various objects for a file creation property list. |
static int |
H5Pget(int plid,
java.lang.String name)
H5Pget retrieves a copy of the value for a property in a property list (support integer only) |
static int |
H5Pisa_class(int plist,
int pclass)
H5Pisa_class checks to determine whether a property list is a member of the specified class |
static int |
H5Pmodify_filter(int plist,
int filter,
int flags,
long cd_nelmts,
int[] cd_values)
|
static int |
H5Premove_filter(int obj_id,
int filter)
|
static int |
H5Premove(int plid,
java.lang.String name)
H5Premove removes a property from a property list |
static int |
H5Pset_alignment(int plist,
long threshold,
long alignment)
H5Pset_alignment sets the alignment properties of a file access property list so that any file object >= THRESHOLD bytes will be aligned on an address which is a multiple of ALIGNMENT. |
static int |
H5Pset_alloc_time(int plist_id,
int alloc_time)
|
static int |
H5Pset_btree_ratios(int plist_id,
double left,
double middle,
double right)
H5Pset_btree_ratio Sets B-tree split ratios for a dataset transfer property list. |
static int |
H5Pset_buffer(int plist,
int size,
byte[] tconv,
byte[] bkg)
H5Pset_buffer sets type conversion and background buffers. |
static int |
H5Pset_cache(int plist,
int mdc_nelmts,
int rdcc_nelmts,
int rdcc_nbytes,
double rdcc_w0)
H5Pset_cache sets the number of elements (objects) in the meta data cache and the total number of bytes in the raw data chunk cache. |
static int |
H5Pset_chunk(int plist,
int ndims,
byte[] dim)
H5Pset_chunk sets the size of the chunks used to store a chunked layout dataset. |
static int |
H5Pset_chunk(int plist,
int ndims,
long[] dim)
|
static int |
H5Pset_deflate(int plist,
int level)
H5Pset_deflate sets the compression method for a dataset. |
static int |
H5Pset_edc_check(int plist,
int check)
|
static int |
H5Pset_external(int plist,
java.lang.String name,
long offset,
long size)
H5Pset_external adds an external file to the list of external files. |
static int |
H5Pset_family_offset(int fapl_id,
long offset)
|
static int |
H5Pset_fapl_core(int fapl_id,
int increment,
boolean backing_store)
|
static int |
H5Pset_fapl_family(int fapl_id,
long memb_size,
int memb_fapl_id)
|
static int |
H5Pset_fapl_log(int fapl_id,
java.lang.String logfile,
int flags,
int buf_size)
|
static int |
H5Pset_fclose_degree(int plist,
int degree)
|
static int |
H5Pset_fill_time(int plist_id,
int fill_time)
|
static int |
H5Pset_fill_value(int plist_id,
int type_id,
byte[] value)
H5Pset_fill_value sets the fill value for a dataset creation property list. |
static int |
H5Pset_fill_value(int plist_id,
int type_id,
java.lang.Object obj)
H5Pset_fill_value sets the fill value for a dataset creation property list. |
static int |
H5Pset_filter(int plist,
int filter,
int flags,
int cd_nelmts,
int[] cd_values)
H5Pset_filter adds the specified filter and corresponding properties to the end of an output filter pipeline. |
static int |
H5Pset_fletcher32(int plist)
|
static int |
H5Pset_gc_references(int fapl_id,
boolean gc_ref)
H5Pset_gc_references Sets the flag for garbage collecting references for the file. |
static int |
H5Pset_hyper_vector_size(int dxpl_id,
long vector_size)
|
static int |
H5Pset_istore_k(int plist,
int ik)
H5Pset_istore_k sets the size of the parameter used to control the B-trees for indexing chunked datasets. |
static int |
H5Pset_layout(int plist,
int layout)
H5Pset_layout sets the type of storage used store the raw data for a dataset. |
static int |
H5Pset_preserve(int plist,
boolean status)
H5Pset_preserve sets the dataset transfer property list status to TRUE or FALSE. |
static int |
H5Pset_shuffle(int plist_id)
|
static int |
H5Pset_sizes(int plist,
int sizeof_addr,
int sizeof_size)
H5Pset_sizes sets the byte size of the offsets and lengths used to address objects in an HDF5 file. |
static int |
H5Pset_small_data_block_size(int plist,
long size)
H5Pset_small_data_block_size reserves blocks of size bytes for the contiguous storage of the raw data portion of small datasets. |
static int |
H5Pset_sym_k(int plist,
int ik,
int lk)
H5Pset_sym_k sets the size of parameters used to control the symbol table nodes. |
static int |
H5Pset_szip(int plist,
int options_mask,
int pixels_per_block)
|
static int |
H5Pset_userblock(int plist,
long size)
H5Pset_userblock sets the user block size of a file creation property list. |
static int |
H5Pset(int plid,
java.lang.String name,
int value)
Sets a property list value (support integer only) |
static int |
H5Punregister(int plid,
java.lang.String name)
H5Punregister removes a property from a property list class |
static byte[] |
H5Rcreate(int loc_id,
java.lang.String name,
int ref_type,
int space_id)
H5Rcreate creates the reference, ref, of the type specified in ref_type, pointing to the object name located at loc_id. |
static int |
H5Rdereference(int dataset,
int ref_type,
byte[] ref)
Given a reference to some object, H5Rdereference opens that object and return an identifier. |
static int |
H5Rget_obj_type(int loc_id,
int ref_type,
byte[] ref)
Given a reference to an object ref, H5Rget_obj_type returns the type of the object pointed to. |
static int |
H5Rget_region(int loc_id,
int ref_type,
byte[] ref)
Given a reference to an object ref, H5Rget_region creates a copy of the dataspace of the dataset pointed to and defines a selection in the copy which is the region pointed to. |
static int |
H5Sclose(int space_id)
H5Sclose releases a dataspace. |
static int |
H5Scopy(int space_id)
H5Scopy creates a new dataspace which is an exact copy of the dataspace identified by space_id. |
static int |
H5Screate_simple(int rank,
byte[] dims,
byte[] maxdims)
H5Screate_simple creates a new simple data space and opens it for access. |
static int |
H5Screate_simple(int rank,
long[] dims,
long[] maxdims)
|
static int |
H5Screate(int type)
H5Screate creates a new dataspace of a particular type. |
static int |
H5set_free_list_limits(int reg_global_lim,
int reg_list_lim,
int arr_global_lim,
int arr_list_lim,
int blk_global_lim,
int blk_list_lim)
|
static int |
H5Sextent_copy(int dest_space_id,
int source_space_id)
H5Sextent_copy copies the extent from source_space_id to dest_space_id. |
static int |
H5Sget_select_bounds(int spaceid,
long[] start,
long[] end)
H5Sget_select_bounds retrieves the coordinates of the bounding box containing the current selection and places them into user-supplied buffers. |
static long |
H5Sget_select_elem_npoints(int spaceid)
H5Sget_select_elem_npoints returns the number of element points in the current dataspace selection. |
static int |
H5Sget_select_elem_pointlist(int spaceid,
long startpoint,
long numpoints,
long[] buf)
H5Sget_select_elem_pointlist returns an array of of element points in the current dataspace selection. |
static int |
H5Sget_select_hyper_blocklist(int spaceid,
long startblock,
long numblocks,
long[] buf)
H5Sget_select_hyper_blocklist returns an array of hyperslab blocks. |
static long |
H5Sget_select_hyper_nblocks(int spaceid)
H5Sget_select_hyper_nblocks returns the number of hyperslab blocks in the current dataspace selection. |
static long |
H5Sget_select_npoints(int space_id)
H5Sget_select_npoints determines the number of elements in the current selection of a dataspace. |
static int |
H5Sget_simple_extent_dims(int space_id,
long[] dims,
long[] maxdims)
H5Sget_simple_extent_dims returns the size and maximum sizes of each dimension of a dataspace through the dims and maxdims parameters. |
static int |
H5Sget_simple_extent_ndims(int space_id)
H5Sget_simple_extent_ndims determines the dimensionality (or rank) of a dataspace. |
static long |
H5Sget_simple_extent_npoints(int space_id)
H5Sget_simple_extent_npoints determines the number of elements in a dataspace. |
static int |
H5Sget_simple_extent_type(int space_id)
H5Sget_simple_extent_type queries a dataspace to determine the current class of a dataspace. |
static boolean |
H5Sis_simple(int space_id)
H5Sis_simple determines whether a dataspace is a simple dataspace. |
static int |
H5Soffset_simple(int space_id,
byte[] offset)
H5Soffset_simple sets the offset of a simple dataspace space_id. |
static int |
H5Soffset_simple(int space_id,
long[] offset)
|
static int |
H5Sselect_all(int space_id)
H5Sselect_all selects the entire extent of the dataspace space_id. |
static int |
H5Sselect_elements(int space_id,
int op,
int num_elements,
long[][] coord2D)
H5Sselect_elements selects array elements to be included in the selection for the space_id dataspace. |
static int |
H5Sselect_hyperslab(int space_id,
int op,
byte[] start,
byte[] stride,
byte[] count,
byte[] block)
H5Sselect_hyperslab selects a hyperslab region to add to the current selected region for the dataspace specified by space_id. |
static int |
H5Sselect_hyperslab(int space_id,
int op,
long[] start,
long[] stride,
long[] count,
long[] block)
|
static int |
H5Sselect_none(int space_id)
H5Sselect_none resets the selection region for the dataspace space_id to include no elements. |
static boolean |
H5Sselect_valid(int space_id)
H5Sselect_valid verifies that the selection for the dataspace. |
static int |
H5Sset_extent_none(int space_id)
H5Sset_extent_none removes the extent from a dataspace and sets the type to H5S_NONE. |
static int |
H5Sset_extent_simple(int space_id,
int rank,
byte[] current_size,
byte[] maximum_size)
H5Sset_extent_simple sets or resets the size of an existing dataspace. |
static int |
H5Sset_extent_simple(int space_id,
int rank,
long[] current_size,
long[] maximum_size)
|
static int |
H5Tarray_create(int base,
int rank,
int[] dims,
int[] perms)
Array data types, new in HDF5.1.4. |
static int |
H5Tclose(int type_id)
H5Tclose releases a datatype. |
static int |
H5Tcommit(int loc_id,
java.lang.String name,
int type)
H5Tcommit commits a transient datatype (not immutable) to a file, turned it into a named datatype. |
static boolean |
H5Tcommitted(int type)
H5Tcommitted queries a type to determine whether the type specified by the type identifier is a named type or a transient type. |
static int |
H5Tcopy(int type_id)
H5Tcopy copies an existing datatype. |
static int |
H5Tcreate(int dclass,
int size)
H5Tcreate creates a new dataype of the specified class with the specified number of bytes. |
static boolean |
H5Tdetect_class(int dtype_id,
int dtype_class)
|
static int |
H5Tenum_create(int base_id)
H5Tenum_create creates a new enumeration datatype based on the specified base datatype, parent_id, which must be an integer type. |
static int |
H5Tenum_insert(int type,
java.lang.String name,
int value)
|
static int |
H5Tenum_insert(int type,
java.lang.String name,
int[] value)
H5Tenum_insert inserts a new enumeration datatype member into an enumeration datatype. |
static int |
H5Tenum_nameof(int type,
int[] value,
java.lang.String[] name,
int size)
H5Tenum_nameof finds the symbol name that corresponds to the specified value of the enumeration datatype type. |
static int |
H5Tenum_valueof(int type,
java.lang.String name,
int[] value)
H5Tenum_valueof finds the value that corresponds to the specified name of the enumeration datatype type. |
static boolean |
H5Tequal(int type_id1,
int type_id2)
H5Tequal determines whether two datatype identifiers refer to the same datatype. |
static int |
H5Tget_array_dims(int dt,
int[] dims,
int[] perms)
|
static int |
H5Tget_array_ndims(int dt)
|
static int |
H5Tget_class(int type_id)
H5Tget_class returns the datatype class identifier. |
static int |
H5Tget_cset(int type_id)
H5Tget_cset retrieves the character set type of a string datatype. |
static int |
H5Tget_ebias(int type_id)
H5Tget_ebias retrieves the exponent bias of a floating-point type. |
static int |
H5Tget_fields(int type_id,
int[] fields)
H5Tget_fields retrieves information about the locations of the various bit fields of a floating point datatype. |
static int |
H5Tget_inpad(int type_id)
H5Tget_inpad retrieves the internal padding type for unused bits in floating-point datatypes. |
static int |
H5Tget_member_class(int type_id,
int field_idx)
H5Tget_member_class returns the datatype of the specified member. |
static int |
H5Tget_member_index(int type_id,
java.lang.String field_name)
H5Tget_member_index retrieves the index of a field of a compound datatype. |
static java.lang.String |
H5Tget_member_name(int type_id,
int field_idx)
H5Tget_member_name retrieves the name of a field of a compound datatype. |
static long |
H5Tget_member_offset(int type_id,
int membno)
H5Tget_member_offset returns the byte offset of the specified member of the compound datatype. |
static int |
H5Tget_member_type(int type_id,
int field_idx)
H5Tget_member_type returns the datatype of the specified member. |
static int |
H5Tget_member_value(int type_id,
int membno,
int[] value)
H5Tget_member_value returns the value of the enumeration datatype member memb_no. |
static int |
H5Tget_native_type(int tid)
|
static int |
H5Tget_native_type(int tid,
int alloc_time)
|
static int |
H5Tget_nmembers(int type_id)
H5Tget_nmembers retrieves the number of fields a compound datatype has. |
static int |
H5Tget_norm(int type_id)
H5Tget_norm retrieves the mantissa normalization of a floating-point datatype. |
static int |
H5Tget_offset(int type_id)
H5Tget_offset retrieves the bit offset of the first significant bit. |
static int |
H5Tget_order(int type_id)
H5Tget_order returns the byte order of an atomic datatype. |
static int |
H5Tget_pad(int type_id,
int[] pad) |