All Packages Class Hierarchy This Package Previous Next Index
Class ncsa.hdf.hdflib.HDFLibrary
java.lang.Object
|
+----ncsa.hdf.hdflib.HDFLibrary
- public class HDFLibrary
- extends Object
This is the Java interface for the HDF 4.1 library
This code is the called by Java programs to access the
entry points of the HDF 4.1 library.
Each routine wraps a single HDF entry point, generally with the
arguments and return codes analogous to the C interface.
For details of the HDF libraries, see the HDF Documentation at:
http://hdf.ncsa.uiuc.edu
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 types to Java types
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
|
General Rules for Passing Arguments and Results
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 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[][][].
Compression and Chunk Information
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: :\b>
ncsa.hdf.hdflib.HDFChunkInfo,
and
ncsa.hdf.hdflib.HDFCompInfo.
-
HDFLibrary()
-
-
ANannlen(int)
-
-
ANannlist(int, int, int, int, int[])
-
-
ANatype2tag(int)
-
-
ANcreate(int, short, short, int)
-
-
ANcreatef(int, int)
-
-
ANdestroy()
-
-
ANend(int)
-
-
ANendaccess(int)
-
-
ANfileinfo(int, int[])
-
-
ANget_tagref(int, int, int, short[])
-
-
ANid2tagref(int, short[])
-
-
ANnumann(int, int, short, short)
-
-
ANreadann(int, String[], int)
-
-
ANselect(int, int, int)
-
-
ANstart(int)
-
-
ANtag2atype(short)
-
-
ANtagref2id(int, short, short)
-
-
ANwriteann(int, String, int)
-
-
DF24addimage(String, byte[], int, int)
-
-
DF24addimage(String, Object, int, int)
-
-
DF24getdims(String, int[])
-
-
DF24getimage(String, byte[], int, int)
-
-
DF24getimage(String, Object, int, int)
-
-
DF24lastref()
-
-
DF24nimages(String)
-
-
DF24putimage(String, byte[], int, int)
-
-
DF24putimage(String, Object, int, int)
-
-
DF24readref(String, int)
-
-
DF24reqil(int)
-
-
DF24restart()
-
-
DF24setcompress(int, HDFCompInfo)
-
-
DF24setdims(int, int)
-
-
DF24setil(int)
-
-
DFKNTsize(int)
-
-
DFPaddpal(String, byte[])
-
-
DFPgetpal(String, byte[])
-
-
DFPlastref()
-
-
DFPnpals(String)
-
-
DFPputpal(String, byte[], boolean, String)
-
-
DFPputpal(String, byte[], int, String)
-
-
DFPreadref(String, short)
-
-
DFPrestart()
-
-
DFPwriteref(String, short)
-
-
DFR8addimage(String, byte[], int, int, short)
-
-
DFR8addimage(String, Object, int, int, short)
-
-
DFR8getdims(String, int[], boolean[])
-
-
DFR8getimage(String, byte[], int, int, byte[])
-
-
DFR8getimage(String, Object, int, int, byte[])
-
-
DFR8getpalref(short[])
-
-
DFR8lastref()
-
-
DFR8nimages(String)
-
-
DFR8putimage(String, byte[], int, int, short)
-
-
DFR8putimage(String, Object, int, int, short)
-
-
DFR8readref(String, int)
-
-
DFR8restart()
-
-
DFR8setcompress(int, HDFCompInfo)
-
-
DFR8setpalette(byte[])
-
-
DFR8writeref(String, short)
-
-
GRattrinfo(int, int, String[], int[])
-
-
GRcreate(int, String, int, int, int, int[])
-
-
GRend(int)
-
-
GRendaccess(int)
-
-
GRfileinfo(int, int[])
-
-
GRfindattr(int, String)
-
-
GRgetattr(int, int, byte[])
-
-
GRgetattr(int, int, Object)
-
-
GRgetchunkinfo(int, HDFChunkInfo, int[])
-
-
GRgetiminfo(int, String[], int[], int[])
-
-
GRgetlutid(int, int)
-
-
GRgetlutinfo(int, int[])
-
-
GRidtoref(int)
-
-
GRluttoref(int)
-
-
GRnametoindex(int, String)
-
-
GRreadimage(int, int[], int[], int[], byte[])
-
-
GRreadimage(int, int[], int[], int[], Object)
-
-
GRreadlut(int, byte[])
-
-
GRreadlut(int, Object)
-
-
GRreftoindex(int, short)
-
-
GRreqimageil(int, int)
-
-
GRreqlutil(int, int)
-
-
GRselect(int, int)
-
-
GRsetattr(int, String, int, int, byte[])
-
-
GRsetattr(int, String, int, int, Object)
-
-
GRsetattr(int, String, int, int, String)
-
-
GRsetchunk(int, HDFChunkInfo, int)
-
-
GRsetchunkcache(int, int, int)
-
-
GRsetcompress(int, int, HDFCompInfo)
-
-
GRsetexternalfile(int, String, int)
-
-
GRstart(int)
-
-
GRwriteimage(int, int[], int[], int[], byte[])
-
-
GRwriteimage(int, int[], int[], int[], Object)
-
-
GRwritelut(int, int, int, int, int, byte[])
-
-
GRwritelut(int, int, int, int, int, Object)
-
-
Hcache(int, int)
-
-
Hclose(int)
-
-
HDFclose(int)
-
-
HDFopen(String, int, short)
-
-
HDgetNTdesc(int)
-
-
HEstring(int)
-
-
HEvalue(int)
-
-
Hgetfileversion(int, int[], String[])
-
Note: the version of an HDF file is not well defined,
it is not recommended that programs rely on these numbers.
-
Hgetlibversion(int[], String[])
-
-
Hishdf(String)
-
-
Hnumber(int)
-
-
Hopen(String)
-
-
Hopen(String, int)
-
-
Hsetaccesstype(int, int)
-
-
Hsync(int)
-
-
HXsetcreatedir(String)
-
-
HXsetdir(String)
-
-
SDattrinfo(int, int, String[], int[])
-
-
SDcreate(int, String, int, int, int[])
-
-
SDdiminfo(int, String[], int[])
-
-
SDend(int)
-
-
SDendaccess(int)
-
-
SDfileinfo(int, int[])
-
-
SDfindattr(int, String)
-
-
SDgetcal(int, double[], int[])
-
-
SDgetchunkinfo(int, HDFChunkInfo, int[])
-
-
SDgetdatastrs(int, String[], int)
-
-
SDgetdimid(int, int)
-
-
SDgetdimscale(int, byte[])
-
-
SDgetdimscale(int, Object)
-
-
SDgetdimstrs(int, String[], int)
-
-
SDgetfillvalue(int, byte[])
-
-
SDgetfillvalue(int, Object[])
-
-
SDgetinfo(int, String[], int[], int[])
-
-
SDgetrange(int, byte[], byte[])
-
-
SDgetrange(int, double[])
-
-
SDidtoref(int)
-
-
SDiscoordvar(int)
-
-
SDisdimval_bwcomp(int)
-
-
SDisrecord(int)
-
-
SDnametoindex(int, String)
-
-
SDreadattr(int, int, byte[])
-
-
SDreadattr(int, int, Object)
-
-
SDreadchunk(int, int[], byte[])
-
-
SDreadchunk(int, int[], Object)
-
-
SDreaddata(int, int[], int[], int[], byte[])
-
-
SDreaddata(int, int[], int[], int[], Object)
-
-
SDreftoindex(int, int)
-
-
SDselect(int, int)
-
-
SDsetaccesstype(int, int)
-
-
SDsetattr(int, String, int, int, byte[])
-
-
SDsetattr(int, String, int, int, Object)
-
-
SDsetblocksize(int, int)
-
-
SDsetcal(int, double, double, double, double, int)
-
-
SDsetchunk(int, HDFChunkInfo, int)
-
-
SDsetchunkcache(int, int, int)
-
-
SDsetcompress(int, int, HDFCompInfo)
-
-
SDsetdatastrs(int, String, String, String, String)
-
-
SDsetdimname(int, String)
-
-
SDsetdimscale(int, int, int, byte[])
-
-
SDsetdimscale(int, int, int, Object)
-
-
SDsetdimstrs(int, String, String, String)
-
-
SDsetdimval_comp(int, int)
-
-
SDsetexternalfile(int, String, int)
-
-
SDsetfillmode(int, boolean)
-
-
SDsetfillmode(int, int)
-
-
SDsetfillvalue(int, byte[])
-
-
SDsetfillvalue(int, Object)
-
-
SDsetnbitdataset(int, int, int, int, int)
-
-
SDsetrange(int, byte[], byte[])
-
-
SDsetrange(int, Object, Object)
-
-
SDstart(String, int)
-
-
SDwritechunk(int, int[], byte[])
-
-
SDwritechunk(int, int[], Object)
-
-
SDwritedata(int, int[], int[], int[], byte[])
-
-
SDwritedata(int, int[], int[], int[], Object)
-
-
Vaddtagref(int, int, int)
-
-
Vattach(int, int, String)
-
-
Vattrinfo(int, int, String[], int[])
-
-
Vdetach(int)
-
-
Vend(int)
-
-
VFfieldesize(int, int)
-
-
VFfieldisize(int, int)
-
-
VFfieldname(int, int)
-
-
VFfieldorder(int, int)
-
-
VFfieldtype(int, int)
-
-
Vfind(int, String)
-
-
Vfindattr(int, String)
-
-
Vfindclass(int, String)
-
-
Vflocate(int, String)
-
-
VFnfields(int)
-
-
Vgetattr(int, int, byte[])
-
-
Vgetattr(int, int, Object)
-
-
Vgetclass(int, String[])
-
-
Vgetid(int, int)
-
-
Vgetname(int, String[])
-
-
Vgetnext(int, int)
-
-
Vgettagref(int, int, int[])
-
-
Vgettagrefs(int, int[], int[], int)
-
-
Vgetversion(int)
-
-
VHmakegroup(int, int[], int[], int, String, String)
-
-
VHstoredata(int, String, byte[], int, int, String, String)
-
-
VHstoredata(int, String, Object, int, int, String, String)
-
-
VHstoredatam(int, String, byte[], int, int, String, String, int)
-
-
VHstoredatam(int, String, Object, int, int, String, String, int)
-
-
Vinqtagref(int, int, int)
-
-
Vinquire(int, int[], String[])
-
-
Vinsert(int, int)
-
-
Visvg(int, int)
-
-
Visvs(int, int)
-
-
Vlone(int, int[], int)
-
-
Vnattrs(int)
-
-
Vnrefs(int, int)
-
-
Vntagrefs(int)
-
-
VQueryref(int)
-
-
VQuerytag(int)
-
-
VSappendable(int, int)
-
-
VSattach(int, int, String)
-
-
VSattrinfo(int, int, String[], int[])
-
-
VSdetach(int)
-
-
VSelts(int)
-
-
Vsetattr(int, String, int, int, byte[])
-
-
Vsetattr(int, String, int, int, Object)
-
-
Vsetattr(int, String, int, int, String)
-
-
Vsetclass(int, String)
-
-
Vsetname(int, String)
-
-
VSfdefine(int, String, int, int)
-
-
VSfexist(int, String)
-
-
VSfind(int, String)
-
-
VSfindattr(int, int, String)
-
-
VSfindclass(int, String)
-
-
VSfindex(int, String, int[])
-
-
VSfnattrs(int, int)
-
-
VSgetattr(int, int, int, byte[])
-
-
VSgetattr(int, int, int, Object)
-
-
VSgetclass(int, String[])
-
-
VSgetfields(int, String[])
-
-
VSgetid(int, int)
-
-
VSgetinterlace(int)
-
-
VSgetname(int, String[])
-
-
VSgetversion(int)
-
-
VSinquire(int, int[], String[])
-
-
VSisattr(int)
-
-
VSlone(int, int[], int)
-
-
VSnattrs(int)
-
-
VSQuerycount(int, int[])
-
-
VSQueryfields(int, String[])
-
-
VSQueryinterlace(int, int[])
-
-
VSQueryname(int, String[])
-
-
VSQueryref(int)
-
-
VSQuerytag(int)
-
-
VSQueryvsize(int, int[])
-
-
VSread(int, byte[], int, int)
-
-
VSread(int, Object, int, int)
-
-
VSseek(int, int)
-
-
VSsetattr(int, int, String, int, int, byte[])
-
-
VSsetattr(int, int, String, int, int, Object)
-
-
VSsetattr(int, int, String, int, int, String)
-
-
VSsetclass(int, String)
-
-
VSsetexternalfile(int, String, int)
-
-
VSsetfields(int, String)
-
-
VSsetinterlace(int, int)
-
-
VSsetname(int, String)
-
-
VSsizeof(int, String)
-
-
Vstart(int)
-
-
VSwrite(int, byte[], int, int)
-
-
VSwrite(int, Object, int, int)
-
HDFLibrary
public HDFLibrary()
Hopen
public int Hopen(String filename) throws HDFException
Hopen
public native int Hopen(String filename,
int access) throws HDFException
Hclose
public native boolean Hclose(int fid) throws HDFException
Hishdf
public native boolean Hishdf(String fileName) throws HDFException
Hnumber
public native int Hnumber(int fid) throws HDFException
DFKNTsize
public static native int DFKNTsize(int numbertype) throws HDFException
HDgetNTdesc
public native String HDgetNTdesc(int nt) throws HDFException
Hcache
public native boolean Hcache(int file_id,
int cache_switch) throws HDFException
Hgetfileversion
public native boolean Hgetfileversion(int file_id,
int vers[],
String string[]) throws HDFException
- Note: the version of an HDF file is not well defined,
it is not recommended that programs rely on these numbers.
- Parameters:
- file_id - IN: int, the file descriptor returned by Hopen
- vers - OUT: int[3], the major version, minor version,
and release number of the file.
- string - OUT: String[1], the version string
- Returns:
- the major, minor, and release number are returned
in the array of ints, and a string is returned in the string.
Hgetlibversion
public native boolean Hgetlibversion(int vers[],
String string[]) throws HDFException
- Parameters:
- vers - OUT: int[3], the major version, minor version,
and release number of the HDF library.
- string - OUT: String[1], the version string
- Returns:
- the major, minor, and release number are returned
in the array of ints, and a string is returned in the string.
Hsetaccesstype
public native boolean Hsetaccesstype(int h_id,
int access_type) throws HDFException
Hsync
public native boolean Hsync(int file_id) throws HDFException
ANstart
public native int ANstart(int fid) throws HDFException
ANend
public native boolean ANend(int an_id) throws HDFException
ANendaccess
public native boolean ANendaccess(int an_id) throws HDFException
ANfileinfo
public native boolean ANfileinfo(int an_id,
int info[]) throws HDFException
- Parameters:
- an_id - IN: the AN interface id, returned by ANstart
- info - OUT: int[4], n_file_label, n_file_desc,
n_data_label, n_data_desc
- Returns:
- four integer parameters:
info[0] = n_file_label, info[1] = n_file_desc,
info[2] = n_data_label, info[3] = n_data_desc
ANselect
public native int ANselect(int an_id,
int index,
int anntype) throws HDFException
ANnumann
public native int ANnumann(int an_id,
int anntype,
short tag,
short ref) throws HDFException
ANatype2tag
public native short ANatype2tag(int antag) throws HDFException
ANtag2atype
public native int ANtag2atype(short anttype) throws HDFException
ANannlist
public native int ANannlist(int an_id,
int anntype,
int tag,
int ref,
int ann_list[]) throws HDFException
- Parameters:
- an_id - IN: the AN interface id, returned by ANstart
- anntype - IN: the number type, as defined in HDFConstants
- tag - IN: the HDF tag
- ref - IN: the HDF ref
- vers - OUT: int[], an array of annotation identifiers.
The array must be long enough to hold the number of annotations
returned by ANnumann
- Returns:
- an array of integers, which are the identifiers of
the annotations
ANannlen
public native int ANannlen(int ann_id) throws HDFException
ANreadann
public native boolean ANreadann(int ann_id,
String annbuf[],
int maxlen) throws HDFException
- Parameters:
- an_id - IN: the AN interface id, returned by ANstart
- annbuf - OUT: String[1], the annotation
is returned as annbuf[0].
- tag - IN: int, the maximum length of the string.
- Returns:
- an annotation string: annbuf[0] = the annotation
ANcreate
public native int ANcreate(int an_id,
short tag,
short ref,
int type) throws HDFException
ANcreatef
public native int ANcreatef(int an_id,
int type) throws HDFException
ANdestroy
public native boolean ANdestroy() throws HDFException
ANget_tagref
public native int ANget_tagref(int an_id,
int index,
int type,
short tagref[]) throws HDFException
- Parameters:
- an_id - IN: the AN interface id, returned by ANstart
- index - IN: the index of the annotation
- type - IN: the type of the annotation
- tagref - OUT: short[2], the tag and ref of the annotation
- Returns:
- the tag and ref: tagref[0] = tag, tagref[1] = ref
ANid2tagref
public native boolean ANid2tagref(int an_id,
short tagref[]) throws HDFException
- Parameters:
- an_id - IN: the AN interface id, returned by ANstart
- tagref - OUT: short[2], the tag and ref of the annotation
- Returns:
- the tag and ref: tagref[0] = tag, tagref[1] = ref
ANtagref2id
public native int ANtagref2id(int an_id,
short tag,
short ref) throws HDFException
ANwriteann
public native boolean ANwriteann(int ann_id,
String label,
int ann_length) throws HDFException
DFPaddpal
public native boolean DFPaddpal(String filename,
byte palette[]) throws HDFException
DFPgetpal
public native boolean DFPgetpal(String filename,
byte palette[]) throws HDFException
DFPlastref
public native short DFPlastref() throws HDFException
DFPnpals
public native int DFPnpals(String filename) throws HDFException
DFPputpal
public native boolean DFPputpal(String filename,
byte palette[],
int overwrite,
String filemode) throws HDFException
DFPputpal
public boolean DFPputpal(String filename,
byte palette[],
boolean overwrite,
String filemode) throws HDFException
- Parameters:
- filename - IN: String, the name of the HDF file
- palette - IN: byte[] the palette
- overwrite - IN: boolean, converted to 1 == true, 0 == false
to call the HDF library
DFPreadref
public native boolean DFPreadref(String filename,
short ref) throws HDFException
DFPrestart
public native short DFPrestart() throws HDFException
DFPwriteref
public native boolean DFPwriteref(String filename,
short ref) throws HDFException
GRstart
public native int GRstart(int fid) throws HDFException
GRend
public native boolean GRend(int grid) throws HDFException
GRfileinfo
public native boolean GRfileinfo(int grid,
int args[]) throws HDFException
- Parameters:
- grid - IN: the GR interface id, returned by GRstart
- args - OUT: int[2], n_datasets and n_file_attrs
- Returns:
- the file info: args[0] = n_datasets, args[1] = n_file_attrs
GRgetchunkinfo
public native boolean GRgetchunkinfo(int sdsid,
HDFChunkInfo chunk_def,
int flag[]) throws HDFException
- Parameters:
- sdsid - IN: the SD identifier returned by SDselect
- c_info - OUT: HDFChunkInfo, the chunking info
- flag - OUT: int[1], the type of chunking
- Returns:
- c_info contains information about the chunking method,
flags[0] == the chunking flags
NOTE:The chunking algorithm-specific information is
passed in an appropriate sub-class of HDFChunkInfo.
GRselect
public native int GRselect(int grid,
int index) throws HDFException
GRnametoindex
public native int GRnametoindex(int grid,
String name) throws HDFException
GRgetiminfo
public native boolean GRgetiminfo(int riid,
String gr_name[],
int args[],
int dim_sizes[]) throws HDFException
- Parameters:
- grid - IN: the GR interface id, returned by GRstart
- args - OUT: int[5], image info:
number of components in the image,
data type of the image data,
interlace mode of the stored image data,
sizes of each image dimension ,
number of attributes assigned to the image
- args - OUT: int[2], dim_sizes
- Returns:
- the file info: String[0] = gr_name, args[0] = ncomp,
args[1] = data_type, args[2] = interlace, args[3] = num_attrs
NOTE: the parameters for the Java interface are not in
the same order as the C interface.
GRreadimage
public native boolean GRreadimage(int riid,
int start[],
int stride[],
int count[],
byte data[]) throws HDFException
- Parameters:
- grid - IN: the GR interface id, returned by GRstart
- start - IN: int[], start
- stride - IN: int[], stride
- count - IN: int[], count
- data - OUT: byte[], data
- Returns:
- the the data in the form of a continous array of
bytes.
NOTE: to read into a Java 2D array use the alternative
routine below.
GRreadimage
public boolean GRreadimage(int riid,
int start[],
int stride[],
int count[],
Object theData) throws HDFException
- Parameters:
- grid - IN: the GR interface id, returned by GRstart
- start - IN: int[], start
- stride - IN: int[], stride
- count - IN: int[], count
- theData - OUT: Object, a Java array of appropriate
type, dimensions, and size.
- Returns:
- the the data in the Java array.
Note: reads the data as bytes and converts to
the Java array.
GRendaccess
public native boolean GRendaccess(int riid) throws HDFException
GRidtoref
public native short GRidtoref(int riid) throws HDFException
GRreftoindex
public native int GRreftoindex(int grid,
short ref) throws HDFException
GRreqlutil
public native boolean GRreqlutil(int riid,
int interlace) throws HDFException
GRreqimageil
public native boolean GRreqimageil(int rrid,
int interlace) throws HDFException
GRgetlutid
public native int GRgetlutid(int rrid,
int index) throws HDFException
GRgetlutinfo
public native boolean GRgetlutinfo(int lutid,
int argv[])
- Parameters:
- lutid - IN: the palette identifier returned by GRgetlutid
- args - 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.
- Returns:
- the palette info: args[0] = ncomp, args[1] = data_type,
args[2] = interlace, args[3] = num_entries
GRreadlut
public native boolean GRreadlut(int lutid,
byte data[]) throws HDFException
- Parameters:
- lutid - IN: the palette identifier returned by GRgetlutid
- data - OUT: byte[], palette data, in bytes
- Returns:
- the palette data: as bytes
NOTE: to read into a Java 1D array use the alternative
routine below.
GRreadlut
public boolean GRreadlut(int lutid,
Object theData) throws HDFException
- Parameters:
- lutid - IN: the palette identifier returned by GRgetlutid
- theData - OUT: Object, palette data, an Java array
- Returns:
- the palette data: as a Java array
Note: reads the data as bytes and converts to
the Java array.
GRattrinfo
public native boolean GRattrinfo(int id,
int index,
String name[],
int argv[]) throws HDFException
- Parameters:
- id - IN: the GR identifier returned by GRstart
- index - IN: the index of the attribute
- name - OUT: String[1], the name of the attribute
- argv - OUT: int[2], the type and length of the
attribute
- Returns:
- the name, type, and lenght of the attribute:
name[0] = name, argv[0] = data_type, argv[1] = length
GRgetattr
public native boolean GRgetattr(int id,
int index,
byte data[]) throws HDFException
- Parameters:
- id - IN: the GR identifier returned by GRstart
- data - OUT: byte[], attribute data, in bytes
- Returns:
- the attribute data: as bytes
NOTE: to read into a Java 1D array use the alternative
routine below.
GRgetattr
public boolean GRgetattr(int id,
int index,
Object theData) throws HDFException
- Parameters:
- id - IN: the GR identifier returned by GRstart
- theData - OUT: Object, attribute data, an Java array
- Returns:
- the attribute data: as a Java array
Note: reads the data as bytes and converts to
the Java array.
GRfindattr
public native int GRfindattr(int id,
String name) throws HDFException
GRcreate
public native int GRcreate(int gr_id,
String name,
int ncomp,
int data_type,
int interlace_mode,
int dim_sizes[]) throws HDFException
GRluttoref
public native short GRluttoref(int pal_id) throws HDFException
GRsetattr
public native boolean GRsetattr(int gr_id,
String attr_name,
int data_type,
int count,
String values) throws HDFException
- Parameters:
- id - IN: the GR identifier returned by GRstart
- attr_name - IN: the name of the attribute
- data_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 String
NOTE:This routine writes a attribute that is
a String. Alternative methods write data of other types.
GRsetattr
public native boolean GRsetattr(int gr_id,
String attr_name,
int data_type,
int count,
byte values[]) throws HDFException
- Parameters:
- id - IN: the GR identifier returned by GRstart
- attr_name - IN: the name of the attribute
- data_type - IN: the number type of the data
- count - IN: the length the data (lenght of 'values')
- values - IN: the the attribute to write -- in an
array of bytes
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.
GRsetattr
public boolean GRsetattr(int gr_id,
String attr_name,
int data_type,
int count,
Object theData) throws HDFException
- Parameters:
- id - IN: the GR identifier returned by GRstart
- attr_name - IN: the name of the attribute
- data_type - IN: the number type of the data
- count - IN: the length the data (lenght of 'values')
- values - IN: Object -- the value to be written,
a Java array of numbers.
NOTE:This routine converts the Java array to bytes
then writes it.
DO NOT USE THIS TO WRITE A STRING.
GRsetchunk
public native boolean GRsetchunk(int sdsid,
HDFChunkInfo chunk_def,
int flags) throws HDFException
- Parameters:
- sdsid - IN: the SD identifier returned by SDselect
- c_info - IN: HDFChunkInfo, the chunking info
- flags - IN: the type of chunking
NOTE:The chunking algorithm-specific information is
passed in an appropriate sub-class of HDFChunkInfo.
GRsetchunkcache
public native int GRsetchunkcache(int sdsid,
int maxcache,
int flags) throws HDFException
GRsetcompress
public native boolean GRsetcompress(int ri_id,
int comp_type,
HDFCompInfo c_info) throws HDFException
- Parameters:
- ri_id - IN: the GR identifier returned by GRstart
- comp_type - IN: the type of compression
- c_info - IN: HDFCompInfo, the compression info
NOTE:The compression algorithm specific information is
passed in an appropriate sub-class of HDFCompInfo.
GRsetexternalfile
public native boolean GRsetexternalfile(int ri_id,
String filename,
int offset) throws HDFException
GRwriteimage
public native boolean GRwriteimage(int grid,
int start[],
int stride[],
int edge[],
byte data[])
- Parameters:
- grid - IN: the GR interface id, returned by GRstart
- start - IN: int[], start
- stride - IN: int[], stride
- count - IN: int[], count
- data - IN: byte[], data to be written
NOTE: to write from a Java 2D array use the alternative
routine below.
GRwriteimage
public boolean GRwriteimage(int grid,
int start[],
int stride[],
int edge[],
Object theData) throws HDFException
- Parameters:
- grid - IN: the GR interface id, returned by GRstart
- start - IN: int[], start
- stride - IN: int[], stride
- count - IN: int[], count
- theData - IN: Object, a Java array of appropriate
type, dimensions, and size.
Note: converts the Java array to a contiguous
block of bytes appropriate for C, and then writes the bytes.
GRwritelut
public native boolean GRwritelut(int pal_id,
int ncomp,
int data_type,
int interlace,
int num_entries,
byte pal_data[]) throws HDFException
- Parameters:
- pal_id - IN: the palette identifier returned by GRgetlutid
- ncomp - IN: int, number of components
- data_type - IN: int, number type
- interlace - IN: int, interlace
- num_entries - IN: int, number of entries
- data - IN: byte[], palette data to be written--as bytes
NOTE: to write from a Java array of numbers use
the alternative routine below.
GRwritelut
public boolean GRwritelut(int pal_id,
int ncomp,
int data_type,
int interlace,
int num_entries,
Object theData) throws HDFException
- Parameters:
- pal_id - IN: the palette identifier returned by GRgetlutid
- ncomp - IN: int, number of components
- data_type - IN: int, number type
- interlace - IN: int, interlace
- num_entries - IN: int, number of entries
- data - IN: Object, palette data to be written, any
number type.
Note: converts the Java array to a contiguous
block of bytes appropriate for C, and then writes the bytes.
HDFclose
public native boolean HDFclose(int file_id) throws HDFException
HDFopen
public native int HDFopen(String filename,
int access,
short n_dds) throws HDFException
HEvalue
public native short HEvalue(int level) throws HDFException
HEstring
public native String HEstring(int error_code) throws HDFException
HXsetcreatedir
public native boolean HXsetcreatedir(String dir) throws HDFException
HXsetdir
public native boolean HXsetdir(String dir) throws HDFException
SDstart
public native int SDstart(String filename,
int accessmode) throws HDFException
SDend
public native boolean SDend(int sdid) throws HDFException
SDfileinfo
public native boolean SDfileinfo(int sdid,
int argv[]) throws HDFException
- Parameters:
- sdid - IN: the SD interface id, returned by SDstart
- argv - OUT: int[2],
Number of datasets in the file,
Number of global attributes in the file
- Returns:
- the file info: argv[0] = n_datasets, argv[1] = n_file_attrs
SDselect
public native int SDselect(int sdid,
int index) throws HDFException
SDnametoindex
public native int SDnametoindex(int sdid,
String name) throws HDFException
SDgetinfo
public native boolean SDgetinfo(int sdsid,
String name[],
int dimsizes[],
int argv[]) throws HDFException
- Parameters:
- sdsid - IN: the SD interface id, returned by SDselect
- name - OUT: String[1], the name of the dataset
- args - 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 dataset
- args - OUT: int[(rank)], sizes of dimensions
- Returns:
- the file info: name[0] = gr_name, args[0] = rank,
args[1] = data_type, args[2] = nattrs, dim_sizes[] = dimensions
NOTE: the parameters for the Java interface are not in
the same order as the C interface.
SDreaddata
public native boolean SDreaddata(int sdsid,
int start[],
int stride[],
int count[],
byte data[]) throws HDFException
- Parameters:
- sdsid - IN: the SD interface id, returned by SDselect
- start - IN: int[], start
- stride - IN: int[], stride
- count - IN: int[], count
- data - OUT: byte[], data
- Returns:
- the the data in the form of a continous array of
bytes.
NOTE: to read into a Java array use the alternative
routine below.
SDreaddata
public boolean SDreaddata(int sdsid,
int start[],
int stride[],
int count[],
Object theData) throws HDFException
- Parameters:
- sdsid - IN: the SD interface id, returned by SDselect
- start - IN: int[], start
- stride - IN: int[], stride
- count - IN: int[], count
- theData - OUT: Object, a Java array of appropriate
type, dimensions, and size.
- Returns:
- the the data in the Java array.
Note: reads the data as bytes and converts to
the Java array.
SDendaccess
public native boolean SDendaccess(int sdsid) throws HDFException
SDgetdimid
public native int SDgetdimid(int sdsid,
int index) throws HDFException
SDdiminfo
public native boolean SDdiminfo(int dimid,
String name[],
int argv[]) throws HDFException
- Parameters:
- sdsid - IN: the dimension id, returned by SDgetdimid
- name - OUT: String[1], the dimension name
- argv - OUT: int[3], size of the name string,
number type of data in the array, # attributes for the dimension
- Returns:
- name[0] = name, argv[0] = count, argv[1] = data_type,
argv[2] = nattr
SDidtoref
public native int SDidtoref(int sdsid) throws HDFException
SDreftoindex
public native int SDreftoindex(int sdid,
int ref) throws HDFException
SDattrinfo
public native boolean SDattrinfo(int id,
int index,
String name[],
int argv[]) throws HDFException
- Parameters:
- id - IN: id of a file, SDS, or dimension
- index - IN: index of the attribute
- name - OUT: String[1], the name of the attribute
- argv - OUT: int[2], number type of the attribute,
number of values in the attribute
- Returns:
- name[0] = attr_name, argv[0] = data_type,
argv[1] = count
SDreadattr
public native boolean SDreadattr(int id,
int index,
byte data[]) throws HDFException
- Parameters:
- id - IN: id of a file, SDS, or dimension
- index - IN: index of the attribute
- data - OUT: byte[], data
- Returns:
- the the data in the form of a continous array of
bytes.
NOTE: to read into a Java array use the alternative
routine below.
SDreadattr
public boolean SDreadattr(int id,
int index,
Object theData) throws HDFException
- Parameters:
- id - IN: id of a file, SDS, or dimension
- index - IN: index of the attribute
- theData - OUT: Object, a Java array of appropriate
type, dimensions, and size.
- Returns:
- the the data in the Java array.
Note: reads the data as bytes and converts to
the Java array.
SDfindattr
public native int SDfindattr(int id,
String name) throws HDFException
SDiscoordvar
public native boolean SDiscoordvar(int sdsid) throws HDFException
SDgetcal
public native boolean SDgetcal(int sdsid,
double argv[],
int NT[]) throws HDFException
- Parameters:
- sdsid - IN: id of the SDS as returned by SDselect
- argv - OUT: double[4], calibration information:
calibration factor
calibration error
offset
offset error
- NT - OUT: int[1], number type of uncalibrated data
- Returns:
- argv[0] = cal, argv[1] = cal_err,
argv[2] = offset, argv[3] = offset_err,
NT[0] = data_type
SDgetdatastrs
public native boolean SDgetdatastrs(int sdsid,
String strings[],
int len) throws HDFException
- Parameters:
- sdsid - IN: id of the SDS as returned by SDselect
- strings - OUT: String[4], data information strings:
label
unit
print format
coordinate system
- len - IN: int, max len of string (not needed by
Java -- the HDFLibrary interface will handle this)
- Returns:
- strings[0] = label, strings[1] = unit,
strings[2] = format, strings[3] = coordsys,
SDgetdimstrs
public native boolean SDgetdimstrs(int dimid,
String argv[],
int len) throws HDFException
- Parameters:
- sdsid - IN: id of the SDS as returned by SDselect
- strings - OUT: String[4], data information strings:
label
unit
print format
- len - IN: int, max len of string (not needed by
Java -- the HDFLibrary interface will handle this)
- Returns:
- strings[0] = label, strings[1] = unit,
strings[2] = format
SDgetdimscale
public native boolean SDgetdimscale(int dimid,
byte data[]) throws HDFException
- Parameters:
- dimid - IN: id of a dimension as returned by SDgetdimid
- data - OUT: byte[], data
- Returns:
- the the data in the form of a continous array of
bytes.
NOTE: to read into a Java array use the alternative
routine below.
SDgetdimscale
public boolean SDgetdimscale(int dimid,
Object theData) throws HDFException
- Parameters:
- dimid - IN: id of a dimension as returned by SDgetdimid
- theData - OUT: Object, a Java array of appropriate
type and size.
- Returns:
- the the data in the Java array.
Note: reads the data as bytes and converts to
the Java array.
SDgetfillvalue
public native boolean SDgetfillvalue(int sdsid,
byte fillValue[]) throws HDFException
- Parameters:
- sdsid - IN: id of the SDS as returned by SDselect
- fillValue - OUT: byte[], data
- Returns:
- the the fill value in the form of a continous array of
bytes.
NOTE: to read into a Java variable use the alternative
routine below.
SDgetfillvalue
public boolean SDgetfillvalue(int sdsid,
Object theFillValue[]) throws HDFException
- Parameters:
- sdsid - IN: id of the SDS as returned by SDselect
- theFillValue - OUT: Object[1], one object of
appropriate type
- Returns:
- the the data in the Java array: theFillValue[0] = fillValue
Note: the routine calls SDgetinfo to determine the
correct type, reads the data as bytes, and converts to the
appropriate Java object.
SDgetrange
public native boolean SDgetrange(int sdsid,
byte max[],
byte min[]) throws HDFException
- Parameters:
- sdsid - IN: id of the SDS as returned by SDselect
- max - OUT: byte[], max value, as bytes
- max - OUT: byte[], max value, as bytes
- Returns:
- the the max and min values in the form of a continous array of
bytes.
NOTE: to read into Java doubles, use the alternative
routine below.
SDgetrange
public boolean SDgetrange(int sdsid,
double maxmin[]) throws HDFException
- Parameters:
- sdsid - IN: id of the SDS as returned by SDselect
- maxmin - OUT: double[2], the max and min values
converted to doubles
- Returns:
- the the data in the Java array: maxmin[0] = max,
maxmin[1] = min
Note: the routine calls SDgetinfo to determine the
correct type, reads the data as bytes, and converts to the
double.
SDcreate
public native int SDcreate(int sd_id,
String name,
int number_type,
int rank,
int dimsizes[]) throws HDFException
SDisrecord
public native boolean SDisrecord(int sdsid) throws HDFException
SDsetattr
public native boolean SDsetattr(int s_id,
String attr_name,
int num_type,
int count,
byte values[]) throws HDFException
SDsetattr
public boolean SDsetattr(int s_id,
String attr_name,
int num_type,
int count,
Object theValues) throws HDFException
SDsetcal
public native boolean SDsetcal(int sds_id,
double cal,
double cal_err,
double offset,
double offset_err,
int number_type) throws HDFException
SDsetdatastrs
public native boolean SDsetdatastrs(int sds_id,
String label,
String unit,
String format,
String coordsys) throws HDFException
SDsetdimname
public native boolean SDsetdimname(int dim_id,
String dim_name) throws HDFException
SDsetdimscale
public native boolean SDsetdimscale(int dim_id,
int count,
int number_type,
byte data[]) throws HDFException
- Parameters:
- dim_id - IN: id of a dimension
- count - IN: number of values
- number_type - IN: number type of the values
- data - IN: byte[], the values, in an array of
bytes.
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.
SDsetdimscale
public boolean SDsetdimscale(int dim_id,
int count,
int number_type,
Object theData) throws HDFException
- Parameters:
- dim_id - IN: id of a dimension
- count - IN: number of values
- number_type - IN: number type of the values
- theData - OUT: Object, a Java array of appropriate
type and size.
Note: converts the Java array to an array of
bytes, and writes the bytes.
SDsetdimstrs
public native boolean SDsetdimstrs(int dim_id,
String label,
String unit,
String format) throws HDFException
SDsetexternalfile
public native boolean SDsetexternalfile(int sds_id,
String filename,
int offset) throws HDFException
SDsetfillvalue
public native boolean SDsetfillvalue(int sds_id,
byte fill_val[]) throws HDFException
- Parameters:
- sds_id - IN: id of a dataset
- fill_bal - IN: byte[], the fill values in an array of
bytes.
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.
SDsetfillvalue
public boolean SDsetfillvalue(int sds_id,
Object the_fill_val) throws HDFException
- Parameters:
- sds_id - IN: id of a dataset
- the_fill_val - IN: Object, a Java object of appropriate
type
Note: converts the Java array to an array of
bytes, and writes the bytes.
SDsetrange
public native boolean SDsetrange(int sdsid,
byte max[],
byte min[]) throws HDFException
- Parameters:
- sds_id - IN: id of a dataset
- max - IN: byte[], the max value in an array of bytes
- min - IN: byte[], the min value in an array of bytes
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.
SDsetrange
public boolean SDsetrange(int sdsid,
Object max,
Object min) throws HDFException
- Parameters:
- sds_id - IN: id of a dataset
- max - IN: Object, a Java object of appropriate type
- min - IN: Object, a Java object of appropriate type
Note: converts the Java array to an array of
bytes, and writes the bytes.
SDwritedata
public native boolean SDwritedata(int sdsid,
int start[],
int stride[],
int count[],
byte data[]) throws HDFException
- Parameters:
- sdsid - IN: the SD interface id, returned by SDselect
- start - IN: int[], start
- stride - IN: int[], stride
- count - IN: int[], count
- data - IN: byte[], data in an array of bytes
NOTE: to write from a Java array use the alternative
routine below.
SDwritedata
public boolean SDwritedata(int sdsid,
int start[],
int stride[],
int count[],
Object theData) throws HDFException
- Parameters:
- sdsid - IN: the SD interface id, returned by SDselect
- start - IN: int[], start
- stride - IN: int[], stride
- count - IN: int[], count
- theData - IN: Object, a Java array of appropriate
type, dimensions, and size.
Note: converts to the Java array to a contiguous
array of bytes and then writes to the file.
SDsetnbitdataset
public native boolean SDsetnbitdataset(int id,
int start_bit,
int bit_len,
int sign_ext,
int fill_one) throws HDFException
SDsetcompress
public native boolean SDsetcompress(int id,
int type,
HDFCompInfo cinfo) throws HDFException
- Parameters:
- id - IN: the SD identifier returned by SDselect
- comp_type - IN: the type of compression
- c_info - IN: HDFCompInfo, the compression info
NOTE:The compression algorithm specific information is
passed in an appropriate sub-class of HDFCompInfo.
SDsetaccesstype
public native boolean SDsetaccesstype(int id,
int accesstype) throws HDFException
SDsetblocksize
public native boolean SDsetblocksize(int sdsid,
int block_size) throws HDFException
SDsetfillmode
public boolean SDsetfillmode(int sdsid,
boolean fill_enable) throws HDFException
- Parameters:
- sdsid: - IN: the SD id
- fill_enable: - IN: boolean, true calls library with
SD_FILL, false calls library with SD_NOFILL
SDsetfillmode
public native boolean SDsetfillmode(int sdsid,
int fillmode) throws HDFException
SDsetdimval_comp
public native boolean SDsetdimval_comp(int dimid,
int comp_mode) throws HDFException
SDisdimval_bwcomp
public native boolean SDisdimval_bwcomp(int dimid) throws HDFException
SDsetchunk
public native boolean SDsetchunk(int sdsid,
HDFChunkInfo chunk_def,
int flags) throws HDFException
- Parameters:
- sdsid - IN: the SD identifier returned by SDselect
- c_info - IN: HDFChunkInfo, the chunking info
- flags - IN: the type of chunking
NOTE:The chunking algorithm-specific information is
passed in an appropriate sub-class of HDFChunkInfo.
SDgetchunkinfo
public native boolean SDgetchunkinfo(int sdsid,
HDFChunkInfo chunk_def,
int clflags[]) throws HDFException
- Parameters:
- sdsid - IN: the SD identifier returned by SDselect
- c_info - OUT: HDFChunkInfo, the chunking info
- flags - OUT: int[1], the type of chunking
- Returns:
- c_info contains information about the chunking method,
flags[0] == the chunking flags
NOTE:The chunking algorithm-specific information is
passed in an appropriate sub-class of HDFChunkInfo.
SDreadchunk
public native boolean SDreadchunk(int sdsid,
int origin[],
byte theData[]) throws HDFException
- Parameters:
- sdsid - IN: the SD interface id, returned by SDselect
- origin - IN: int[], origin
- data - OUT: byte[], the data in an array of bytes
NOTE: to read into a Java array use the alternative
routine below.
SDreadchunk
public boolean SDreadchunk(int sdsid,
int origin[],
Object theData) throws HDFException
- Parameters:
- sdsid - IN: the SD interface id, returned by SDselect
- origin - IN: int[], origin
- theData - IN: Object, a Java array of appropriate
type, dimensions, and size.
Note: reads the data as a contiguous
array of bytes and then converts it to an appropriate Java object.
SDsetchunkcache
public native int SDsetchunkcache(int sdsid,
int maxcache,
int flags) throws HDFException
SDwritechunk
public native boolean SDwritechunk(int sdsid,
int origin[],
byte data[]) throws HDFException
- Parameters:
- sdsid - IN: the SD interface id, returned by SDselect
- origin - IN: int[], origin
- data - IN: byte[], data to be written, in an array of bytes
NOTE: to write from a Java array use the alternative
routine below.
SDwritechunk
public boolean SDwritechunk(int sdsid,
int origin[],
Object theData) throws HDFException
- Parameters:
- sdsid - IN: the SD interface id, returned by SDselect
- origin - IN: int[], origin
- theData - IN: Object, a Java array of appropriate
type, dimensions, and size.
Note: converts to the Java array to a contiguous
array of bytes and then writes to the file.
VFfieldesize
public native int VFfieldesize(int vdata_id,
int field_index) throws HDFException
VFfieldisize
public native int VFfieldisize(int vdata_id,
int field_index) throws HDFException
VFfieldname
public native String VFfieldname(int vdata_id,
int field_index) throws HDFException
VFfieldorder
public native int VFfieldorder(int vdata_id,
int field_index) throws HDFException
VFfieldtype
public native int VFfieldtype(int vdata_id,
int field_index) throws HDFException
VFnfields
public native int VFnfields(int vkey) throws HDFException
VHmakegroup
public native int VHmakegroup(int file_id,
int tag_array[],
int ref_array[],
int n_objects,
String vgroup_name,
String vgroup_class) throws HDFException
VHstoredata
public native int VHstoredata(int file_id,
String fieldname,
byte buf[],
int n_records,
int data_type,
String vdata_name,
String vdata_class) throws HDFException
- Parameters:
- file_id - IN: the SD interface id, returned by SDselect
- fieldname - IN: String, the name of the field to be filled
- buf - IN: byte[], data to be written, in an array of bytes
- n_records - IN: int, the number of records being written
- data_type - IN: int, the number type of the data
- vdata_name - IN: String, the name of the Vdata
- vdata_class - IN: String, the class of the Vdata
NOTE: to write from a Java array use the alternative
routine below.
VHstoredata
public int VHstoredata(int file_id,
String fieldname,
Object thebuf,
int n_records,
int data_type,
String vdata_name,
String vdata_class) throws HDFException
- Parameters:
- file_id - IN: the SD interface id, returned by SDselect
- fieldname - IN: String, the name of the field to be filled
- buf - IN: Object, data to be written, in a Java array
of appropriate type and size
- n_records - IN: int, the number of records being written
- data_type - IN: int, the number type of the data
- vdata_name - IN: String, the name of the Vdata
- vdata_class - IN: String, the class of the Vdata
Note: converts to the Java array to a contiguous
array of bytes and then writes to the file.
VHstoredatam
public native int VHstoredatam(int file_id,
String fieldname,
byte buf[],
int n_records,
int data_type,
String vdata_name,
String vdata_class,
int order) throws HDFException
- Parameters:
- file_id - IN: the SD interface id, returned by SDselect
- fieldname - IN: String, the name of the field to be filled
- buf - IN: byte[], data to be written, in an array of bytes
- n_records - IN: int, the number of records being written
- data_type - IN: int, the number type of the data
- vdata_name - IN: String, the name of the Vdata
- vdata_class - IN: String, the class of the Vdata
- order - IN: int, the number of components per field
NOTE: to write from a Java array use the alternative
routine below.
VHstoredatam
public int VHstoredatam(int file_id,
String fieldname,
Object buf,
int n_records,
int data_type,
String vdata_name,
String vdata_class,
int order) throws HDFException
- Parameters:
- file_id - IN: the SD interface id, returned by SDselect
- fieldname - IN: String, the name of the field to be filled
- buf - IN: Object, data to be written, in a Java array
of appropriate type, dimension, and size
- n_records - IN: int, the number of records being written
- data_type - IN: int, the number type of the data
- vdata_name - IN: String, the name of the Vdata
- vdata_class - IN: String, the class of the Vdata
- order - IN: int, the number of components per field
Note: converts to the Java array to a contiguous
array of bytes and then writes to the file.
VQueryref
public native int VQueryref(int vkey) throws HDFException
VQuerytag
public native int VQuerytag(int vkey) throws HDFException
VSQuerycount
public native boolean VSQuerycount(int vdata_id,
int n_records[]) throws HDFException
- Parameters:
- vdata_id, - IN, vdata id as returned by VSattach
- n_records, - OUT, int[1], the number of records in the vdata
- Returns:
- n_records[0] == the number of records
VSQueryfields
public native boolean VSQueryfields(int vdata_id,
String fields[]) throws HDFException
- Parameters:
- vdata_id, - IN, vdata id as returned by VSattach
- fields, - OUT, String[1], the names of the fields
- Returns:
- fields[0] == a comma delimited string with the names
of the fields.
VSQueryinterlace
public native boolean VSQueryinterlace(int vdata_id,
int interlace[]) throws HDFException
- Parameters:
- vdata_id, - IN, vdata id as returned by VSattach
- interlace, - OUT, int[1], the interlace mode,
- Returns:
- interlace[0] == the number of records,
HDFConstants.FULL_INTERLACE or HDFConstants.NO_INTERLACE
VSQueryname
public native boolean VSQueryname(int vdata_id,
String vdata_name[]) throws HDFException
- Parameters:
- vdata_id, - IN, vdata id as returned by VSattach
- vdata_name, - OUT, String[1], the name of the vdata
- Returns:
- vdata_name[0] == the name
VSQueryref
public native int VSQueryref(int vdata_id) throws HDFException
VSQuerytag
public native int VSQuerytag(int vdata_id) throws HDFException
VSQueryvsize
public native boolean VSQueryvsize(int vdata_id,
int vdata_size[]) throws HDFException
- Parameters:
- vdata_id, - IN, vdata id as returned by VSattach
- vdata_size, - OUT, int[1], the size of the vdata
- Returns:
- vdata_size[0] == Native size, in bytes, of a record in the vdata
VSattach
public native int VSattach(int fid,
int vdata_ref,
String access) throws HDFException
VSdetach
public native void VSdetach(int vdata_id) throws HDFException
VSgetid
public native int VSgetid(int file_id,
int vdata_ref) throws HDFException
VSgetclass
public native void VSgetclass(int vdata_id,
String hdfclassname[]) throws HDFException
- Parameters:
- vdata_id, - IN, vdata id as returned by VSattach
- hdfclassname, - OUT, String[1], the class name of the vdata
- Returns:
- vdata_class[0] == the class name
VSgetname
public native void VSgetname(int vdata_id,
String hdfname[]) throws HDFException
- Parameters:
- vdata_id, - IN, vdata id as returned by VSattach
- hdfname, - OUT, String[1], the name of the vdata
- Returns:
- hdfname[0] == the name
VSelts
public native int VSelts(int vdata_id) throws HDFException
VSfdefine
public native boolean VSfdefine(int vdata_id,
String fieldname,
int numbertype,
int order) throws HDFException
VSfexist
public native boolean VSfexist(int vdata_id,
String fields) throws HDFException
VSfind
public native int VSfind(int file_id,
String vdataname) throws HDFException
VSgetfields
public native int VSgetfields(int vdata_id,
String fieldname[]) throws HDFException
- Parameters:
- vdata_id, - IN, vdata id as returned by VSattach
- fieldname, - OUT, String[1], the names of the fields
- Returns:
- fieldname[0] == a comma delimited string with the names
of the fields.
VSgetinterlace
public native int VSgetinterlace(int vdata_id) throws HDFException
VSinquire
public native boolean VSinquire(int vdata_id,
int iargs[],
String sargs[]) throws HDFException
- Parameters:
- vdata_id, - IN, vdata id as returned by VSattach
- iargs, - OUT, int[3], n_records, interlace, vdata_size
- sargs, - OUT, String[2], names the dataset, fields
- Returns:
- iargs[0] = n_records, iargs[1] = interlace, iargs[2] = vdata_size,
sargs[0] = vdata_name, sargs[1] = comma delimited list of fields
NOTE: the parameters for the Java interface are not in
the same order as the C interface.
VSlone
public native int VSlone(int fid,
int ref_array[],
int buffersize) throws HDFException
- Parameters:
- fid, - IN, File identifier returned by Hopen
- ref_array, - OUT, int[?], the refs
- buffersize, - IN, int, the max number of refs to
return.
- Returns:
- ref_array contains refs. The Java API ignores the buffersize
argument, returns as many as possible.
VSread
public native int VSread(int vdata_id,
byte databuf[],
int nrecord,
int interlace) throws HDFException
- Parameters:
- vdata_id - IN: the Vdata id
- data_buf - OUT: byte[], the data in an array of bytes
- nrecord - IN: int, number of records
- interlace - IN: int, interlace
NOTE: to read into a Java array use the alternative
routine below.
VSread
public int VSread(int vdata_id,
Object theData,
int nrecord,
int interlace) throws HDFException
- Parameters:
- vdata_id - IN: the Vdata id
- theData - OUT: Object, a Java array of appropriate
type, dimensions, and size.
- nrecord - IN: int, number of records
- interlace - IN: int, interlace
Note: reads the data as a contiguous
array of bytes and then converts it to an appropriate Java object.
VSseek
public native int VSseek(int vdata_id,
int record) throws HDFException
VSsetfields
public native boolean VSsetfields(int vdata_id,
String fields) throws HDFException
VSsetinterlace
public native boolean VSsetinterlace(int vdata_id,
int interlace) throws HDFException
VSsizeof
public native int VSsizeof(int vdata_id,
String fields) throws HDFException
VSappendable
public native boolean VSappendable(int vkey,
int block_size) throws HDFException
VSfindclass
public native int VSfindclass(int file_id,
String vgclass) throws HDFException
VSgetversion
public native int VSgetversion(int vkey) throws HDFException
VSsetclass
public native void VSsetclass(int vdata_id,
String vdata_class) throws HDFException
VSsetexternalfile
public native boolean VSsetexternalfile(int vkey,
String filename,
int offset) throws HDFException
VSsetname
public native void VSsetname(int vdata_id,
String vdata_name) throws HDFException
VSwrite
public native int VSwrite(int vdata_id,
byte databuf[],
int n_records,
int interlace) throws HDFException
- Parameters:
- vdata_id - IN: the Vdata id
- data_buf - IN: byte[], the data in an array of bytes
- n_records - IN: int, number of records
- interlace - IN: int, interlace
NOTE: to write a Java array use the alternative
routine below.
VSwrite
public int VSwrite(int vdata_id,
Object databuf,
int n_records,
int interlace) throws HDFException
- Parameters:
- vdata_id - IN: the Vdata id
- databuf - IN: Object, a Java array of appropriate
type, dimensions, and size.
- n_records - IN: int, number of records
- interlace - IN: int, interlace
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
Vstart
public native boolean Vstart(int fid) throws HDFException
Vattach
public native int Vattach(int fid,
int vgroup_ref,
String access) throws HDFException
Vdetach
public native void Vdetach(int vgroup_id) throws HDFException
Vend
public native void Vend(int file_id) throws HDFException
Vgetid
public native int Vgetid(int file_id,
int vgroup_ref) throws HDFException
Vgetclass
public native void Vgetclass(int vgroup_id,
String hdfclassname[]) throws HDFException
- Parameters:
- vgroup_id - IN: the Vgroup id
- hdfclassname - OUT: String[1], the HDF class of
the vgroup.
- Returns:
- hdfclassname[0] == the hdf class.
Vgetname
public native void Vgetname(int vgroup_id,
String hdfname[]) throws HDFException
- Parameters:
- vgroup_id - IN: the Vgroup id
- hdfname - OUT: String[1], the name of
the vgroup.
- Returns:
- hdfname[0] == the name
Visvg
public native boolean Visvg(int vgroup_id,
int vgroup_ref) throws HDFException
Visvs
public native boolean Visvs(int vgroup_id,
int vdata_ref) throws HDFException
Vgettagrefs
public native int Vgettagrefs(int vgroup_id,
int tags[],
int refs[],
int arraysize) throws HDFException
- Parameters:
- vgroup_id - IN: the Vgroup id
- tags - OUT: int[arraysize], the tags
- refs - OUT: int[arraysize], the refs
- arraysize - IN: int, the number of tags/refs to
return
- Returns:
- tags[] = tags for objects 0 - n, refs[] = refs for
objects 0 - n
Vgettagref
public native boolean Vgettagref(int vgroup_id,
int index,
int tagref[]) throws HDFException
- Parameters:
- vgroup_id - IN: the Vgroup id
- index - IN: the index of the object
- tags - OUT: int[1], the tag for the object
- refs - OUT: int[1], the ref for the object
- Returns:
- tags[0] = tag for object #index, refs[0] = ref for
objects #index
Vntagrefs
public native int Vntagrefs(int vgroup_id) throws HDFException
Vinqtagref
public native boolean Vinqtagref(int vgroup_id,
int tag,
int ref) throws HDFException
Vlone
public native int Vlone(int fid,
int ref_array[],
int buffersize) throws HDFException
- Parameters:
- fid - IN: the file identifier returned by Hopen
- ref_array - OUT: int[], the refs for Vdata not part
of Vgroups
- buffersize - IN: the max size of the ref_array
- Returns:
- ref_array[] = refs 0 - ...
Vaddtagref
public native int Vaddtagref(int vgroup_id,
int tag,
int ref) throws HDFException
Vfind
public native int Vfind(int file_id,
String vgroup_name) throws HDFException
Vfindclass
public native int Vfindclass(int file_id,
String vgclassname) throws HDFException
Vflocate
public native int Vflocate(int key,
String vgclassname) throws HDFException
Vgetnext
public native int Vgetnext(int key,
int ref) throws HDFException
Vinquire
public native boolean Vinquire(int vgroup_id,
int n_entries[],
String vgroup_name[]) throws HDFException
- Parameters:
- vgroup_id - IN: the Vgroup id
- n_entries - OUT: int[1], the number of objects in the Vgroup
- vgroup_name - OUT: String[1], the name of the Vgroup
- Returns:
- n_entries[0] = number of entries, vgroup_name[0] = the name
Vinsert
public native int Vinsert(int vgroup_id,
int v_id) throws HDFException
Vnrefs
public native int Vnrefs(int key,
int ref) throws HDFException
Vsetclass
public native boolean Vsetclass(int vgroup_id,
String vgclassname) throws HDFException
Vsetname
public native boolean Vsetname(int vgroup_id,
String vgname) throws HDFException
Vattrinfo
public native boolean Vattrinfo(int id,
int index,
String name[],
int argv[]) throws HDFException
- Parameters:
- id - IN: Vgroup identifier returned by Vattach
- index - IN: the index of the attribute
- name - OUT: String[1], the name of the attribute
- argv - 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,
- Returns:
- name[0] = name, argv[0] = data_type, argv[1] = count,
argv[2] = size
Vfindattr
public native int Vfindattr(int id,
String name) throws HDFException
Vgetattr
public native boolean Vgetattr(int id,
int index,
byte data[]) throws HDFException
- Parameters:
- id - IN: the Vdata id
- index - IN: the index of the attribute
- data - OUT: byte[], the data in an array of bytes
NOTE: to read into a Java array use the alternative
routine below.
- Returns:
- data = the value of the attribute, in an array of bytes
Vgetattr
public boolean Vgetattr(int id,
int index,
Object theData) throws HDFException
- Parameters:
- vdata_id - IN: the Vdata id
- index - IN: the index of the attribute
- theData - OUT: Object, a Java array of appropriate
type, dimensions, and size.
Note: reads the data as a contiguous
array of bytes and then converts it to an appropriate Java object.
- Returns:
- data = the value of the attribute, in an array of Java
objects
Vgetversion
public native int Vgetversion(int id) throws HDFException
Vnattrs
public native int Vnattrs(int id) throws HDFException
Vsetattr
public native boolean Vsetattr(int id,
String attr_name,
int data_type,
int count,
String values) throws HDFException
Vsetattr
public native boolean Vsetattr(int id,
String attr_name,
int data_type,
int count,
byte values[]) throws HDFException
- Parameters:
- id - IN: the Vdata id
- attr_name - IN: String, the name of the attribute
- data_type - IN: int, the number_type of the attribute
- count - IN: the number of values
- data - IN: byte[], the data in an array of bytes
NOTE: to write into a Java array use the alternative
routine below.
Vsetattr
public boolean Vsetattr(int id,
String attr_name,
int data_type,
int count,
Object theData) throws HDFException
- Parameters:
- id - IN: the Vdata id
- attr_name - IN: String, the name of the attribute
- data_type - IN: int, the number_type of the attribute
- count - IN: the number of values
- theData - IN: Object, a Java array of appropriate
type, dimensions, and size.
Note: converts the data to a contiguous
array of bytes and then converts writes it.
VSattrinfo
public native boolean VSattrinfo(int id,
int index,
String name[],
int argv[]) throws HDFException
- Parameters:
- id - IN: the Vdata id
- index - IN: int, the index of the attribute
- name - OUT: String[1], the name of the attribute
- argv - 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,
- Returns:
- name[0] = name, argv[0] = data_type, argv[1] = count,
argv[2] = size
VSfindex
public native int VSfindex(int id,
String name,
int findex[]) throws HDFException
- Parameters:
- id - IN: the Vdata id
- name - IN: the name of the attribute
- findex - IN: int[1], the index of the attribute
- Returns:
- findex[0] = the index
VSfindattr
public native int VSfindattr(int id,
int index,
String name) throws HDFException
VSfnattrs
public native int VSfnattrs(int id,
int fnattrs) throws HDFException
VSgetattr
public native boolean VSgetattr(int id,
int index,
int attr_index,
byte data[]) throws HDFException
- Parameters:
- id - IN: the Vdata id
- index - IN: the index of the vdata
- attr_index - IN: the index of the attribute
- data - OUT: byte[], the data in an array of bytes
NOTE: to read into a Java array use the alternative
routine below.
- Returns:
- data = the value of the attribute, in an array of bytes
VSgetattr
public boolean VSgetattr(int id,
int index,
int attr_index,
Object theData) throws HDFException
- Parameters:
- vdata_id - IN: the Vdata id
- index - IN: the index of the vdata
- attr_index - IN: the index of the attribute
- theData - OUT: Object, a Java array of appropriate
type, dimensions, and size.
Note: reads the data as a contiguous
array of bytes and then converts it to an appropriate Java object.
- Returns:
- data = the value of the attribute, in an array of Java
objects
VSisattr
public native boolean VSisattr(int id) throws HDFException
VSnattrs
public native int VSnattrs(int id) throws HDFException
VSsetattr
public native boolean VSsetattr(int id,
int index,
String attr_name,
int data_type,
int count,
String values) throws HDFException
- Parameters:
- id - IN: the Vdata id
- index - IN: the index of the vdata
- attr_name - IN: String, the name of the attribute
- data_type - IN: int, the number_type of the attribute
- count - IN: the number of values
- value - IN: Strin, the data in an String
NOTE: to write from a Java array use the alternative
routine below.
VSsetattr
public native boolean VSsetattr(int id,
int index,
String attr_name,
int data_type,
int count,
byte values[]) throws HDFException
- Parameters:
- id - IN: the Vdata id
- index - IN: the index of the vdata
- attr_name - IN: String, the name of the attribute
- data_type - IN: int, the number_type of the attribute
- count - IN: the number of values
- values - IN: byte[], the data in an array of bytes
NOTE: to write into a Java array use the alternative
routine below.
VSsetattr
public boolean VSsetattr(int id,
int index,
String attr_name,
int data_type,
int count,
Object theData) throws HDFException
- Parameters:
- id - IN: the Vdata id
- index - IN: the index of the vdata
- attr_name - IN: String, the name of the attribute
- data_type - IN: int, the number_type of the attribute
- count - IN: the number of values
- theData - IN: Object, a Java array of appropriate
type, dimensions, and size.
Note: converts the data to a contiguous
array of bytes and then converts writes it.
DF24getdims
public native boolean DF24getdims(String fileName,
int argv[]) throws HDFException
DF24reqil
public native boolean DF24reqil(int il) throws HDFException
DF24getimage
public native boolean DF24getimage(String fileName,
byte imagedata[],
int width,
int height) throws HDFException
- Parameters:
- filename - IN: String, the file
- imagedata - OUT: byte[], the image, in an array of
bytes
- width - IN: int, the width of the image
- height - IN: int, the height of the image
NOTE: to read into a Java array use the alternative
routine below.
- Returns:
- data = the image in an array of bytes
DF24getimage
public boolean DF24getimage(String fileName,
Object theImagedata,
int width,
int height) throws HDFException
- Parameters:
- filename - IN: String, the file
- theImagedata - OUT: Object, the image, in a java
array of appropriate size and type
- width - IN: int, the width of the image
- height - IN: int, the height of the image
Note: reads the data as a contiguous
array of bytes and then converts it to an appropriate Java object.
- Returns:
- data = the value of the attribute, in an array of Java
objects
DF24lastref
public native short DF24lastref() throws HDFException
DF24restart
public native boolean DF24restart() throws HDFException
DF24readref
public native boolean DF24readref(String filename,
int ref) throws HDFException
DF24nimages
public native int DF24nimages(String fileName) throws HDFException
DF24addimage
public native boolean DF24addimage(String filename,
byte image[],
int width,
int height) throws HDFException
- Parameters:
- filename - IN: String, the file
- image - IN: byte[], the image, in an array of
bytes
- width - IN: int, the width of the image
- height - IN: int, the height of the image
NOTE: to write from a Java array use the alternative
routine below.
DF24addimage
public boolean DF24addimage(String filename,
Object theImage,
int width,
int height) throws HDFException
- Parameters:
- filename - IN: String, the file
- theImage - IN: Object, the image, in a java
array of appropriate size and type
- width - IN: int, the width of the image
- height - IN: int, the height of the image
Note: converts the data into a contiguous
array of bytes and then writes it to the file
DF24putimage
public native boolean DF24putimage(String filename,
byte image[],
int width,
int height) throws HDFException
- Parameters:
- filename - IN: String, the file
- image - IN: byte[], the image, in an array of
bytes
- width - IN: int, the width of the image
- height - IN: int, the height of the image
NOTE: to write from a Java array use the alternative
routine below.
DF24putimage
public boolean DF24putimage(String filename,
Object theImage,
int width,
int height) throws HDFException
- Parameters:
- filename - IN: String, the file
- theImage - IN: Object, the image, in a java
array of appropriate size and type
- width - IN: int, the width of the image
- height - IN: int, the height of the image
Note: converts the data into a contiguous
array of bytes and then writes it to the file
DF24setcompress
public native boolean DF24setcompress(int type,
HDFCompInfo cinfo) throws HDFException
- Parameters:
- type - IN: int, the type of compression
- cinfo - IN: HDFCompInfo, the compression parameters
DF24setdims
public native boolean DF24setdims(int width,
int height) throws HDFException
DF24setil
public native boolean DF24setil(int il) throws HDFException
DFR8getdims
public native boolean DFR8getdims(String fileName,
int argv[],
boolean haspalette[]) throws HDFException
DFR8getimage
public native boolean DFR8getimage(String fileName,
byte imagedata[],
int width,
int height,
byte palette[]) throws HDFException
- Parameters:
- filename - IN: String, the file
- imagedata - OUT: byte[], the image, in an array of
bytes
- width - IN: int, the width of the image
- height - IN: int, the height of the image
- palette - OUT: byte[], the color look up table
NOTE: to read into a Java array use the alternative
routine below.
- Returns:
- data = imagedata: the image in an array of bytes,
palette: the look up table, in an array of bytes
DFR8getimage
public boolean DFR8getimage(String fileName,
Object theImagedata,
int width,
int height,
byte palette[]) throws HDFException
- Parameters:
- filename - IN: String, the file
- theImagedata - OUT: Object, the image, in a java
array of appropriate size and type
- width - IN: int, the width of the image
- height - IN: int, the height of the image
- palette - OUT: byte[], the color look up table
Note: reads the data as a contiguous
array of bytes and then converts it to an appropriate Java object.
- Returns:
- data = theImagedata: the value of the attribute,
in an array of Java objects
palette: the look up table, in an array of bytes
DFR8lastref
public native short DFR8lastref() throws HDFException
DFR8restart
public native boolean DFR8restart() throws HDFException
DFR8readref
public native boolean DFR8readref(String filename,
int ref) throws HDFException
DFR8nimages
public native int DFR8nimages(String fileName) throws HDFException
DFR8addimage
public native boolean DFR8addimage(String filename,
byte image[],
int width,
int height,
short compress) throws HDFException
- Parameters:
- filename - IN: String, the file
- image - IN: byte[], the image, in an array of
bytes
- width - IN: int, the width of the image
- height - IN: int, the height of the image
- compress - IN: short, the type of compression
NOTE: to write from a Java array use the alternative
routine below.
DFR8addimage
public boolean DFR8addimage(String filename,
Object theImage,
int width,
int height,
short compress) throws HDFException
- Parameters:
- filename - IN: String, the file
- theImage - IN: Object, the image, in a java
array of appropriate size and type
- width - IN: int, the width of the image
- height - IN: int, the height of the image
- compress - IN: short, the type of compression
Note: converts the data into a contiguous
array of bytes and then writes it to the file
DFR8putimage
public native boolean DFR8putimage(String filename,
byte image[],
int width,
int height,
short compress) throws HDFException
- Parameters:
- filename - IN: String, the file
- image - IN: byte[], the image, in an array of
bytes
- width - IN: int, the width of the image
- height - IN: int, the height of the image
- compress - IN: short, the type of compression
NOTE: to write from a Java array use the alternative
routine below.
DFR8putimage
public boolean DFR8putimage(String filename,
Object theImage,
int width,
int height,
short compress) throws HDFException
- Parameters:
- filename - IN: String, the file
- theImage - IN: Object, the image, in a java
array of appropriate size and type
- width - IN: int, the width of the image
- height - IN: int, the height of the image
- compress - IN: short, the type of compression
Note: converts the data into a contiguous
array of bytes and then writes it to the file
DFR8setcompress
public native boolean DFR8setcompress(int type,
HDFCompInfo cinfo) throws HDFException
- Parameters:
- type - IN: int, the type of compression
- cinfo - IN: HDFCompInfo, the compression parameters
DFR8getpalref
public native boolean DFR8getpalref(short palref[]) throws HDFException
- Parameters:
- palref - OUT: short[1], the HDF ref of the palette
- Returns:
- palref[0] = the ref of the palette
DFR8setpalette
public native boolean DFR8setpalette(byte palette[]) throws HDFException
DFR8writeref
public native boolean DFR8writeref(String filename,
short ref) throws HDFException
All Packages Class Hierarchy This Package Previous Next Index