public class HDFLibrary
extends java.lang.Object
implements java.io.Serializable
This code is the called by Java programs to access the entry points of the HDF 4.2 library. Each routine wraps a single HDF entry point, generally with the arguments and return codes analogous to the C interface.
These routines use the class HDFArray to handle arrays of arbitrary type and shape.
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.
C | Java |
int, intn, int32, uint32 | int |
short, uint16, int16 | short |
float, float32 | float |
double, float64 | double |
char, uchar, int8, uint8 | byte |
char * (i.e., string) | java.lang.String |
void | void |
void *, VOIDP, char * (meaning ``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 intn or whatever. (Functions that return a value or else FAIL are declared the equivalent to the C function.)
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:
void HDFdummy( int32* a1, int32* a2)For the Java interface, this would be declared:
public static native void HDFdummy( int args[] );where a1 is args[0] and a2 is args[1].
All the routines where this convention is used will have specific documentation of the details, given below.
Arrays
HDF needs to read and write multi-dimensional arrays of many types. The HDF API is self-describing, with the data for the array passed as a block of bytes, for instance,
int SDreaddata(int sdsid, int32 *start, int32 * stride, int32 *count, VOIDP data);
where ``VOIDP'' 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.
For Java, this is a problem, as the type of data must 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 HDFArray class is used to discover the type, shape, and size of the data array at run time, and to convert to and from contigous bytes. The upshot is that the data can be passed as an ``Object'', and the Java API will translate to and from the appropriate bytes. So the function above would be declared:
int SDreaddata(int sdsid, int[] start, int[] stride, int[] count, Object data);and the parameter data can be any multi-dimensional array of numbers, such as float[][], or int[][][].
The HDF library passes the parameters needed by compression and chunking through C structures (actually, unions). The Java interface passes these as instances of subclasses of class HDFCompInfo and HDFChunkInfo respectively.
See: hdf.hdflib.HDFChunkInfo, and
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
HDFPATH_PROPERTY_KEY |
Constructor and Description |
---|
HDFLibrary() |
Modifier and Type | Method and Description |
---|---|
static int |
ANannlen(long ann_id) |
static int |
ANannlist(long an_id,
int anntype,
short tag,
short ref,
int[] ann_list) |
static short |
ANatype2tag(int antag) |
static int |
ANcreate(long an_id,
short tag,
short ref,
int type) |
static int |
ANcreatef(long an_id,
int type) |
static boolean |
ANend(long an_id) |
static boolean |
ANendaccess(long an_id) |
static boolean |
ANfileinfo(long an_id,
int[] info) |
static int |
ANget_tagref(long an_id,
int index,
int type,
short[] tagref) |
static boolean |
ANid2tagref(long an_id,
short[] tagref) |
static int |
ANnumann(long an_id,
int anntype,
short tag,
short ref) |
static boolean |
ANreadann(long ann_id,
java.lang.String[] annbuf,
int maxlen) |
static int |
ANselect(long an_id,
int index,
int anntype) |
static int |
ANstart(long fid) |
static int |
ANtag2atype(short anttype) |
static long |
ANtagref2id(long an_id,
short tag,
short ref) |
static boolean |
ANwriteann(long ann_id,
java.lang.String label,
int ann_length) |
static boolean |
DF24addimage(java.lang.String filename,
byte[] image,
int width,
int height) |
static boolean |
DF24addimage(java.lang.String filename,
java.lang.Object theImage,
int width,
int height) |
static boolean |
DF24getdims(java.lang.String fileName,
int[] argv) |
static boolean |
DF24getimage(java.lang.String fileName,
byte[] imagedata,
int width,
int height) |
static boolean |
DF24getimage(java.lang.String fileName,
java.lang.Object theImagedata,
int width,
int height) |
static short |
DF24lastref() |
static int |
DF24nimages(java.lang.String fileName) |
static boolean |
DF24putimage(java.lang.String filename,
byte[] image,
int width,
int height) |
static boolean |
DF24putimage(java.lang.String filename,
java.lang.Object theImage,
int width,
int height) |
static boolean |
DF24readref(java.lang.String filename,
int ref) |
static boolean |
DF24reqil(int il) |
static boolean |
DF24restart() |
static boolean |
DF24setcompress(int type,
HDFCompInfo cinfo) |
static boolean |
DF24setdims(int width,
int height) |
static boolean |
DF24setil(int il) |
static int |
DFKNTsize(long numbertype) |
static boolean |
DFPaddpal(java.lang.String filename,
byte[] palette) |
static boolean |
DFPgetpal(java.lang.String filename,
byte[] palette) |
static short |
DFPlastref() |
static int |
DFPnpals(java.lang.String filename) |
static boolean |
DFPputpal(java.lang.String filename,
byte[] palette,
boolean overwrite,
java.lang.String filemode) |
static boolean |
DFPputpal(java.lang.String filename,
byte[] palette,
int overwrite,
java.lang.String filemode) |
static boolean |
DFPreadref(java.lang.String filename,
short ref) |
static short |
DFPrestart() |
static boolean |
DFPwriteref(java.lang.String filename,
short ref) |
static boolean |
DFR8addimage(java.lang.String filename,
byte[] image,
int width,
int height,
short compress) |
static boolean |
DFR8addimage(java.lang.String filename,
java.lang.Object theImage,
int width,
int height,
short compress) |
static boolean |
DFR8getdims(java.lang.String fileName,
int[] argv,
boolean[] haspalette) |
static boolean |
DFR8getimage(java.lang.String fileName,
byte[] imagedata,
int width,
int height,
byte[] palette) |
static boolean |
DFR8getimage(java.lang.String fileName,
java.lang.Object theImagedata,
int width,
int height,
byte[] palette) |
static boolean |
DFR8getpalref(short[] palref) |
static short |
DFR8lastref() |
static int |
DFR8nimages(java.lang.String fileName) |
static boolean |
DFR8putimage(java.lang.String filename,
byte[] image,
int width,
int height,
short compress) |
static boolean |
DFR8putimage(java.lang.String filename,
java.lang.Object theImage,
int width,
int height,
short compress) |
static boolean |
DFR8readref(java.lang.String filename,
int ref) |
static boolean |
DFR8restart() |
static boolean |
DFR8setcompress(int type,
HDFCompInfo cinfo)
DFR8setcompress sets compression scheme for 8-bit image
|
static boolean |
DFR8setpalette(byte[] palette) |
static boolean |
DFR8writeref(java.lang.String filename,
short ref) |
static java.lang.String |
getJHIVersion()
Deprecated.
|
static boolean |
GRattrinfo(long id,
int index,
java.lang.String[] name,
int[] argv) |
static int |
GRcreate(long gr_id,
java.lang.String name,
int ncomp,
long data_type,
int interlace_mode,
int[] dim_sizes) |
static boolean |
GRend(long grid) |
static boolean |
GRendaccess(long riid) |
static boolean |
GRfileinfo(long grid,
int[] args) |
static int |
GRfindattr(long id,
java.lang.String name) |
static boolean |
GRgetattr(long id,
int index,
byte[] data) |
static boolean |
GRgetattr(long id,
int index,
java.lang.Object theData) |
static boolean |
GRgetchunkinfo(long sdsid,
HDFChunkInfo chunk_def,
int[] flag) |
static boolean |
GRgetcompinfo(long ri_id,
HDFCompInfo c_info) |
static boolean |
GRgetcompress(long ri_id,
HDFCompInfo c_info) |
static boolean |
GRgetiminfo(long grid,
java.lang.String[] gr_name,
int[] args,
int[] dim_sizes) |
static int |
GRgetlutid(long rrid,
int index) |
static boolean |
GRgetlutinfo(long lutid,
int[] args) |
static int |
GRgetnluts(long rrid) |
static short |
GRidtoref(long riid) |
static short |
GRluttoref(long pal_id) |
static int |
GRnametoindex(long grid,
java.lang.String name) |
static boolean |
GRreadchunk(long sdsid,
int[] origin,
byte[] theData) |
static boolean |
GRreadchunk(long grid,
int[] origin,
java.lang.Object theData) |
static boolean |
GRreadimage(long grid,
int[] start,
int[] stride,
int[] count,
byte[] data) |
static boolean |
GRreadimage(long grid,
int[] start,
int[] stride,
int[] count,
java.lang.Object theData) |
static boolean |
GRreadlut(long lutid,
byte[] data) |
static boolean |
GRreadlut(long lutid,
java.lang.Object theData) |
static int |
GRreftoindex(long grid,
short ref) |
static boolean |
GRreqimageil(long rrid,
int interlace) |
static boolean |
GRreqlutil(long riid,
int interlace) |
static int |
GRselect(long grid,
int index) |
static boolean |
GRsetattr(long gr_id,
java.lang.String attr_name,
long data_type,
int count,
byte[] values) |
static boolean |
GRsetattr(long gr_id,
java.lang.String attr_name,
long data_type,
int count,
java.lang.Object theData) |
static boolean |
GRsetattr(long gr_id,
java.lang.String attr_name,
long data_type,
int count,
java.lang.String values) |
static boolean |
GRsetchunk(long sdsid,
HDFChunkInfo chunk_def,
int flags) |
static int |
GRsetchunkcache(long sdsid,
int maxcache,
int flags) |
static boolean |
GRsetcompress(long ri_id,
int comp_type,
HDFCompInfo c_info) |
static boolean |
GRsetexternalfile(long ri_id,
java.lang.String filename,
int offset) |
static int |
GRstart(long fid) |
static boolean |
GRwriteimage(long grid,
int[] start,
int[] stride,
int[] edge,
byte[] data) |
static boolean |
GRwriteimage(long grid,
int[] start,
int[] stride,
int[] edge,
java.lang.Object theData) |
static boolean |
GRwritelut(long pal_id,
int ncomp,
int data_type,
int interlace,
int num_entries,
byte[] pal_data) |
static boolean |
GRwritelut(long pal_id,
int ncomp,
int data_type,
int interlace,
int num_entries,
java.lang.Object theData) |
static boolean |
Hcache(long file_id,
int cache_switch) |
static int |
HCget_config_info(int coder_type)
New API for hdf-42r1
|
static boolean |
Hclose(long fid) |
static int |
HDdont_atexit() |
static boolean |
HDFclose(long file_id) |
static long |
HDFopen(java.lang.String filename,
int access,
short n_dds) |
static java.lang.String |
HDgetNTdesc(int nt) |
static void |
HEprint(java.lang.Object stream,
int level) |
static java.lang.String |
HEstring(int error_code) |
static short |
HEvalue(int level) |
static boolean |
Hgetfileversion(long file_id,
int[] vers,
java.lang.String[] string)
Note: the version of an HDF file is not well defined,
it is not recommended that programs rely on these numbers.
|
static boolean |
Hgetlibversion(int[] vers,
java.lang.String[] string) |
static boolean |
Hishdf(java.lang.String fileName) |
static int |
Hnumber(long fid) |
static int |
Hnumber(long fid,
int tagtype) |
static long |
Hopen(java.lang.String filename) |
static long |
Hopen(java.lang.String filename,
int access) |
static long |
Hopen(java.lang.String filename,
int access,
int ndds) |
static boolean |
Hsetaccesstype(long h_id,
int access_type) |
static boolean |
Hsync(long file_id) |
static boolean |
HXsetcreatedir(java.lang.String dir) |
static boolean |
HXsetdir(java.lang.String dir) |
static void |
loadH4Lib() |
static boolean |
SDattrinfo(long id,
int index,
java.lang.String[] name,
int[] argv) |
static boolean |
SDcheckempty(long sdsid,
int[] emptySDS) |
static long |
SDcreate(long sd_id,
java.lang.String name,
long number_type,
int rank,
int[] dimsizes) |
static boolean |
SDdiminfo(long dimid,
java.lang.String[] name,
int[] argv) |
static boolean |
SDend(long sdid) |
static boolean |
SDendaccess(long sdsid) |
static boolean |
SDfileinfo(long sdid,
int[] argv) |
static long |
SDfindattr(long id,
java.lang.String name) |
static boolean |
SDgetcal(long sdsid,
double[] argv,
int[] NT) |
static boolean |
SDgetchunkinfo(long sdsid,
HDFChunkInfo chunk_def,
int[] clflags) |
static boolean |
SDgetcompinfo(long id,
HDFCompInfo cinfo)
Deprecated.
As of HDF 4.2.9, replaced by
SDgetcompinfo(long, HDFCompInfo) |
static boolean |
SDgetdatastrs(long sdsid,
java.lang.String[] strings,
int len) |
static long |
SDgetdimid(long sdsid,
int index) |
static boolean |
SDgetdimscale(long dimid,
byte[] data) |
static boolean |
SDgetdimscale(long dimid,
java.lang.Object theData) |
static boolean |
SDgetdimstrs(long dimid,
java.lang.String[] args,
int len) |
static boolean |
SDgetfillvalue(long sdsid,
byte[] fillValue) |
static boolean |
SDgetfillvalue(long sdsid,
java.lang.Object[] theFillValue) |
static boolean |
SDgetinfo(long sdsid,
java.lang.String[] name,
int[] dimsizes,
int[] args) |
static boolean |
SDgetrange(long sdsid,
byte[] max,
byte[] min) |
static boolean |
SDgetrange(long sdsid,
double[] maxmin) |
static int |
SDidtoref(long sdsid) |
static boolean |
SDiscoordvar(long sdsid) |
static boolean |
SDisdimval_bwcomp(long dimid) |
static boolean |
SDisrecord(long sdsid) |
static int |
SDnametoindex(long sdid,
java.lang.String name) |
static boolean |
SDreadattr(long id,
int index,
byte[] data) |
static boolean |
SDreadattr(long id,
int index,
java.lang.Object theData) |
static boolean |
SDreadchunk(long sdsid,
int[] origin,
byte[] theData) |
static boolean |
SDreadchunk(long sdsid,
int[] origin,
java.lang.Object theData) |
static boolean |
SDreaddata_double(long sdsid,
int[] start,
int[] stride,
int[] count,
double[] theData) |
static boolean |
SDreaddata_float(long sdsid,
int[] start,
int[] stride,
int[] count,
float[] theData) |
static boolean |
SDreaddata_int(long sdsid,
int[] start,
int[] stride,
int[] count,
int[] theData) |
static boolean |
SDreaddata_long(long sdsid,
int[] start,
int[] stride,
int[] count,
long[] theData) |
static boolean |
SDreaddata_short(long sdsid,
int[] start,
int[] stride,
int[] count,
short[] theData) |
static boolean |
SDreaddata(long sdsid,
int[] start,
int[] stride,
int[] count,
byte[] data) |
static boolean |
SDreaddata(long sdsid,
int[] start,
int[] stride,
int[] count,
java.lang.Object theData) |
static int |
SDreftoindex(long sdid,
int ref) |
static long |
SDselect(long sdid,
int index) |
static boolean |
SDsetaccesstype(long id,
int accesstype) |
static boolean |
SDsetattr(long s_id,
java.lang.String attr_name,
long num_type,
int count,
byte[] values) |
static boolean |
SDsetattr(long s_id,
java.lang.String attr_name,
long num_type,
int count,
java.lang.Object theValues) |
static boolean |
SDsetblocksize(long sdsid,
int block_size) |
static boolean |
SDsetcal(long sds_id,
double cal,
double cal_err,
double offset,
double offset_err,
int number_type) |
static boolean |
SDsetchunk(long sdsid,
HDFChunkInfo chunk_def,
int flags) |
static int |
SDsetchunkcache(long sdsid,
int maxcache,
int flags) |
static boolean |
SDsetcompress(long id,
int type,
HDFCompInfo cinfo) |
static boolean |
SDsetdatastrs(long sds_id,
java.lang.String label,
java.lang.String unit,
java.lang.String format,
java.lang.String coordsys) |
static boolean |
SDsetdimname(long dim_id,
java.lang.String dim_name) |
static boolean |
SDsetdimscale(long dim_id,
int count,
int number_type,
byte[] data) |
static boolean |
SDsetdimscale(long dim_id,
int count,
int number_type,
java.lang.Object theData) |
static boolean |
SDsetdimstrs(long dim_id,
java.lang.String label,
java.lang.String unit,
java.lang.String format) |
static boolean |
SDsetdimval_comp(long dimid,
int comp_mode) |
static boolean |
SDsetexternalfile(long sds_id,
java.lang.String filename,
int offset) |
static boolean |
SDsetfillmode(long sdsid,
boolean fill_enable) |
static boolean |
SDsetfillmode(long sdsid,
int fillmode) |
static boolean |
SDsetfillvalue(long sds_id,
byte[] fill_val) |
static boolean |
SDsetfillvalue(long sds_id,
java.lang.Object the_fill_val) |
static boolean |
SDsetnbitdataset(long id,
int start_bit,
int bit_len,
int sign_ext,
int fill_one) |
static boolean |
SDsetrange(long sdsid,
byte[] max,
byte[] min) |
static boolean |
SDsetrange(long sdsid,
java.lang.Object max,
java.lang.Object min) |
static long |
SDstart(java.lang.String filename,
int accessmode) |
static boolean |
SDwritechunk(long sdsid,
int[] origin,
byte[] data) |
static boolean |
SDwritechunk(long sdsid,
int[] origin,
java.lang.Object theData) |
static boolean |
SDwritedata(long sdsid,
int[] start,
int[] stride,
int[] count,
byte[] data) |
static boolean |
SDwritedata(long sdsid,
int[] start,
int[] stride,
int[] count,
java.lang.Object theData) |
static int |
Vaddtagref(long vgroup_id,
int tag,
int ref) |
static int |
Vattach(long fid,
int vgroup_ref,
java.lang.String access) |
static boolean |
Vattrinfo(long id,
int index,
java.lang.String[] name,
int[] argv) |
static int |
Vdeletetagref(long vgroup_id,
int tag,
int ref) |
static void |
Vdetach(long vgroup_id) |
static void |
Vend(long file_id) |
static int |
VFfieldesize(long vdata_id,
int field_index) |
static int |
VFfieldisize(long vdata_id,
int field_index) |
static java.lang.String |
VFfieldname(long vdata_id,
int field_index) |
static int |
VFfieldorder(long vdata_id,
int field_index) |
static long |
VFfieldtype(long vdata_id,
int field_index) |
static int |
Vfind(long file_id,
java.lang.String vgroup_name) |
static long |
Vfindattr(long id,
java.lang.String name) |
static int |
Vfindclass(long file_id,
java.lang.String vgclassname) |
static int |
Vflocate(int key,
java.lang.String vgclassname) |
static int |
VFnfields(long vkey) |
static boolean |
Vgetattr(long id,
int index,
byte[] data) |
static boolean |
Vgetattr(long id,
int index,
java.lang.Object theData) |
static void |
Vgetclass(long vgroup_id,
java.lang.String[] hdfclassname) |
static int |
Vgetid(long file_id,
int vgroup_ref) |
static void |
Vgetname(long vgroup_id,
java.lang.String[] hdfname) |
static int |
Vgetnext(int key,
int ref) |
static boolean |
Vgettagref(long vgroup_id,
int index,
int[] tagref) |
static int |
Vgettagrefs(long vgroup_id,
int[] tags,
int[] refs,
int arraysize) |
static int |
Vgetversion(long id) |
static int |
VHmakegroup(long file_id,
int[] tag_array,
int[] ref_array,
int n_objects,
java.lang.String vgroup_name,
java.lang.String vgroup_class) |
static int |
VHstoredata(long file_id,
java.lang.String fieldname,
byte[] buf,
int n_records,
int data_type,
java.lang.String vdata_name,
java.lang.String vdata_class) |
static int |
VHstoredata(long file_id,
java.lang.String fieldname,
java.lang.Object thebuf,
int n_records,
int data_type,
java.lang.String vdata_name,
java.lang.String vdata_class) |
static int |
VHstoredatam(long file_id,
java.lang.String fieldname,
byte[] buf,
int n_records,
int data_type,
java.lang.String vdata_name,
java.lang.String vdata_class,
int order) |
static int |
VHstoredatam(long file_id,
java.lang.String fieldname,
java.lang.Object buf,
int n_records,
int data_type,
java.lang.String vdata_name,
java.lang.String vdata_class,
int order) |
static boolean |
Vinqtagref(long vgroup_id,
int tag,
int ref) |
static boolean |
Vinquire(long vgroup_id,
int[] n_entries,
java.lang.String[] vgroup_name) |
static int |
Vinsert(long vgroup_id,
long v_id) |
static boolean |
Visvg(long vgroup_id,
int vgroup_ref) |
static boolean |
Visvs(long vgroup_id,
int vdata_ref) |
static int |
Vlone(long fid,
int[] ref_array,
int buffersize) |
static int |
Vnattrs(long id) |
static int |
Vnrefs(int key,
int ref) |
static int |
Vntagrefs(long vgroup_id) |
static int |
VQueryref(long vkey) |
static int |
VQuerytag(long vkey) |
static boolean |
VSappendable(int vkey,
int block_size) |
static int |
VSattach(long fid,
int vdata_ref,
java.lang.String access) |
static boolean |
VSattrinfo(long id,
int index,
int attr_index,
java.lang.String[] name,
int[] argv) |
static void |
VSdetach(long vdata_id) |
static int |
VSelts(long vdata_id) |
static boolean |
Vsetattr(long id,
java.lang.String attr_name,
long data_type,
int count,
byte[] data) |
static boolean |
Vsetattr(long id,
java.lang.String attr_name,
long data_type,
int count,
java.lang.Object theData) |
static boolean |
Vsetattr(long id,
java.lang.String attr_name,
long data_type,
int count,
java.lang.String values) |
static boolean |
Vsetclass(long vgroup_id,
java.lang.String vgclassname) |
static boolean |
Vsetname(long vgroup_id,
java.lang.String vgname) |
static boolean |
VSfdefine(long vdata_id,
java.lang.String fieldname,
int numbertype,
int order) |
static boolean |
VSfexist(long vdata_id,
java.lang.String fields) |
static int |
VSfind(long file_id,
java.lang.String vdataname) |
static int |
VSfindattr(long id,
int index,
java.lang.String name) |
static int |
VSfindclass(long file_id,
java.lang.String vgclass) |
static int |
VSfindex(long id,
java.lang.String name,
int[] findex) |
static int |
VSfnattrs(long id,
int fnattrs) |
static boolean |
VSgetattr(long id,
int index,
int attr_index,
byte[] data) |
static boolean |
VSgetattr(long id,
int index,
int attr_index,
java.lang.Object theData) |
static void |
VSgetclass(long vdata_id,
java.lang.String[] hdfclassname) |
static int |
VSgetfields(long vdata_id,
java.lang.String[] fieldname) |
static long |
VSgetid(long file_id,
int vdata_ref) |
static int |
VSgetinterlace(long vdata_id) |
static void |
VSgetname(long vdata_id,
java.lang.String[] hdfname) |
static int |
VSgetversion(int vkey) |
static boolean |
VSinquire(long vdata_id,
int[] iargs) |
static boolean |
VSinquire(long vdata_id,
int[] iargs,
java.lang.String[] sargs) |
static boolean |
VSisattr(long id) |
static int |
VSlone(long fid,
int[] ref_array,
int buffersize) |
static int |
VSnattrs(long id) |
static boolean |
VSQuerycount(long vdata_id,
int[] n_records) |
static boolean |
VSQueryfields(long vdata_id,
java.lang.String[] fields) |
static boolean |
VSQueryinterlace(long vdata_id,
int[] interlace) |
static boolean |
VSQueryname(long vdata_id,
java.lang.String[] vdata_name) |
static int |
VSQueryref(long vdata_id) |
static int |
VSQuerytag(long vdata_id) |
static boolean |
VSQueryvsize(long vdata_id,
int[] vdata_size) |
static int |
VSread(long vdata_id,
byte[] databuf,
int nrecord,
int interlace) |
static int |
VSread(long vdata_id,
java.lang.Object theData,
int nrecord,
int interlace) |
static int |
VSseek(long vdata_id,
int record) |
static boolean |
VSsetattr(long id,
int index,
java.lang.String attr_name,
long data_type,
int count,
byte[] values) |
static boolean |
VSsetattr(long id,
int index,
java.lang.String attr_name,
long data_type,
int count,
java.lang.Object theData) |
static boolean |
VSsetattr(long id,
int index,
java.lang.String attr_name,
long data_type,
int count,
java.lang.String values) |
static int |
VSsetblocksize(long vdata_id,
int blocksize) |
static void |
VSsetclass(long vdata_id,
java.lang.String vdata_class) |
static boolean |
VSsetexternalfile(int vkey,
java.lang.String filename,
int offset) |
static boolean |
VSsetfields(long vdata_id,
java.lang.String fields) |
static boolean |
VSsetinterlace(long vdata_id,
int interlace) |
static void |
VSsetname(long vdata_id,
java.lang.String vdata_name) |
static int |
VSsetnumblocks(long vdata_id,
int numblocks) |
static int |
VSsizeof(long vdata_id,
java.lang.String fields) |
static boolean |
Vstart(long fid) |
static int |
VSwrite(long vdata_id,
byte[] databuf,
int n_records,
int interlace) |
static int |
VSwrite(long vdata_id,
java.lang.Object databuf,
int n_records,
int interlace) |
public static final java.lang.String HDFPATH_PROPERTY_KEY
public static void loadH4Lib()
@Deprecated public static final java.lang.String getJHIVersion()
public static long Hopen(java.lang.String filename) throws HDFException
HDFException
public static long Hopen(java.lang.String filename, int access) throws HDFException
HDFException
public static long Hopen(java.lang.String filename, int access, int ndds) throws HDFException
HDFException
public static boolean Hclose(long fid) throws HDFException
HDFException
public static int HDdont_atexit() throws HDFException
HDFException
public static boolean Hishdf(java.lang.String fileName) throws HDFException
HDFException
public static int Hnumber(long fid) throws HDFException
HDFException
public static int Hnumber(long fid, int tagtype) throws HDFException
HDFException
public static int DFKNTsize(long numbertype) throws HDFException
HDFException
public static java.lang.String HDgetNTdesc(int nt) throws HDFException
HDFException
public static boolean Hcache(long file_id, int cache_switch) throws HDFException
HDFException
public static boolean Hgetfileversion(long file_id, int[] vers, java.lang.String[] string) throws HDFException
file_id
- IN: long, the file descriptor returned by Hopenvers
- OUT: int[3], the major version, minor version,
and release number of the file.string
- OUT: String[1], the version stringHDFException
- should be thrown for errors in the
HDF library call, but is not yet implemented.public static boolean Hgetlibversion(int[] vers, java.lang.String[] string) throws HDFException
vers
- OUT: int[3], the major version, minor version,
and release number of the HDF library.string
- OUT: String[1], the version stringHDFException
- should be thrown for errors in the
HDF library call, but is not yet implemented.public static boolean Hsetaccesstype(long h_id, int access_type) throws HDFException
HDFException
public static boolean Hsync(long file_id) throws HDFException
HDFException
public static int ANstart(long fid) throws HDFException
HDFException
public static boolean ANend(long an_id) throws HDFException
HDFException
public static boolean ANendaccess(long an_id) throws HDFException
HDFException
public static boolean ANfileinfo(long an_id, int[] info) throws HDFException
an_id
- IN: the AN interface id, returned by ANstartinfo
- OUT: int[4], n_file_label, n_file_desc,
n_data_label, n_data_descHDFException
- should be thrown for errors.public static int ANselect(long an_id, int index, int anntype) throws HDFException
HDFException
public static int ANnumann(long an_id, int anntype, short tag, short ref) throws HDFException
HDFException
public static short ANatype2tag(int antag) throws HDFException
HDFException
public static int ANtag2atype(short anttype) throws HDFException
HDFException
public static int ANannlist(long an_id, int anntype, short tag, short ref, int[] ann_list) throws HDFException
an_id
- IN: the AN interface id, returned by ANstartanntype
- IN: the number type, as defined in HDFConstantstag
- IN: the HDF tagref
- IN: the HDF refann_list
- OUT: int[], an array of annotation identifiers.
The array must be long enough to hold the number of annotations
returned by ANnumannHDFException
- should be thrown for errors.public static int ANannlen(long ann_id) throws HDFException
HDFException
public static boolean ANreadann(long ann_id, java.lang.String[] annbuf, int maxlen) throws HDFException
ann_id
- IN: the AN interface id, returned by ANstartannbuf
- OUT: String[1], the annotation is returned as annbuf[0].maxlen
- IN: int, the maximum length of the string.HDFException
- should be thrown for errors.public static int ANcreate(long an_id, short tag, short ref, int type) throws HDFException
HDFException
public static int ANcreatef(long an_id, int type) throws HDFException
HDFException
public static int ANget_tagref(long an_id, int index, int type, short[] tagref) throws HDFException
an_id
- IN: the AN interface id, returned by ANstartindex
- IN: the index of the annotationtype
- IN: the type of the annotationtagref
- OUT: short[2], the tag and ref of the annotationHDFException
- should be thrown for errors.public static boolean ANid2tagref(long an_id, short[] tagref) throws HDFException
an_id
- IN: the AN interface id, returned by ANstarttagref
- OUT: short[2], the tag and ref of the annotationHDFException
- should be thrown for errors.public static long ANtagref2id(long an_id, short tag, short ref) throws HDFException
HDFException
public static boolean ANwriteann(long ann_id, java.lang.String label, int ann_length) throws HDFException
HDFException
public static boolean DFPaddpal(java.lang.String filename, byte[] palette) throws HDFException
HDFException
public static boolean DFPgetpal(java.lang.String filename, byte[] palette) throws HDFException
HDFException
public static short DFPlastref() throws HDFException
HDFException
public static int DFPnpals(java.lang.String filename) throws HDFException
HDFException
public static boolean DFPputpal(java.lang.String filename, byte[] palette, int overwrite, java.lang.String filemode) throws HDFException
HDFException
public static boolean DFPputpal(java.lang.String filename, byte[] palette, boolean overwrite, java.lang.String filemode) throws HDFException
filename
- IN: String, the name of the HDF filepalette
- IN: byte[] the paletteoverwrite
- IN: boolean, converted to 1 == true, 0 == false
to call the HDF libraryfilemode
- IN: if "a" append palette to file, "w" create new fileHDFException
- should be thrown for errors.public static boolean DFPreadref(java.lang.String filename, short ref) throws HDFException
HDFException
public static short DFPrestart() throws HDFException
HDFException
public static boolean DFPwriteref(java.lang.String filename, short ref) throws HDFException
HDFException
public static int GRstart(long fid) throws HDFException
HDFException
public static boolean GRend(long grid) throws HDFException
HDFException
public static boolean GRfileinfo(long grid, int[] args) throws HDFException
grid
- IN: the GR interface id, returned by GRstartargs
- OUT: int[2], n_datasets and n_file_attrsHDFException
- should be thrown for errors.public static boolean GRgetchunkinfo(long sdsid, HDFChunkInfo chunk_def, int[] flag) throws HDFException
sdsid
- IN: the SD identifier returned by SDselectchunk_def
- OUT: HDFChunkInfo, the chunking infoflag
- OUT: int[1], the type of chunkingNOTE:The chunking algorithm-specific information is passed in an appropriate sub-class of HDFChunkInfo.
HDFException
- should be thrown for errors.public static int GRselect(long grid, int index) throws HDFException
HDFException
public static int GRnametoindex(long grid, java.lang.String name) throws HDFException
HDFException
public static boolean GRgetiminfo(long grid, java.lang.String[] gr_name, int[] args, int[] dim_sizes) throws HDFException
grid
- IN: the GR interface id, returned by GRstartgr_name
- OUT: name of raster imageargs
- OUT: int[4], image info:
number of components in the image,
data type of the image data,
interlace mode of the stored image data,
number of attributes assigned to the imagedim_sizes
- OUT: int[2], dim_sizesNOTE: the parameters for the Java interface are not in the same order as the C interface.
HDFException
- should be thrown for errors.public static boolean GRreadimage(long grid, int[] start, int[] stride, int[] count, byte[] data) throws HDFException
grid
- IN: the GR interface id, returned by GRstartstart
- IN: int[2], startstride
- IN: int[2], stride. If the stride parameter is set to NULL,
a stride of 1 will be assumed.
strides of 0 are illegal.count
- IN: int[2], countdata
- OUT: byte[], dataNOTE: to read into a Java 2D array use the alternative routine below.
HDFException
- should be thrown for errors.public static boolean GRreadimage(long grid, int[] start, int[] stride, int[] count, java.lang.Object theData) throws HDFException
grid
- IN: the GR interface id, returned by GRstartstart
- IN: int[2], startstride
- IN: int[2], stride. If the stride parameter is set to NULL,
a stride of 1 will be assumed.
strides of 0 are illegal.count
- IN: int[2], counttheData
- OUT: Object, a Java array of appropriate
type, dimensions, and size.Note: reads the data as bytes and converts to the Java array.
HDFException
- should be thrown for errors.public static boolean GRendaccess(long riid) throws HDFException
HDFException
public static short GRidtoref(long riid) throws HDFException
HDFException
public static int GRreftoindex(long grid, short ref) throws HDFException
HDFException
public static boolean GRreqlutil(long riid, int interlace) throws HDFException
HDFException
public static boolean GRreqimageil(long rrid, int interlace) throws HDFException
HDFException
public static int GRgetlutid(long rrid, int index) throws HDFException
HDFException
public static int GRgetnluts(long rrid) throws HDFException
HDFException
public static boolean GRgetlutinfo(long lutid, int[] args) throws HDFException
lutid
- IN: the palette identifier returned by GRgetlutidargs
- OUT: int[4], palette info:
Number of components in the palette,
Data type of the palette data,
Interlace mode of the stored palette data,
Number of color lookup table entries in the palette.HDFException
- should be thrown for errors.public static boolean GRreadlut(long lutid, byte[] data) throws HDFException
lutid
- IN: the palette identifier returned by GRgetlutiddata
- OUT: byte[], palette data, in bytesNOTE: to read into a Java 1D array use the alternative routine below.
HDFException
- should be thrown for errors.public static boolean GRreadlut(long lutid, java.lang.Object theData) throws HDFException
lutid
- IN: the palette identifier returned by GRgetlutidtheData
- OUT: Object, palette data, an Java arrayNote: reads the data as bytes and converts to the Java array.
HDFException
- should be thrown for errors.public static boolean GRattrinfo(long id, int index, java.lang.String[] name, int[] argv) throws HDFException
id
- IN: the GR identifier returned by GRstartindex
- IN: the index of the attributename
- OUT: String[1], the name of the attributeargv
- OUT: int[2], the type and length of the
attributeHDFException
- should be thrown for errors.public static boolean GRgetattr(long id, int index, byte[] data) throws HDFException
id
- IN: the GR identifier returned by GRstartindex
- IN: index of the attribute for infodata
- OUT: byte[], attribute data, in bytesNOTE: to read into a Java 1D array use the alternative routine below.
HDFException
- should be thrown for errors.public static boolean GRgetattr(long id, int index, java.lang.Object theData) throws HDFException
id
- IN: the GR identifier returned by GRstartindex
- IN: index of the attribute for infotheData
- OUT: Object, attribute data, an Java arrayNote: reads the data as bytes and converts to the Java array.
HDFException
- should be thrown for errors.public static int GRfindattr(long id, java.lang.String name) throws HDFException
HDFException
public static int GRcreate(long gr_id, java.lang.String name, int ncomp, long data_type, int interlace_mode, int[] dim_sizes) throws HDFException
HDFException
public static short GRluttoref(long pal_id) throws HDFException
HDFException
public static boolean GRsetattr(long gr_id, java.lang.String attr_name, long data_type, int count, java.lang.String values) throws HDFException
gr_id
- IN: the GR identifier returned by GRstartattr_name
- IN: the name of the attributedata_type
- IN: the number type of the data (should
be DFNT_CHAR)count
- IN: the length the data (lenght of 'values')values
- IN: the the attribute to write -- A StringHDFException
- should be thrown for errors.
NOTE:This routine writes a attribute that is a String. Alternative methods write data of other types.
public static boolean GRsetattr(long gr_id, java.lang.String attr_name, long data_type, int count, byte[] values) throws HDFException
gr_id
- IN: the GR identifier returned by GRstartattr_name
- IN: the name of the attributedata_type
- IN: the number type of the datacount
- IN: the length the data (lenght of 'values')values
- IN: the the attribute to write -- in an
array of bytesHDFException
- should be thrown for errors.
NOTE:This routine writes the attribute as an array of bytes. DO NOT USE THIS TO WRITE A STRING. This is intended for numeric data that has been flattened into bytes.
public static boolean GRsetattr(long gr_id, java.lang.String attr_name, long data_type, int count, java.lang.Object theData) throws HDFException
gr_id
- IN: the GR identifier returned by GRstartattr_name
- IN: the name of the attributedata_type
- IN: the number type of the datacount
- IN: the length the data (lenght of 'values')theData
- IN: Object -- the value to be written,
a Java array of numbers.HDFException
- should be thrown for errors.
NOTE:This routine converts the Java array to bytes then writes it. DO NOT USE THIS TO WRITE A STRING.
public static boolean GRsetchunk(long sdsid, HDFChunkInfo chunk_def, int flags) throws HDFException
sdsid
- IN: the SD identifier returned by SDselectchunk_def
- IN: HDFChunkInfo, the chunking infoflags
- IN: the type of chunkingHDFException
- should be thrown for errors.
NOTE:The chunking algorithm-specific information is passed in an appropriate sub-class of HDFChunkInfo.
public static int GRsetchunkcache(long sdsid, int maxcache, int flags) throws HDFException
HDFException
public static boolean GRsetcompress(long ri_id, int comp_type, HDFCompInfo c_info) throws HDFException
ri_id
- IN: the GR identifier returned by GRstartcomp_type
- IN: the type of compressionc_info
- IN: HDFCompInfo, the compression infoHDFException
- should be thrown for errors.
NOTE:The compression algorithm specific information is passed in an appropriate sub-class of HDFCompInfo.
public static boolean GRgetcompress(long ri_id, HDFCompInfo c_info) throws HDFException
HDFException
public static boolean GRgetcompinfo(long ri_id, HDFCompInfo c_info) throws HDFException
HDFException
public static boolean GRsetexternalfile(long ri_id, java.lang.String filename, int offset) throws HDFException
HDFException
public static boolean GRwriteimage(long grid, int[] start, int[] stride, int[] edge, byte[] data) throws HDFException
grid
- IN: the GR interface id, returned by GRstartstart
- IN: int[2], startstride
- IN: int[2], stride. If the stride parameter is set to NULL,
a stride of 1 will be assumed.
strides of 0 are illegal.edge
- IN: int[2], countdata
- IN: byte[], data to be writtenHDFException
- should be thrown for errors.
NOTE: to write from a Java 2D array use the alternative routine below.
public static boolean GRwriteimage(long grid, int[] start, int[] stride, int[] edge, java.lang.Object theData) throws HDFException
grid
- IN: the GR interface id, returned by GRstartstart
- IN: int[2], startstride
- IN: int[2], stride. If the stride parameter is set to NULL,
a stride of 1 will be assumed.
strides of 0 are illegal.edge
- IN: int[2], counttheData
- IN: Object, a Java array of appropriate
type, dimensions, and size.HDFException
- should be thrown for errors.
Note: converts the Java array to a contiguous block of bytes appropriate for C, and then writes the bytes.
public static boolean GRwritelut(long pal_id, int ncomp, int data_type, int interlace, int num_entries, byte[] pal_data) throws HDFException
pal_id
- IN: the palette identifier returned by GRgetlutidncomp
- IN: int, number of componentsdata_type
- IN: int, number typeinterlace
- IN: int, interlacenum_entries
- IN: int, number of entriespal_data
- IN: byte[], palette data to be written--as bytesHDFException
- should be thrown for errors.
NOTE: to write from a Java array of numbers use the alternative routine below.
public static boolean GRwritelut(long pal_id, int ncomp, int data_type, int interlace, int num_entries, java.lang.Object theData) throws HDFException
pal_id
- IN: the palette identifier returned by GRgetlutidncomp
- IN: int, number of componentsdata_type
- IN: int, number typeinterlace
- IN: int, interlacenum_entries
- IN: int, number of entriestheData
- IN: Object, palette data to be written, any
number type.HDFException
- should be thrown for errors.
Note: converts the Java array to a contiguous block of bytes appropriate for C, and then writes the bytes.
public static boolean GRreadchunk(long sdsid, int[] origin, byte[] theData) throws HDFException
sdsid
- IN: the GR interface id, returned by SDselectorigin
- IN: int[], origintheData
- OUT: byte[], the data in an array of bytesHDFException
- should be thrown for errors.
NOTE: to read into a Java array use the alternative routine below.
public static boolean GRreadchunk(long grid, int[] origin, java.lang.Object theData) throws HDFException
grid
- IN: the GR interface id, returned by SDselectorigin
- IN: int[], origintheData
- IN: Object, a Java array of appropriate
type, dimensions, and size.HDFException
- should be thrown for errors.
Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
public static boolean HDFclose(long file_id) throws HDFException
HDFException
public static long HDFopen(java.lang.String filename, int access, short n_dds) throws HDFException
HDFException
public static short HEvalue(int level) throws HDFException
HDFException
public static java.lang.String HEstring(int error_code) throws HDFException
HDFException
public static void HEprint(java.lang.Object stream, int level) throws HDFException
HDFException
public static boolean HXsetcreatedir(java.lang.String dir) throws HDFException
HDFException
public static boolean HXsetdir(java.lang.String dir) throws HDFException
HDFException
public static long SDstart(java.lang.String filename, int accessmode) throws HDFException
HDFException
public static boolean SDend(long sdid) throws HDFException
HDFException
public static boolean SDfileinfo(long sdid, int[] argv) throws HDFException
sdid
- IN: the SD interface id, returned by SDstartargv
- OUT: int[2],
Number of datasets in the file,
Number of global attributes in the fileHDFException
- should be thrown for errors.public static long SDselect(long sdid, int index) throws HDFException
HDFException
public static int SDnametoindex(long sdid, java.lang.String name) throws HDFException
HDFException
public static boolean SDgetinfo(long sdsid, java.lang.String[] name, int[] dimsizes, int[] args) throws HDFException
sdsid
- IN: the SD interface id, returned by SDselectname
- OUT: String[1], the name of the datasetargs
- OUT: int[3], dataset info:
number of dimensions (rank),
data type for the data stored in the dataset,
number of "netCDF-style" attributes for this datasetdimsizes
- OUT: int[(rank)], sizes of dimensionsNOTE: the parameters for the Java interface are not in the same order as the C interface.
HDFException
- should be thrown for errors.public static boolean SDcheckempty(long sdsid, int[] emptySDS) throws HDFException
sdsid
- IN: the SD interface id, returned by SDselectemptySDS
- OUT: int[1], 1 if the SDS is empty, 0 if has dataHDFException
- should be thrown for errors.public static boolean SDreaddata(long sdsid, int[] start, int[] stride, int[] count, byte[] data) throws HDFException
sdsid
- IN: the SD interface id, returned by SDselectstart
- IN: int[], startstride
- IN: int[], stridecount
- IN: int[], countdata
- OUT: byte[], dataNOTE: to read into a Java array use the alternative routine below.
HDFException
- should be thrown for errors.public static boolean SDreaddata(long sdsid, int[] start, int[] stride, int[] count, java.lang.Object theData) throws HDFException
sdsid
- IN: the SD interface id, returned by SDselectstart
- IN: int[], startstride
- IN: int[], stridecount
- IN: int[], counttheData
- OUT: Object, a Java array of appropriate
type, dimensions, and size.Note: reads the data as bytes and converts to the Java array.
HDFException
- should be thrown for errors.public static boolean SDreaddata_short(long sdsid, int[] start, int[] stride, int[] count, short[] theData) throws HDFException
HDFException
public static boolean SDreaddata_int(long sdsid, int[] start, int[] stride, int[] count, int[] theData) throws HDFException
HDFException
public static boolean SDreaddata_long(long sdsid, int[] start, int[] stride, int[] count, long[] theData) throws HDFException
HDFException
public static boolean SDreaddata_float(long sdsid, int[] start, int[] stride, int[] count, float[] theData) throws HDFException
HDFException
public static boolean SDreaddata_double(long sdsid, int[] start, int[] stride, int[] count, double[] theData) throws HDFException
HDFException
public static boolean SDendaccess(long sdsid) throws HDFException
HDFException
public static long SDgetdimid(long sdsid, int index) throws HDFException
HDFException
public static boolean SDdiminfo(long dimid, java.lang.String[] name, int[] argv) throws HDFException
dimid
- IN: the dimension id, returned by SDgetdimidname
- OUT: String[1], the dimension nameargv
- OUT: int[3], size of the name string,
number type of data in the array, # attributes for the dimensionHDFException
- should be thrown for errors.public static int SDidtoref(long sdsid) throws HDFException
HDFException
public static int SDreftoindex(long sdid, int ref) throws HDFException
HDFException
public static boolean SDattrinfo(long id, int index, java.lang.String[] name, int[] argv) throws HDFException
id
- IN: id of a file, SDS, or dimensionindex
- IN: index of the attributename
- OUT: String[1], the name of the attributeargv
- OUT: int[2], number type of the attribute,
number of values in the attributeHDFException
- should be thrown for errors.public static boolean SDreadattr(long id, int index, byte[] data) throws HDFException
id
- IN: id of a file, SDS, or dimensionindex
- IN: index of the attributedata
- OUT: byte[], dataNOTE: to read into a Java array use the alternative routine below.
HDFException
- should be thrown for errors.public static boolean SDreadattr(long id, int index, java.lang.Object theData) throws HDFException
id
- IN: id of a file, SDS, or dimensionindex
- IN: index of the attributetheData
- OUT: Object, a Java array of appropriate
type, dimensions, and size.Note: reads the data as bytes and converts to the Java array.
HDFException
- should be thrown for errors.public static long SDfindattr(long id, java.lang.String name) throws HDFException
HDFException
public static boolean SDiscoordvar(long sdsid) throws HDFException
HDFException
public static boolean SDgetcal(long sdsid, double[] argv, int[] NT) throws HDFException
sdsid
- IN: id of the SDS as returned by SDselectargv
- OUT: double[4], calibration information:
calibration factor
calibration error
offset
offset errorNT
- OUT: int[1], number type of uncalibrated dataHDFException
- should be thrown for errors.public static boolean SDgetdatastrs(long sdsid, java.lang.String[] strings, int len) throws HDFException
sdsid
- IN: id of the SDS as returned by SDselectstrings
- OUT: String[4], data information strings:
label
unit
print format
coordinate systemlen
- IN: int, max len of string (not needed by
Java -- the HDFLibrary interface will handle this)HDFException
- should be thrown for errors.public static boolean SDgetdimstrs(long dimid, java.lang.String[] args, int len) throws HDFException
dimid
- IN: id of the SDS as returned by SDselectargs
- OUT: String[3], data information strings:
label
unit
print formatlen
- IN: int, max len of string (not needed by
Java -- the HDFLibrary interface will handle this)HDFException
- should be thrown for errors.public static boolean SDgetdimscale(long dimid, byte[] data) throws HDFException
dimid
- IN: id of a dimension as returned by SDgetdimiddata
- OUT: byte[], dataNOTE: to read into a Java array use the alternative routine below.
HDFException
- should be thrown for errors.public static boolean SDgetdimscale(long dimid, java.lang.Object theData) throws HDFException
dimid
- IN: id of a dimension as returned by SDgetdimidtheData
- OUT: Object, a Java array of appropriate
type and size.Note: reads the data as bytes and converts to the Java array.
HDFException
- should be thrown for errors.public static boolean SDgetfillvalue(long sdsid, byte[] fillValue) throws HDFException
sdsid
- IN: id of the SDS as returned by SDselectfillValue
- OUT: byte[], dataNOTE: to read into a Java variable use the alternative routine below.
HDFException
- should be thrown for errors.public static boolean SDgetfillvalue(long sdsid, java.lang.Object[] theFillValue) throws HDFException
sdsid
- IN: id of the SDS as returned by SDselecttheFillValue
- OUT: Object[1], one object of
appropriate typeNote: the routine calls SDgetinfo to determine the correct type, reads the data as bytes, and converts to the appropriate Java object.
HDFException
- should be thrown for errors.public static boolean SDgetrange(long sdsid, byte[] max, byte[] min) throws HDFException
sdsid
- IN: id of the SDS as returned by SDselectmax
- OUT: byte[], max value, as bytesmin
- OUT: byte[], min value, as bytesNOTE: to read into Java doubles, use the alternative routine below.
HDFException
- should be thrown for errors.public static boolean SDgetrange(long sdsid, double[] maxmin) throws HDFException
sdsid
- IN: id of the SDS as returned by SDselectmaxmin
- OUT: double[2], the max and min values
converted to doublesNote: the routine calls SDgetinfo to determine the correct type, reads the data as bytes, and converts to the double.
HDFException
- should be thrown for errors.public static long SDcreate(long sd_id, java.lang.String name, long number_type, int rank, int[] dimsizes) throws HDFException
HDFException
public static boolean SDisrecord(long sdsid) throws HDFException
HDFException
public static boolean SDsetattr(long s_id, java.lang.String attr_name, long num_type, int count, byte[] values) throws HDFException
HDFException
public static boolean SDsetattr(long s_id, java.lang.String attr_name, long num_type, int count, java.lang.Object theValues) throws HDFException
HDFException
public static boolean SDsetcal(long sds_id, double cal, double cal_err, double offset, double offset_err, int number_type) throws HDFException
HDFException
public static boolean SDsetdatastrs(long sds_id, java.lang.String label, java.lang.String unit, java.lang.String format, java.lang.String coordsys) throws HDFException
HDFException
public static boolean SDsetdimname(long dim_id, java.lang.String dim_name) throws HDFException
HDFException
public static boolean SDsetdimscale(long dim_id, int count, int number_type, byte[] data) throws HDFException
dim_id
- IN: id of a dimensioncount
- IN: number of valuesnumber_type
- IN: number type of the valuesdata
- IN: byte[], the values, in an array of
bytes.HDFException
- should be thrown for errors.
Note: the calling program must assure that the data is correctly formatted for C. To write an array of Java objects, use the alternative routine below.
public static boolean SDsetdimscale(long dim_id, int count, int number_type, java.lang.Object theData) throws HDFException
dim_id
- IN: id of a dimensioncount
- IN: number of valuesnumber_type
- IN: number type of the valuestheData
- OUT: Object, a Java array of appropriate
type and size.HDFException
- should be thrown for errors.
Note: converts the Java array to an array of bytes, and writes the bytes.
public static boolean SDsetdimstrs(long dim_id, java.lang.String label, java.lang.String unit, java.lang.String format) throws HDFException
HDFException
public static boolean SDsetexternalfile(long sds_id, java.lang.String filename, int offset) throws HDFException
HDFException
public static boolean SDsetfillvalue(long sds_id, byte[] fill_val) throws HDFException
sds_id
- IN: id of a datasetfill_val
- IN: byte[], the fill values in an array of
bytes.HDFException
- should be thrown for errors.
Note: the calling program must assure that the data is correctly formatted for C. To set the fill value with a Java object, use the alternative routine below.
public static boolean SDsetfillvalue(long sds_id, java.lang.Object the_fill_val) throws HDFException
sds_id
- IN: id of a datasetthe_fill_val
- IN: Object, a Java object of appropriate
typeHDFException
- should be thrown for errors.
Note: converts the Java array to an array of bytes, and writes the bytes.
public static boolean SDsetrange(long sdsid, byte[] max, byte[] min) throws HDFException
sdsid
- IN: id of a datasetmax
- IN: byte[], the max value in an array of bytesmin
- IN: byte[], the min value in an array of bytesHDFException
- should be thrown for errors.
Note: the calling program must assure that the data is correctly formatted for C. To set the max and min value with Java objects, use the alternative routine below.
public static boolean SDsetrange(long sdsid, java.lang.Object max, java.lang.Object min) throws HDFException
sdsid
- IN: id of a datasetmax
- IN: Object, a Java object of appropriate typemin
- IN: Object, a Java object of appropriate typeHDFException
- should be thrown for errors.
Note: converts the Java array to an array of bytes, and writes the bytes.
public static boolean SDwritedata(long sdsid, int[] start, int[] stride, int[] count, byte[] data) throws HDFException
sdsid
- IN: the SD interface id, returned by SDselectstart
- IN: int[], startstride
- IN: int[], stridecount
- IN: int[], countdata
- IN: byte[], data in an array of bytesHDFException
- should be thrown for errors.
NOTE: to write from a Java array use the alternative routine below.
public static boolean SDwritedata(long sdsid, int[] start, int[] stride, int[] count, java.lang.Object theData) throws HDFException
sdsid
- IN: the SD interface id, returned by SDselectstart
- IN: int[], startstride
- IN: int[], stridecount
- IN: int[], counttheData
- IN: Object, a Java array of appropriate
type, dimensions, and size.HDFException
- should be thrown for errors.
Note: converts to the Java array to a contiguous array of bytes and then writes to the file.
public static boolean SDsetnbitdataset(long id, int start_bit, int bit_len, int sign_ext, int fill_one) throws HDFException
HDFException
public static boolean SDsetcompress(long id, int type, HDFCompInfo cinfo) throws HDFException
id
- IN: the SD identifier returned by SDselecttype
- IN: the type of compressioncinfo
- IN: HDFCompInfo, the compression infoHDFException
- should be thrown for errors.
NOTE:The compression algorithm specific information is passed in an appropriate sub-class of HDFCompInfo.
public static boolean SDgetcompinfo(long id, HDFCompInfo cinfo) throws HDFException
SDgetcompinfo(long, HDFCompInfo)
id
- IN: the SD identifier returned by SDselectcinfo
- IN: HDFCompInfo, the compression infoHDFException
- should be thrown for errors.
NOTE:The compression algorithm specific information is passed in an appropriate sub-class of HDFCompInfo.
public static boolean SDsetaccesstype(long id, int accesstype) throws HDFException
HDFException
public static boolean SDsetblocksize(long sdsid, int block_size) throws HDFException
HDFException
public static boolean SDsetfillmode(long sdsid, boolean fill_enable) throws HDFException
sdsid
- IN: the SD idfill_enable
- IN: boolean, true calls library with
SD_FILL, false calls library with SD_NOFILLHDFException
- should be thrown for errors.public static boolean SDsetfillmode(long sdsid, int fillmode) throws HDFException
HDFException
public static boolean SDsetdimval_comp(long dimid, int comp_mode) throws HDFException
HDFException
public static boolean SDisdimval_bwcomp(long dimid) throws HDFException
HDFException
public static boolean SDsetchunk(long sdsid, HDFChunkInfo chunk_def, int flags) throws HDFException
sdsid
- IN: the SD identifier returned by SDselectchunk_def
- IN: HDFChunkInfo, the chunking infoflags
- IN: the type of chunkingHDFException
- should be thrown for errors.
NOTE:The chunking algorithm-specific information is passed in an appropriate sub-class of HDFChunkInfo.
public static boolean SDgetchunkinfo(long sdsid, HDFChunkInfo chunk_def, int[] clflags) throws HDFException
sdsid
- IN: the SD identifier returned by SDselectchunk_def
- OUT: HDFChunkInfo, the chunking infoclflags
- OUT: int[1], the type of chunkingNOTE:The chunking algorithm-specific information is passed in an appropriate sub-class of HDFChunkInfo.
HDFException
- should be thrown for errors.public static boolean SDreadchunk(long sdsid, int[] origin, byte[] theData) throws HDFException
sdsid
- IN: the SD interface id, returned by SDselectorigin
- IN: int[], origintheData
- OUT: byte[], the data in an array of bytesHDFException
- should be thrown for errors.
NOTE: to read into a Java array use the alternative routine below.
public static boolean SDreadchunk(long sdsid, int[] origin, java.lang.Object theData) throws HDFException
sdsid
- IN: the SD interface id, returned by SDselectorigin
- IN: int[], origintheData
- IN: Object, a Java array of appropriate
type, dimensions, and size.HDFException
- should be thrown for errors.
Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
public static int SDsetchunkcache(long sdsid, int maxcache, int flags) throws HDFException
HDFException
public static boolean SDwritechunk(long sdsid, int[] origin, byte[] data) throws HDFException
sdsid
- IN: the SD interface id, returned by SDselectorigin
- IN: int[], origindata
- IN: byte[], data to be written, in an array of bytesHDFException
- should be thrown for errors.
NOTE: to write from a Java array use the alternative routine below.
public static boolean SDwritechunk(long sdsid, int[] origin, java.lang.Object theData) throws HDFException
sdsid
- IN: the SD interface id, returned by SDselectorigin
- IN: int[], origintheData
- IN: Object, a Java array of appropriate
type, dimensions, and size.HDFException
- should be thrown for errors.
Note: converts to the Java array to a contiguous array of bytes and then writes to the file.
public static int VFfieldesize(long vdata_id, int field_index) throws HDFException
HDFException
public static int VFfieldisize(long vdata_id, int field_index) throws HDFException
HDFException
public static java.lang.String VFfieldname(long vdata_id, int field_index) throws HDFException
HDFException
public static int VFfieldorder(long vdata_id, int field_index) throws HDFException
HDFException
public static long VFfieldtype(long vdata_id, int field_index) throws HDFException
HDFException
public static int VFnfields(long vkey) throws HDFException
HDFException
public static int VHmakegroup(long file_id, int[] tag_array, int[] ref_array, int n_objects, java.lang.String vgroup_name, java.lang.String vgroup_class) throws HDFException
HDFException
public static int VHstoredata(long file_id, java.lang.String fieldname, byte[] buf, int n_records, int data_type, java.lang.String vdata_name, java.lang.String vdata_class) throws HDFException
file_id
- IN: the SD interface id, returned by SDselectfieldname
- IN: String, the name of the field to be filledbuf
- IN: byte[], data to be written, in an array of bytesn_records
- IN: int, the number of records being writtendata_type
- IN: int, the number type of the datavdata_name
- IN: String, the name of the Vdatavdata_class
- IN: String, the class of the VdataHDFException
- should be thrown for errors.
NOTE: to write from a Java array use the alternative routine below.
public static int VHstoredata(long file_id, java.lang.String fieldname, java.lang.Object thebuf, int n_records, int data_type, java.lang.String vdata_name, java.lang.String vdata_class) throws HDFException
file_id
- IN: the SD interface id, returned by SDselectfieldname
- IN: String, the name of the field to be filledthebuf
- IN: Object, data to be written, in a Java array
of appropriate type and sizen_records
- IN: int, the number of records being writtendata_type
- IN: int, the number type of the datavdata_name
- IN: String, the name of the Vdatavdata_class
- IN: String, the class of the VdataHDFException
- should be thrown for errors.
Note: converts to the Java array to a contiguous array of bytes and then writes to the file.
public static int VHstoredatam(long file_id, java.lang.String fieldname, byte[] buf, int n_records, int data_type, java.lang.String vdata_name, java.lang.String vdata_class, int order) throws HDFException
file_id
- IN: the SD interface id, returned by SDselectfieldname
- IN: String, the name of the field to be filledbuf
- IN: byte[], data to be written, in an array of bytesn_records
- IN: int, the number of records being writtendata_type
- IN: int, the number type of the datavdata_name
- IN: String, the name of the Vdatavdata_class
- IN: String, the class of the Vdataorder
- IN: int, the number of components per fieldHDFException
- should be thrown for errors.
NOTE: to write from a Java array use the alternative routine below.
public static int VHstoredatam(long file_id, java.lang.String fieldname, java.lang.Object buf, int n_records, int data_type, java.lang.String vdata_name, java.lang.String vdata_class, int order) throws HDFException
file_id
- IN: the SD interface id, returned by SDselectfieldname
- IN: String, the name of the field to be filledbuf
- IN: Object, data to be written, in a Java array
of appropriate type, dimension, and sizen_records
- IN: int, the number of records being writtendata_type
- IN: int, the number type of the datavdata_name
- IN: String, the name of the Vdatavdata_class
- IN: String, the class of the Vdataorder
- IN: int, the number of components per fieldHDFException
- should be thrown for errors.
Note: converts to the Java array to a contiguous array of bytes and then writes to the file.
public static int VQueryref(long vkey) throws HDFException
HDFException
public static int VQuerytag(long vkey) throws HDFException
HDFException
public static boolean Vstart(long fid) throws HDFException
HDFException
public static int Vattach(long fid, int vgroup_ref, java.lang.String access) throws HDFException
HDFException
public static void Vdetach(long vgroup_id) throws HDFException
HDFException
public static void Vend(long file_id) throws HDFException
HDFException
public static int Vgetid(long file_id, int vgroup_ref) throws HDFException
HDFException
public static void Vgetclass(long vgroup_id, java.lang.String[] hdfclassname) throws HDFException
vgroup_id
- IN: the Vgroup idhdfclassname
- OUT: String[1], the HDF class of
the vgroup.HDFException
- should be thrown for errors in the
HDF library call.public static void Vgetname(long vgroup_id, java.lang.String[] hdfname) throws HDFException
vgroup_id
- IN: the Vgroup idhdfname
- OUT: String[1], the name of
the vgroup.HDFException
- should be thrown for errors in the
HDF library call.public static boolean Visvg(long vgroup_id, int vgroup_ref) throws HDFException
HDFException
public static boolean Visvs(long vgroup_id, int vdata_ref) throws HDFException
HDFException
public static int Vgettagrefs(long vgroup_id, int[] tags, int[] refs, int arraysize) throws HDFException
vgroup_id
- IN: the Vgroup idtags
- OUT: int[arraysize], the tagsrefs
- OUT: int[arraysize], the refsarraysize
- IN: int, the number of tags/refs to
returnHDFException
- should be thrown for errors in the
HDF library call.public static boolean Vgettagref(long vgroup_id, int index, int[] tagref) throws HDFException
vgroup_id
- - IN: the Vgroup idindex
- - IN: the index of the objecttagref
- - OUT: tagref[0]=tag, tagref[1]=refHDFException
- should be thrown for errors in the
HDF library call.public static int Vntagrefs(long vgroup_id) throws HDFException
HDFException
public static boolean Vinqtagref(long vgroup_id, int tag, int ref) throws HDFException
HDFException
public static int Vlone(long fid, int[] ref_array, int buffersize) throws HDFException
fid
- IN: the file identifier returned by Hopenref_array
- OUT: int[], the refs for Vdata not part
of Vgroupsbuffersize
- IN: the max size of the ref_arrayHDFException
- should be thrown for errors in the
HDF library call.public static int Vaddtagref(long vgroup_id, int tag, int ref) throws HDFException
HDFException
public static int Vdeletetagref(long vgroup_id, int tag, int ref) throws HDFException
HDFException
public static int Vfind(long file_id, java.lang.String vgroup_name) throws HDFException
HDFException
public static int Vfindclass(long file_id, java.lang.String vgclassname) throws HDFException
HDFException
public static int Vflocate(int key, java.lang.String vgclassname) throws HDFException
HDFException
public static int Vgetnext(int key, int ref) throws HDFException
HDFException
public static boolean Vinquire(long vgroup_id, int[] n_entries, java.lang.String[] vgroup_name) throws HDFException
vgroup_id
- IN: the Vgroup idn_entries
- OUT: int[1], the number of objects in the Vgroupvgroup_name
- OUT: String[1], the name of the VgroupHDFException
- should be thrown for errors in the
HDF library call.public static int Vinsert(long vgroup_id, long v_id) throws HDFException
HDFException
public static int Vnrefs(int key, int ref) throws HDFException
HDFException
public static boolean Vsetclass(long vgroup_id, java.lang.String vgclassname) throws HDFException
HDFException
public static boolean Vsetname(long vgroup_id, java.lang.String vgname) throws HDFException
HDFException
public static boolean Vattrinfo(long id, int index, java.lang.String[] name, int[] argv) throws HDFException
id
- IN: Vgroup identifier returned by Vattachindex
- IN: the index of the attributename
- OUT: String[1], the name of the attributeargv
- OUT: int[5],
Data type of the target attribute,
Number of values in the target attribute,
Size, in bytes, of the values of the target attribute,
,HDFException
- should be thrown for errors in the
HDF library call, but is not yet implemented.public static long Vfindattr(long id, java.lang.String name) throws HDFException
HDFException
public static boolean Vgetattr(long id, int index, byte[] data) throws HDFException
id
- IN: the Vdata idindex
- IN: the index of the attributedata
- OUT: byte[], the data in an array of bytesHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to read into a Java array use the alternative routine below.
public static boolean Vgetattr(long id, int index, java.lang.Object theData) throws HDFException
id
- IN: the Vdata idindex
- IN: the index of the attributetheData
- OUT: Object, a Java array of appropriate
type, dimensions, and size.HDFException
- should be thrown for errors in the
HDF library call.
Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
public static int Vgetversion(long id) throws HDFException
HDFException
public static int Vnattrs(long id) throws HDFException
HDFException
public static boolean Vsetattr(long id, java.lang.String attr_name, long data_type, int count, java.lang.String values) throws HDFException
HDFException
public static boolean Vsetattr(long id, java.lang.String attr_name, long data_type, int count, byte[] data) throws HDFException
id
- IN: the Vdata idattr_name
- IN: String, the name of the attributedata_type
- IN: int, the number_type of the attributecount
- IN: the number of valuesdata
- IN: byte[], the data in an array of bytesHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to write into a Java array use the alternative routine below.
public static boolean Vsetattr(long id, java.lang.String attr_name, long data_type, int count, java.lang.Object theData) throws HDFException
id
- IN: the Vdata idattr_name
- IN: String, the name of the attributedata_type
- IN: int, the number_type of the attributecount
- IN: the number of valuestheData
- IN: Object, a Java array of appropriate
type, dimensions, and size.HDFException
- should be thrown for errors in the
HDF library call.
Note: converts the data to a contiguous array of bytes and then converts writes it.
public static boolean VSQuerycount(long vdata_id, int[] n_records) throws HDFException
vdata_id
- IN, vdata id as returned by VSattachn_records
- OUT, int[1], the number of records in the vdataHDFException
- should be thrown for errors in the
HDF library call.public static boolean VSQueryfields(long vdata_id, java.lang.String[] fields) throws HDFException
vdata_id
- IN, vdata id as returned by VSattachfields
- OUT, String[1], the names of the fieldsHDFException
- should be thrown for errors in the
HDF library call.public static boolean VSQueryinterlace(long vdata_id, int[] interlace) throws HDFException
vdata_id
- IN, vdata id as returned by VSattachinterlace
- OUT, int[1], the interlace mode,HDFException
- should be thrown for errors in the
HDF library call.public static boolean VSQueryname(long vdata_id, java.lang.String[] vdata_name) throws HDFException
vdata_id
- IN, vdata id as returned by VSattachvdata_name
- OUT, String[1], the name of the vdataHDFException
- should be thrown for errors in the
HDF library call.public static int VSQueryref(long vdata_id) throws HDFException
HDFException
public static int VSQuerytag(long vdata_id) throws HDFException
HDFException
public static boolean VSQueryvsize(long vdata_id, int[] vdata_size) throws HDFException
vdata_id
- IN, vdata id as returned by VSattachvdata_size
- OUT, int[1], the size of the vdataHDFException
- should be thrown for errors in the
HDF library call.public static int VSattach(long fid, int vdata_ref, java.lang.String access) throws HDFException
HDFException
public static void VSdetach(long vdata_id) throws HDFException
HDFException
public static long VSgetid(long file_id, int vdata_ref) throws HDFException
HDFException
public static void VSgetclass(long vdata_id, java.lang.String[] hdfclassname) throws HDFException
vdata_id
- IN, vdata id as returned by VSattachhdfclassname
- OUT, String[1], the class name of the vdataHDFException
- should be thrown for errors in the
HDF library call.public static void VSgetname(long vdata_id, java.lang.String[] hdfname) throws HDFException
vdata_id
- IN, vdata id as returned by VSattachhdfname
- OUT, String[1], the name of the vdataHDFException
- should be thrown for errors in the
HDF library call.public static int VSelts(long vdata_id) throws HDFException
HDFException
public static boolean VSfdefine(long vdata_id, java.lang.String fieldname, int numbertype, int order) throws HDFException
HDFException
public static boolean VSfexist(long vdata_id, java.lang.String fields) throws HDFException
HDFException
public static int VSfind(long file_id, java.lang.String vdataname) throws HDFException
HDFException
public static int VSsetblocksize(long vdata_id, int blocksize) throws HDFException
HDFException
public static int VSsetnumblocks(long vdata_id, int numblocks) throws HDFException
HDFException
public static int VSgetfields(long vdata_id, java.lang.String[] fieldname) throws HDFException
vdata_id
- IN, vdata id as returned by VSattachfieldname
- OUT, String[1], the names of the fieldsHDFException
- should be thrown for errors in the
HDF library call.public static int VSgetinterlace(long vdata_id) throws HDFException
HDFException
public static boolean VSinquire(long vdata_id, int[] iargs, java.lang.String[] sargs) throws HDFException
vdata_id
- IN, vdata id as returned by VSattachiargs
- OUT, int[3], n_records, interlace, vdata_sizesargs
- OUT, String[2], names the dataset, fieldsNOTE: the parameters for the Java interface are not in the same order as the C interface.
HDFException
- should be thrown for errors in the
HDF library call.public static boolean VSinquire(long vdata_id, int[] iargs) throws HDFException
vdata_id
- IN, vdata id as returned by VSattachiargs
- OUT, int[2], block_size, num_blocksNOTE: the parameters for the Java interface are not in the same order as the C interface.
HDFException
- should be thrown for errors in the
HDF library call.public static int VSlone(long fid, int[] ref_array, int buffersize) throws HDFException
fid
- IN, File identifier returned by Hopenref_array
- OUT, int[?], the refsbuffersize
- IN, int, the max number of refs to
return.HDFException
- should be thrown for errors in the
HDF library call.public static int VSread(long vdata_id, byte[] databuf, int nrecord, int interlace) throws HDFException
vdata_id
- IN: the Vdata iddatabuf
- OUT: byte[], the data in an array of bytesnrecord
- IN: int, number of recordsinterlace
- IN: int, interlaceHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to read into a Java array use the alternative routine below.
public static int VSread(long vdata_id, java.lang.Object theData, int nrecord, int interlace) throws HDFException
vdata_id
- IN: the Vdata idtheData
- OUT: Object, a Java array of appropriate
type, dimensions, and size.nrecord
- IN: int, number of recordsinterlace
- IN: int, interlaceHDFException
- should be thrown for errors in the
HDF library call.
Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
public static int VSseek(long vdata_id, int record) throws HDFException
HDFException
public static boolean VSsetfields(long vdata_id, java.lang.String fields) throws HDFException
HDFException
public static boolean VSsetinterlace(long vdata_id, int interlace) throws HDFException
HDFException
public static int VSsizeof(long vdata_id, java.lang.String fields) throws HDFException
HDFException
public static boolean VSappendable(int vkey, int block_size) throws HDFException
HDFException
public static int VSfindclass(long file_id, java.lang.String vgclass) throws HDFException
HDFException
public static int VSgetversion(int vkey) throws HDFException
HDFException
public static void VSsetclass(long vdata_id, java.lang.String vdata_class) throws HDFException
HDFException
public static boolean VSsetexternalfile(int vkey, java.lang.String filename, int offset) throws HDFException
HDFException
public static void VSsetname(long vdata_id, java.lang.String vdata_name) throws HDFException
HDFException
public static int VSwrite(long vdata_id, byte[] databuf, int n_records, int interlace) throws HDFException
vdata_id
- IN: the Vdata iddatabuf
- IN: byte[], the data in an array of bytesn_records
- IN: int, number of recordsinterlace
- IN: int, interlaceHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to write a Java array use the alternative routine below.
public static int VSwrite(long vdata_id, java.lang.Object databuf, int n_records, int interlace) throws HDFException
vdata_id
- IN: the Vdata iddatabuf
- IN: Object, a Java array of appropriate
type, dimensions, and size.n_records
- IN: int, number of recordsinterlace
- IN: int, interlaceHDFException
- should be thrown for errors in the
HDF library call.
Important Note: This interface only supports records which are all of the same numeric type, with no character fields. Heterogeneous fields can be written as bytes (see above), but the calling program must make sure the data is in proper order to write to the HDF library.
Note: converts the data into a contiguous array of bytes and then writes it
public static boolean VSattrinfo(long id, int index, int attr_index, java.lang.String[] name, int[] argv) throws HDFException
id
- IN: the Vdata idindex
- IN: int, the index of the attributeattr_index
- IN: int, the index of the attributename
- OUT: String[1], the name of the attributeargv
- OUT: int[3],
Data type of the target attribute,
Number of values in the target attribute,
Size, in bytes, of the values of the target attribute,HDFException
- should be thrown for errors in the
HDF library call.public static int VSfindex(long id, java.lang.String name, int[] findex) throws HDFException
id
- IN: the Vdata idname
- IN: the name of the attributefindex
- IN: int[1], the index of the attributeHDFException
- should be thrown for errors in the
HDF library call.public static int VSfindattr(long id, int index, java.lang.String name) throws HDFException
HDFException
public static int VSfnattrs(long id, int fnattrs) throws HDFException
HDFException
public static boolean VSgetattr(long id, int index, int attr_index, byte[] data) throws HDFException
id
- IN: the Vdata idindex
- IN: the index of the vdataattr_index
- IN: the index of the attributedata
- OUT: byte[], the data in an array of bytesHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to read into a Java array use the alternative routine below.
public static boolean VSgetattr(long id, int index, int attr_index, java.lang.Object theData) throws HDFException
id
- IN: the Vdata idindex
- IN: the index of the vdataattr_index
- IN: the index of the attributetheData
- OUT: Object, a Java array of appropriate
type, dimensions, and size.HDFException
- should be thrown for errors in the
HDF library call.
Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
public static boolean VSisattr(long id) throws HDFException
HDFException
public static int VSnattrs(long id) throws HDFException
HDFException
public static boolean VSsetattr(long id, int index, java.lang.String attr_name, long data_type, int count, java.lang.String values) throws HDFException
id
- IN: the Vdata idindex
- IN: the index of the vdataattr_name
- IN: String, the name of the attributedata_type
- IN: int, the number_type of the attributecount
- IN: the number of valuesvalues
- IN: String, the data in an StringHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to write from a Java array use the alternative routine below.
public static boolean VSsetattr(long id, int index, java.lang.String attr_name, long data_type, int count, byte[] values) throws HDFException
id
- IN: the Vdata idindex
- IN: the index of the vdataattr_name
- IN: String, the name of the attributedata_type
- IN: int, the number_type of the attributecount
- IN: the number of valuesvalues
- IN: byte[], the data in an array of bytesHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to write into a Java array use the alternative routine below.
public static boolean VSsetattr(long id, int index, java.lang.String attr_name, long data_type, int count, java.lang.Object theData) throws HDFException
id
- IN: the Vdata idindex
- IN: the index of the vdataattr_name
- IN: String, the name of the attributedata_type
- IN: int, the number_type of the attributecount
- IN: the number of valuestheData
- IN: Object, a Java array of appropriate
type, dimensions, and size.HDFException
- should be thrown for errors in the
HDF library call.
Note: converts the data to a contiguous array of bytes and then converts writes it.
public static boolean DF24getdims(java.lang.String fileName, int[] argv) throws HDFException
fileName
- IN: String, the fileargv
- OUT: int[3], the width, height, and interlace modeHDFException
- should be thrown for errors in the
HDF library call.public static boolean DF24reqil(int il) throws HDFException
HDFException
public static boolean DF24getimage(java.lang.String fileName, byte[] imagedata, int width, int height) throws HDFException
fileName
- IN: String, the fileimagedata
- OUT: byte[], the image, in an array of
byteswidth
- IN: int, the width of the imageheight
- IN: int, the height of the imageHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to read into a Java array use the alternative routine below.
public static boolean DF24getimage(java.lang.String fileName, java.lang.Object theImagedata, int width, int height) throws HDFException
fileName
- IN: String, the filetheImagedata
- OUT: Object, the image, in a java
array of appropriate size and typewidth
- IN: int, the width of the imageheight
- IN: int, the height of the imageHDFException
- should be thrown for errors in the
HDF library call.
Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
public static short DF24lastref() throws HDFException
HDFException
public static boolean DF24restart() throws HDFException
HDFException
public static boolean DF24readref(java.lang.String filename, int ref) throws HDFException
HDFException
public static int DF24nimages(java.lang.String fileName) throws HDFException
HDFException
public static boolean DF24addimage(java.lang.String filename, byte[] image, int width, int height) throws HDFException
filename
- IN: String, the fileimage
- IN: byte[], the image, in an array of
byteswidth
- IN: int, the width of the imageheight
- IN: int, the height of the imageHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to write from a Java array use the alternative routine below.
public static boolean DF24addimage(java.lang.String filename, java.lang.Object theImage, int width, int height) throws HDFException
filename
- IN: String, the filetheImage
- IN: Object, the image, in a java
array of appropriate size and typewidth
- IN: int, the width of the imageheight
- IN: int, the height of the imageHDFException
- should be thrown for errors in the
HDF library call.
Note: converts the data into a contiguous array of bytes and then writes it to the file
public static boolean DF24putimage(java.lang.String filename, byte[] image, int width, int height) throws HDFException
filename
- IN: String, the fileimage
- IN: byte[], the image, in an array of
byteswidth
- IN: int, the width of the imageheight
- IN: int, the height of the imageHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to write from a Java array use the alternative routine below.
public static boolean DF24putimage(java.lang.String filename, java.lang.Object theImage, int width, int height) throws HDFException
filename
- IN: String, the filetheImage
- IN: Object, the image, in a java
array of appropriate size and typewidth
- IN: int, the width of the imageheight
- IN: int, the height of the imageHDFException
- should be thrown for errors in the
HDF library call.
Note: converts the data into a contiguous array of bytes and then writes it to the file
public static boolean DF24setcompress(int type, HDFCompInfo cinfo) throws HDFException
type
- IN: int, the type of compressioncinfo
- IN: HDFCompInfo, the compression parametersHDFException
- should be thrown for errors in the
HDF library call.public static boolean DF24setdims(int width, int height) throws HDFException
HDFException
public static boolean DF24setil(int il) throws HDFException
HDFException
public static boolean DFR8getdims(java.lang.String fileName, int[] argv, boolean[] haspalette) throws HDFException
fileName
- IN: String, the fileargv
- OUT: int[2], the width and heighthaspalette
- OUT: boolean[1], has a paletteHDFException
- should be thrown for errors in the
HDF library call.public static boolean DFR8getimage(java.lang.String fileName, byte[] imagedata, int width, int height, byte[] palette) throws HDFException
fileName
- IN: String, the fileimagedata
- OUT: byte[], the image, in an array of
byteswidth
- IN: int, the width of the imageheight
- IN: int, the height of the imagepalette
- OUT: byte[], the color look up tableHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to read into a Java array use the alternative routine below.
public static boolean DFR8getimage(java.lang.String fileName, java.lang.Object theImagedata, int width, int height, byte[] palette) throws HDFException
fileName
- IN: String, the filetheImagedata
- OUT: Object, the image, in a java
array of appropriate size and typewidth
- IN: int, the width of the imageheight
- IN: int, the height of the imagepalette
- OUT: byte[], the color look up tableHDFException
- should be thrown for errors in the
HDF library call.
Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
public static short DFR8lastref() throws HDFException
HDFException
public static boolean DFR8restart() throws HDFException
HDFException
public static boolean DFR8readref(java.lang.String filename, int ref) throws HDFException
HDFException
public static int DFR8nimages(java.lang.String fileName) throws HDFException
HDFException
public static boolean DFR8addimage(java.lang.String filename, byte[] image, int width, int height, short compress) throws HDFException
filename
- IN: String, the fileimage
- IN: byte[], the image, in an array of
byteswidth
- IN: int, the width of the imageheight
- IN: int, the height of the imagecompress
- IN: short, the type of compressionHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to write from a Java array use the alternative routine below.
public static boolean DFR8addimage(java.lang.String filename, java.lang.Object theImage, int width, int height, short compress) throws HDFException
filename
- IN: String, the filetheImage
- IN: Object, the image, in a java
array of appropriate size and typewidth
- IN: int, the width of the imageheight
- IN: int, the height of the imagecompress
- IN: short, the type of compressionHDFException
- should be thrown for errors in the
HDF library call.
Note: converts the data into a contiguous array of bytes and then writes it to the file
public static boolean DFR8putimage(java.lang.String filename, byte[] image, int width, int height, short compress) throws HDFException
filename
- IN: String, the fileimage
- IN: byte[], the image, in an array of
byteswidth
- IN: int, the width of the imageheight
- IN: int, the height of the imagecompress
- IN: short, the type of compressionHDFException
- should be thrown for errors in the
HDF library call.
NOTE: to write from a Java array use the alternative routine below.
public static boolean DFR8putimage(java.lang.String filename, java.lang.Object theImage, int width, int height, short compress) throws HDFException
filename
- IN: String, the filetheImage
- IN: Object, the image, in a java
array of appropriate size and typewidth
- IN: int, the width of the imageheight
- IN: int, the height of the imagecompress
- IN: short, the type of compressionHDFException
- should be thrown for errors in the
HDF library call.
Note: converts the data into a contiguous array of bytes and then writes it to the file
public static boolean DFR8setcompress(int type, HDFCompInfo cinfo) throws HDFException
type
- IN: int, the type of compressioncinfo
- IN: HDFCompInfo, the compression parametersHDFException
- should be thrown for errors in the
HDF library call.public static boolean DFR8getpalref(short[] palref) throws HDFException
palref
- OUT: short[1], the HDF ref of the paletteHDFException
- should be thrown for errors in the
HDF library call.public static boolean DFR8setpalette(byte[] palette) throws HDFException
HDFException
public static boolean DFR8writeref(java.lang.String filename, short ref) throws HDFException
HDFException
public static int HCget_config_info(int coder_type) throws HDFException
coder_type
- comp_coder_t enum for determining which type of encoding is being doneHDFException
- should be thrown for errors in the
HDF library call, but is not yet implemented.