Class HDFLibrary
- All Implemented Interfaces:
Serializable
- Direct Known Subclasses:
HDFDeprecated
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.
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 | 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: ncsa.hdf.hdflib.HDFChunkInfo, and
- See Also:
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic int
ANannlen
(int ann_id) static int
ANannlist
(int an_id, int anntype, int tag, int ref, int[] ann_list) static short
ANatype2tag
(int antag) static int
ANcreate
(int an_id, short tag, short ref, int type) static int
ANcreatef
(int an_id, int type) static boolean
ANend
(int an_id) static boolean
ANendaccess
(int an_id) static boolean
ANfileinfo
(int an_id, int[] info) static int
ANget_tagref
(int an_id, int index, int type, short[] tagref) static boolean
ANid2tagref
(int an_id, short[] tagref) static int
ANnumann
(int an_id, int anntype, short tag, short ref) static boolean
static int
ANselect
(int an_id, int index, int anntype) static int
ANstart
(int fid) static int
ANtag2atype
(short anttype) static int
ANtagref2id
(int an_id, short tag, short ref) static boolean
ANwriteann
(int ann_id, String label, int ann_length) static boolean
DF24addimage
(String filename, byte[] image, int width, int height) static boolean
DF24addimage
(String filename, Object theImage, int width, int height) static boolean
DF24getdims
(String fileName, int[] argv) static boolean
DF24getimage
(String fileName, byte[] imagedata, int width, int height) static boolean
DF24getimage
(String fileName, Object theImagedata, int width, int height) static short
static int
DF24nimages
(String fileName) static boolean
DF24putimage
(String filename, byte[] image, int width, int height) static boolean
DF24putimage
(String filename, Object theImage, int width, int height) static boolean
DF24readref
(String filename, int ref) static boolean
DF24reqil
(int il) static boolean
static boolean
DF24setcompress
(int type, HDFCompInfo cinfo) static boolean
DF24setdims
(int width, int height) static boolean
DF24setil
(int il) static int
DFKNTsize
(int numbertype) static boolean
static boolean
static short
static int
static boolean
static boolean
static boolean
DFPreadref
(String filename, short ref) static short
static boolean
DFPwriteref
(String filename, short ref) static boolean
DFR8addimage
(String filename, byte[] image, int width, int height, short compress) static boolean
DFR8addimage
(String filename, Object theImage, int width, int height, short compress) static boolean
DFR8getdims
(String fileName, int[] argv, boolean[] haspalette) static boolean
DFR8getimage
(String fileName, byte[] imagedata, int width, int height, byte[] palette) static boolean
DFR8getimage
(String fileName, Object theImagedata, int width, int height, byte[] palette) static boolean
DFR8getpalref
(short[] palref) static short
static int
DFR8nimages
(String fileName) static boolean
DFR8putimage
(String filename, byte[] image, int width, int height, short compress) static boolean
DFR8putimage
(String filename, Object theImage, int width, int height, short compress) static boolean
DFR8readref
(String filename, int ref) static boolean
static boolean
DFR8setcompress
(int type, HDFCompInfo cinfo) static boolean
DFR8setpalette
(byte[] palette) static boolean
DFR8writeref
(String filename, short ref) static final String
Deprecated.static boolean
GRattrinfo
(int id, int index, String[] name, int[] argv) static int
static boolean
GRend
(int grid) static boolean
GRendaccess
(int riid) static boolean
GRfileinfo
(int grid, int[] args) static int
GRfindattr
(int id, String name) static boolean
GRgetattr
(int id, int index, byte[] data) static boolean
static boolean
GRgetchunkinfo
(int sdsid, HDFChunkInfo chunk_def, int[] flag) static boolean
GRgetcompress
(int ri_id, HDFCompInfo c_info) static boolean
GRgetiminfo
(int grid, String[] gr_name, int[] args, int[] dim_sizes) static int
GRgetlutid
(int rrid, int index) static boolean
GRgetlutinfo
(int lutid, int[] args) static int
GRgetnluts
(int rrid) static short
GRidtoref
(int riid) static short
GRluttoref
(int pal_id) static int
GRnametoindex
(int grid, String name) static boolean
GRreadchunk
(int sdsid, int[] origin, byte[] theData) static boolean
GRreadchunk
(int grid, int[] origin, Object theData) static boolean
GRreadimage
(int grid, int[] start, int[] stride, int[] count, byte[] data) static boolean
GRreadimage
(int grid, int[] start, int[] stride, int[] count, Object theData) static boolean
GRreadlut
(int lutid, byte[] data) static boolean
static int
GRreftoindex
(int grid, short ref) static boolean
GRreqimageil
(int rrid, int interlace) static boolean
GRreqlutil
(int riid, int interlace) static int
GRselect
(int grid, int index) static boolean
static boolean
static boolean
static boolean
GRsetchunk
(int sdsid, HDFChunkInfo chunk_def, int flags) static int
GRsetchunkcache
(int sdsid, int maxcache, int flags) static boolean
GRsetcompress
(int ri_id, int comp_type, HDFCompInfo c_info) static boolean
GRsetexternalfile
(int ri_id, String filename, int offset) static int
GRstart
(int fid) static boolean
GRwriteimage
(int grid, int[] start, int[] stride, int[] edge, byte[] data) static boolean
GRwriteimage
(int grid, int[] start, int[] stride, int[] edge, Object theData) static boolean
GRwritelut
(int pal_id, int ncomp, int data_type, int interlace, int num_entries, byte[] pal_data) static boolean
GRwritelut
(int pal_id, int ncomp, int data_type, int interlace, int num_entries, Object theData) static boolean
Hcache
(int file_id, int cache_switch) static int
HCget_config_info
(int coder_type) New API for hdf-42r1static boolean
Hclose
(int fid) static int
static boolean
HDFclose
(int file_id) static int
static String
HDgetNTdesc
(int nt) static String
HEstring
(int error_code) static short
HEvalue
(int level) static boolean
Hgetfileversion
(int file_id, int[] vers, 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, String[] string) static boolean
static int
Hnumber
(int fid) static int
static int
static boolean
Hsetaccesstype
(int h_id, int access_type) static boolean
Hsync
(int file_id) static boolean
HXsetcreatedir
(String dir) static boolean
static void
static boolean
SDattrinfo
(int id, int index, String[] name, int[] argv) static boolean
SDcheckempty
(int sdsid, int[] emptySDS) static int
static boolean
static boolean
SDend
(int sdid) static boolean
SDendaccess
(int sdsid) static boolean
SDfileinfo
(int sdid, int[] argv) static int
SDfindattr
(int id, String name) static boolean
SDgetcal
(int sdsid, double[] argv, int[] NT) static boolean
SDgetchunkinfo
(int sdsid, HDFChunkInfo chunk_def, int[] clflags) static boolean
SDgetcompinfo
(int id, HDFCompInfo cinfo) static boolean
SDgetcompress
(int id, HDFCompInfo cinfo) Deprecated.static boolean
SDgetdatastrs
(int sdsid, String[] strings, int len) static int
SDgetdimid
(int sdsid, int index) static boolean
SDgetdimscale
(int dimid, byte[] data) static boolean
SDgetdimscale
(int dimid, Object theData) static boolean
SDgetdimstrs
(int dimid, String[] args, int len) static boolean
SDgetfillvalue
(int sdsid, byte[] fillValue) static boolean
SDgetfillvalue
(int sdsid, Object[] theFillValue) static boolean
static boolean
SDgetrange
(int sdsid, byte[] max, byte[] min) static boolean
SDgetrange
(int sdsid, double[] maxmin) static int
SDidtoref
(int sdsid) static boolean
SDiscoordvar
(int sdsid) static boolean
SDisdimval_bwcomp
(int dimid) static boolean
SDisrecord
(int sdsid) static int
SDnametoindex
(int sdid, String name) static boolean
SDreadattr
(int id, int index, byte[] data) static boolean
SDreadattr
(int id, int index, Object theData) static boolean
SDreadchunk
(int sdsid, int[] origin, byte[] theData) static boolean
SDreadchunk
(int sdsid, int[] origin, Object theData) static boolean
SDreaddata
(int sdsid, int[] start, int[] stride, int[] count, byte[] data) static boolean
SDreaddata
(int sdsid, int[] start, int[] stride, int[] count, Object theData) static boolean
SDreaddata_double
(int sdsid, int[] start, int[] stride, int[] count, double[] theData) static boolean
SDreaddata_float
(int sdsid, int[] start, int[] stride, int[] count, float[] theData) static boolean
SDreaddata_int
(int sdsid, int[] start, int[] stride, int[] count, int[] theData) static boolean
SDreaddata_long
(int sdsid, int[] start, int[] stride, int[] count, long[] theData) static boolean
SDreaddata_short
(int sdsid, int[] start, int[] stride, int[] count, short[] theData) static int
SDreftoindex
(int sdid, int ref) static int
SDselect
(int sdid, int index) static boolean
SDsetaccesstype
(int id, int accesstype) static boolean
static boolean
static boolean
SDsetblocksize
(int sdsid, int block_size) static boolean
SDsetcal
(int sds_id, double cal, double cal_err, double offset, double offset_err, int number_type) static boolean
SDsetchunk
(int sdsid, HDFChunkInfo chunk_def, int flags) static int
SDsetchunkcache
(int sdsid, int maxcache, int flags) static boolean
SDsetcompress
(int id, int type, HDFCompInfo cinfo) static boolean
SDsetdatastrs
(int sds_id, String label, String unit, String format, String coordsys) static boolean
SDsetdimname
(int dim_id, String dim_name) static boolean
SDsetdimscale
(int dim_id, int count, int number_type, byte[] data) static boolean
SDsetdimscale
(int dim_id, int count, int number_type, Object theData) static boolean
SDsetdimstrs
(int dim_id, String label, String unit, String format) static boolean
SDsetdimval_comp
(int dimid, int comp_mode) static boolean
SDsetexternalfile
(int sds_id, String filename, int offset) static boolean
SDsetfillmode
(int sdsid, boolean fill_enable) static boolean
SDsetfillmode
(int sdsid, int fillmode) static boolean
SDsetfillvalue
(int sds_id, byte[] fill_val) static boolean
SDsetfillvalue
(int sds_id, Object the_fill_val) static boolean
SDsetnbitdataset
(int id, int start_bit, int bit_len, int sign_ext, int fill_one) static boolean
SDsetrange
(int sdsid, byte[] max, byte[] min) static boolean
SDsetrange
(int sdsid, Object max, Object min) static int
static boolean
SDwritechunk
(int sdsid, int[] origin, byte[] data) static boolean
SDwritechunk
(int sdsid, int[] origin, Object theData) static boolean
SDwritedata
(int sdsid, int[] start, int[] stride, int[] count, byte[] data) static boolean
SDwritedata
(int sdsid, int[] start, int[] stride, int[] count, Object theData) static int
Vaddtagref
(int vgroup_id, int tag, int ref) static int
static boolean
static int
Vdeletetagref
(int vgroup_id, int tag, int ref) static void
Vdetach
(int vgroup_id) static void
Vend
(int file_id) static int
VFfieldesize
(int vdata_id, int field_index) static int
VFfieldisize
(int vdata_id, int field_index) static String
VFfieldname
(int vdata_id, int field_index) static int
VFfieldorder
(int vdata_id, int field_index) static int
VFfieldtype
(int vdata_id, int field_index) static int
static int
static int
Vfindclass
(int file_id, String vgclassname) static int
static int
VFnfields
(int vkey) static boolean
Vgetattr
(int id, int index, byte[] data) static boolean
static void
static int
Vgetid
(int file_id, int vgroup_ref) static void
static int
Vgetnext
(int key, int ref) static boolean
Vgettagref
(int vgroup_id, int index, int[] tagref) static int
Vgettagrefs
(int vgroup_id, int[] tags, int[] refs, int arraysize) static int
Vgetversion
(int id) static int
VHmakegroup
(int file_id, int[] tag_array, int[] ref_array, int n_objects, String vgroup_name, String vgroup_class) static int
VHstoredata
(int file_id, String fieldname, byte[] buf, int n_records, int data_type, String vdata_name, String vdata_class) static int
VHstoredata
(int file_id, String fieldname, Object thebuf, int n_records, int data_type, String vdata_name, String vdata_class) static int
VHstoredatam
(int file_id, String fieldname, byte[] buf, int n_records, int data_type, String vdata_name, String vdata_class, int order) static int
VHstoredatam
(int file_id, String fieldname, Object buf, int n_records, int data_type, String vdata_name, String vdata_class, int order) static boolean
Vinqtagref
(int vgroup_id, int tag, int ref) static boolean
static int
Vinsert
(int vgroup_id, int v_id) static boolean
Visvg
(int vgroup_id, int vgroup_ref) static boolean
Visvs
(int vgroup_id, int vdata_ref) static int
Vlone
(int fid, int[] ref_array, int buffersize) static int
Vnattrs
(int id) static int
Vnrefs
(int key, int ref) static int
Vntagrefs
(int vgroup_id) static int
VQueryref
(int vkey) static int
VQuerytag
(int vkey) static boolean
VSappendable
(int vkey, int block_size) static int
static boolean
VSattrinfo
(int id, int index, int attr_index, String[] name, int[] argv) static void
VSdetach
(int vdata_id) static int
VSelts
(int vdata_id) static boolean
static boolean
static boolean
static boolean
static boolean
static boolean
static boolean
static int
static int
VSfindattr
(int id, int index, String name) static int
VSfindclass
(int file_id, String vgclass) static int
static int
VSfnattrs
(int id, int fnattrs) static boolean
VSgetattr
(int id, int index, int attr_index, byte[] data) static boolean
static void
VSgetclass
(int vdata_id, String[] hdfclassname) static int
VSgetfields
(int vdata_id, String[] fieldname) static int
VSgetid
(int file_id, int vdata_ref) static int
VSgetinterlace
(int vdata_id) static void
static int
VSgetversion
(int vkey) static boolean
VSinquire
(int vdata_id, int[] iargs) static boolean
static boolean
VSisattr
(int id) static int
VSlone
(int fid, int[] ref_array, int buffersize) static int
VSnattrs
(int id) static boolean
VSQuerycount
(int vdata_id, int[] n_records) static boolean
VSQueryfields
(int vdata_id, String[] fields) static boolean
VSQueryinterlace
(int vdata_id, int[] interlace) static boolean
VSQueryname
(int vdata_id, String[] vdata_name) static int
VSQueryref
(int vdata_id) static int
VSQuerytag
(int vdata_id) static boolean
VSQueryvsize
(int vdata_id, int[] vdata_size) static int
VSread
(int vdata_id, byte[] databuf, int nrecord, int interlace) static int
static int
VSseek
(int vdata_id, int record) static boolean
static boolean
static boolean
static int
VSsetblocksize
(int vdata_id, int blocksize) static void
VSsetclass
(int vdata_id, String vdata_class) static boolean
VSsetexternalfile
(int vkey, String filename, int offset) static boolean
VSsetfields
(int vdata_id, String fields) static boolean
VSsetinterlace
(int vdata_id, int interlace) static void
static int
VSsetnumblocks
(int vdata_id, int numblocks) static int
static boolean
Vstart
(int fid) static int
VSwrite
(int vdata_id, byte[] databuf, int n_records, int interlace) static int
-
Field Details
-
HDFPATH_PROPERTY_KEY
- See Also:
-
-
Constructor Details
-
HDFLibrary
public HDFLibrary()
-
-
Method Details
-
loadH4Lib
public static void loadH4Lib() -
getJHIVersion
Deprecated. -
Hopen
- Throws:
HDFException
-
Hopen
- Throws:
HDFException
-
Hclose
- Throws:
HDFException
-
HDdont_atexit
- Throws:
HDFException
-
Hishdf
- Throws:
HDFException
-
Hnumber
- Throws:
HDFException
-
DFKNTsize
- Throws:
HDFException
-
HDgetNTdesc
- Throws:
HDFException
-
Hcache
- Throws:
HDFException
-
Hgetfileversion
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 Hopenvers
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
Hgetlibversion
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
Hsetaccesstype
- Throws:
HDFException
-
Hsync
- Throws:
HDFException
-
ANstart
- Throws:
HDFException
-
ANend
- Throws:
HDFException
-
ANendaccess
- Throws:
HDFException
-
ANfileinfo
- Parameters:
an_id
- IN: the AN interface id, returned by ANstartinfo
- 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
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
ANselect
- Throws:
HDFException
-
ANnumann
- Throws:
HDFException
-
ANatype2tag
- Throws:
HDFException
-
ANtag2atype
- Throws:
HDFException
-
ANannlist
public static 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 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 ANnumann- Returns:
- an array of integers, which are the identifiers of the annotations
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
ANannlen
- Throws:
HDFException
-
ANreadann
- Parameters:
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.- Returns:
- an annotation string: annbuf[0] = the annotation
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
ANcreate
- Throws:
HDFException
-
ANcreatef
- Throws:
HDFException
-
ANget_tagref
- Parameters:
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 annotation- Returns:
- the tag and ref: tagref[0] = tag, tagref[1] = ref
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
ANid2tagref
- Parameters:
an_id
- IN: the AN interface id, returned by ANstarttagref
- OUT: short[2], the tag and ref of the annotation- Returns:
- the tag and ref: tagref[0] = tag, tagref[1] = ref
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
ANtagref2id
- Throws:
HDFException
-
ANwriteann
- Throws:
HDFException
-
DFPaddpal
- Throws:
HDFException
-
DFPgetpal
- Throws:
HDFException
-
DFPlastref
- Throws:
HDFException
-
DFPnpals
- Throws:
HDFException
-
DFPputpal
public static boolean DFPputpal(String filename, byte[] palette, int overwrite, String filemode) throws HDFException - Throws:
HDFException
-
DFPputpal
public static boolean DFPputpal(String filename, byte[] palette, boolean overwrite, String filemode) throws HDFException - Parameters:
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 library- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
DFPreadref
- Throws:
HDFException
-
DFPrestart
- Throws:
HDFException
-
DFPwriteref
- Throws:
HDFException
-
GRstart
- Throws:
HDFException
-
GRend
- Throws:
HDFException
-
GRfileinfo
- Parameters:
grid
- IN: the GR interface id, returned by GRstartargs
- OUT: int[2], n_datasets and n_file_attrs- Returns:
- the file info: args[0] = n_datasets, args[1] = n_file_attrs
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
GRgetchunkinfo
public static boolean GRgetchunkinfo(int sdsid, HDFChunkInfo chunk_def, int[] flag) throws HDFException - Parameters:
sdsid
- IN: the SD identifier returned by SDselectchunk_def
- OUT: HDFChunkInfo, the chunking infoflag
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
GRselect
- Throws:
HDFException
-
GRnametoindex
- Throws:
HDFException
-
GRgetiminfo
public static boolean GRgetiminfo(int grid, String[] gr_name, int[] args, int[] dim_sizes) throws HDFException - Parameters:
grid
- IN: the GR interface id, returned by GRstartargs
- 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 imagedim_sizes
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
GRreadimage
public static boolean GRreadimage(int grid, int[] start, int[] stride, int[] count, byte[] data) throws HDFException - Parameters:
grid
- IN: the GR interface id, returned by GRstartstart
- IN: int[], startstride
- IN: int[], stridecount
- IN: int[], countdata
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
GRreadimage
public static boolean GRreadimage(int grid, int[] start, int[] stride, int[] count, Object theData) throws HDFException - Parameters:
grid
- IN: the GR interface id, returned by GRstartstart
- IN: int[], startstride
- IN: int[], stridecount
- IN: int[], counttheData
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
GRendaccess
- Throws:
HDFException
-
GRidtoref
- Throws:
HDFException
-
GRreftoindex
- Throws:
HDFException
-
GRreqlutil
- Throws:
HDFException
-
GRreqimageil
- Throws:
HDFException
-
GRgetlutid
- Throws:
HDFException
-
GRgetnluts
- Throws:
HDFException
-
GRgetlutinfo
- Parameters:
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.- Returns:
- the palette info: args[0] = ncomp, args[1] = data_type, args[2] = interlace, args[3] = num_entries
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
GRreadlut
- Parameters:
lutid
- IN: the palette identifier returned by GRgetlutiddata
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
GRreadlut
- Parameters:
lutid
- IN: the palette identifier returned by GRgetlutidtheData
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
GRattrinfo
- Parameters:
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 attribute- Returns:
- the name, type, and lenght of the attribute: name[0] = name, argv[0] = data_type, argv[1] = length
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
GRgetattr
- Parameters:
id
- IN: the GR identifier returned by GRstartdata
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
GRgetattr
- Parameters:
id
- IN: the GR identifier returned by GRstarttheData
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
GRfindattr
- Throws:
HDFException
-
GRcreate
public static int GRcreate(int gr_id, String name, int ncomp, int data_type, int interlace_mode, int[] dim_sizes) throws HDFException - Throws:
HDFException
-
GRluttoref
- Throws:
HDFException
-
GRsetattr
public static boolean GRsetattr(int gr_id, String attr_name, int data_type, int count, String values) throws HDFException - Parameters:
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 String- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE:This routine writes a attribute that is a String. Alternative methods write data of other types.
-
GRsetattr
public static boolean GRsetattr(int gr_id, String attr_name, int data_type, int count, byte[] values) throws HDFException - Parameters:
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 bytes- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.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 static boolean GRsetattr(int gr_id, String attr_name, int data_type, int count, Object theData) throws HDFException - Parameters:
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.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE:This routine converts the Java array to bytes then writes it. DO NOT USE THIS TO WRITE A STRING.
-
GRsetchunk
- Parameters:
sdsid
- IN: the SD identifier returned by SDselectchunk_def
- IN: HDFChunkInfo, the chunking infoflags
- IN: the type of chunking- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE:The chunking algorithm-specific information is passed in an appropriate sub-class of HDFChunkInfo.
-
GRsetchunkcache
- Throws:
HDFException
-
GRsetcompress
public static boolean GRsetcompress(int ri_id, int comp_type, HDFCompInfo c_info) throws HDFException - Parameters:
ri_id
- IN: the GR identifier returned by GRstartcomp_type
- IN: the type of compressionc_info
- IN: HDFCompInfo, the compression info- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE:The compression algorithm specific information is passed in an appropriate sub-class of HDFCompInfo.
-
GRgetcompress
- Throws:
HDFException
-
GRsetexternalfile
- Throws:
HDFException
-
GRwriteimage
public static boolean GRwriteimage(int grid, int[] start, int[] stride, int[] edge, byte[] data) throws HDFException - Parameters:
grid
- IN: the GR interface id, returned by GRstartstart
- IN: int[], startstride
- IN: int[], strideedge
- IN: int[], countdata
- IN: byte[], data to be written- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write from a Java 2D array use the alternative routine below.
-
GRwriteimage
public static boolean GRwriteimage(int grid, int[] start, int[] stride, int[] edge, Object theData) throws HDFException - Parameters:
grid
- IN: the GR interface id, returned by GRstartstart
- IN: int[], startstride
- IN: int[], strideedge
- IN: int[], counttheData
- IN: Object, a Java array of appropriate type, dimensions, and size.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts the Java array to a contiguous block of bytes appropriate for C, and then writes the bytes.
-
GRwritelut
public static 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 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 bytes- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write from a Java array of numbers use the alternative routine below.
-
GRwritelut
public static 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 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.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts the Java array to a contiguous block of bytes appropriate for C, and then writes the bytes.
-
GRreadchunk
- Parameters:
sdsid
- IN: the GR interface id, returned by SDselectorigin
- IN: int[], origintheData
- OUT: byte[], the data in an array of bytes- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to read into a Java array use the alternative routine below.
-
GRreadchunk
- Parameters:
grid
- IN: the GR interface id, returned by SDselectorigin
- IN: int[], origintheData
- IN: Object, a Java array of appropriate type, dimensions, and size.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
-
HDFclose
- Throws:
HDFException
-
HDFopen
- Throws:
HDFException
-
HEvalue
- Throws:
HDFException
-
HEstring
- Throws:
HDFException
-
HXsetcreatedir
- Throws:
HDFException
-
HXsetdir
- Throws:
HDFException
-
SDstart
- Throws:
HDFException
-
SDend
- Throws:
HDFException
-
SDfileinfo
- Parameters:
sdid
- IN: the SD interface id, returned by SDstartargv
- 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
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDselect
- Throws:
HDFException
-
SDnametoindex
- Throws:
HDFException
-
SDgetinfo
public static boolean SDgetinfo(int sdsid, String[] name, int[] dimsizes, int[] args) throws HDFException - Parameters:
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 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDcheckempty
- Parameters:
sdsid
- IN: the SD interface id, returned by SDselectemptySDS
- OUT: int[1], 1 if the SDS is empty, 0 if has data- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDreaddata
public static boolean SDreaddata(int sdsid, int[] start, int[] stride, int[] count, byte[] data) throws HDFException - Parameters:
sdsid
- IN: the SD interface id, returned by SDselectstart
- IN: int[], startstride
- IN: int[], stridecount
- IN: int[], countdata
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDreaddata
public static boolean SDreaddata(int sdsid, int[] start, int[] stride, int[] count, Object theData) throws HDFException - Parameters:
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.- Returns:
- the the data in the Java array.
Note: reads the data as bytes and converts to the Java array.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDendaccess
- Throws:
HDFException
-
SDgetdimid
- Throws:
HDFException
-
SDdiminfo
- Parameters:
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 dimension- Returns:
- name[0] = name, argv[0] = count, argv[1] = data_type, argv[2] = nattr
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDidtoref
- Throws:
HDFException
-
SDreftoindex
- Throws:
HDFException
-
SDattrinfo
- Parameters:
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 attribute- Returns:
- name[0] = attr_name, argv[0] = data_type, argv[1] = count
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDreadattr
- Parameters:
id
- IN: id of a file, SDS, or dimensionindex
- IN: index of the attributedata
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDreadattr
- Parameters:
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.- Returns:
- the the data in the Java array.
Note: reads the data as bytes and converts to the Java array.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDfindattr
- Throws:
HDFException
-
SDiscoordvar
- Throws:
HDFException
-
SDgetcal
- Parameters:
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 data- Returns:
- argv[0] = cal, argv[1] = cal_err, argv[2] = offset, argv[3] = offset_err, NT[0] = data_type
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDgetdatastrs
- Parameters:
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)- Returns:
- strings[0] = label, strings[1] = unit, strings[2] = format, strings[3] = coordsys,
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDgetdimstrs
- Parameters:
dimid
- IN: id of the SDS as returned by SDselectargs
- OUT: String[4], data information strings: label unit print formatlen
- 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
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDgetdimscale
- Parameters:
dimid
- IN: id of a dimension as returned by SDgetdimiddata
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDgetdimscale
- Parameters:
dimid
- IN: id of a dimension as returned by SDgetdimidtheData
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDgetfillvalue
- Parameters:
sdsid
- IN: id of the SDS as returned by SDselectfillValue
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDgetfillvalue
- Parameters:
sdsid
- IN: id of the SDS as returned by SDselecttheFillValue
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDgetrange
- Parameters:
sdsid
- IN: id of the SDS as returned by SDselectmax
- OUT: byte[], max value, as bytesmin
- OUT: byte[], min 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDgetrange
- Parameters:
sdsid
- IN: id of the SDS as returned by SDselectmaxmin
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDcreate
public static int SDcreate(int sd_id, String name, int number_type, int rank, int[] dimsizes) throws HDFException - Throws:
HDFException
-
SDisrecord
- Throws:
HDFException
-
SDsetattr
public static boolean SDsetattr(int s_id, String attr_name, int num_type, int count, byte[] values) throws HDFException - Throws:
HDFException
-
SDsetattr
public static boolean SDsetattr(int s_id, String attr_name, int num_type, int count, Object theValues) throws HDFException - Throws:
HDFException
-
SDsetcal
public static boolean SDsetcal(int sds_id, double cal, double cal_err, double offset, double offset_err, int number_type) throws HDFException - Throws:
HDFException
-
SDsetdatastrs
public static boolean SDsetdatastrs(int sds_id, String label, String unit, String format, String coordsys) throws HDFException - Throws:
HDFException
-
SDsetdimname
- Throws:
HDFException
-
SDsetdimscale
public static boolean SDsetdimscale(int dim_id, int count, int number_type, byte[] data) throws HDFException - Parameters:
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.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.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 static boolean SDsetdimscale(int dim_id, int count, int number_type, Object theData) throws HDFException - Parameters:
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.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts the Java array to an array of bytes, and writes the bytes.
-
SDsetdimstrs
public static boolean SDsetdimstrs(int dim_id, String label, String unit, String format) throws HDFException - Throws:
HDFException
-
SDsetexternalfile
public static boolean SDsetexternalfile(int sds_id, String filename, int offset) throws HDFException - Throws:
HDFException
-
SDsetfillvalue
- Parameters:
sds_id
- IN: id of a datasetfill_val
- IN: byte[], the fill values in an array of bytes.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.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
- Parameters:
sds_id
- IN: id of a datasetthe_fill_val
- IN: Object, a Java object of appropriate type- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts the Java array to an array of bytes, and writes the bytes.
-
SDsetrange
- Parameters:
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 bytes- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.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
- Parameters:
sdsid
- IN: id of a datasetmax
- IN: Object, a Java object of appropriate typemin
- IN: Object, a Java object of appropriate type- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts the Java array to an array of bytes, and writes the bytes.
-
SDwritedata
public static boolean SDwritedata(int sdsid, int[] start, int[] stride, int[] count, byte[] data) throws HDFException - Parameters:
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 bytes- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write from a Java array use the alternative routine below.
-
SDwritedata
public static boolean SDwritedata(int sdsid, int[] start, int[] stride, int[] count, Object theData) throws HDFException - Parameters:
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.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts to the Java array to a contiguous array of bytes and then writes to the file.
-
SDsetnbitdataset
public static boolean SDsetnbitdataset(int id, int start_bit, int bit_len, int sign_ext, int fill_one) throws HDFException - Throws:
HDFException
-
SDsetcompress
- Parameters:
id
- IN: the SD identifier returned by SDselecttype
- IN: the type of compressioncinfo
- IN: HDFCompInfo, the compression info- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE:The compression algorithm specific information is passed in an appropriate sub-class of HDFCompInfo.
-
SDgetcompress
Deprecated.As of HDF 4.2.9, replaced bySDgetcompinfo(int, HDFCompInfo)
- Throws:
HDFException
-
SDgetcompinfo
- Throws:
HDFException
-
SDsetaccesstype
- Throws:
HDFException
-
SDsetblocksize
- Throws:
HDFException
-
SDsetfillmode
- Parameters:
sdsid
- IN: the SD idfill_enable
- IN: boolean, true calls library with SD_FILL, false calls library with SD_NOFILL- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDsetfillmode
- Throws:
HDFException
-
SDsetdimval_comp
- Throws:
HDFException
-
SDisdimval_bwcomp
- Throws:
HDFException
-
SDsetchunk
- Parameters:
sdsid
- IN: the SD identifier returned by SDselectchunk_def
- IN: HDFChunkInfo, the chunking infoflags
- IN: the type of chunking- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE:The chunking algorithm-specific information is passed in an appropriate sub-class of HDFChunkInfo.
-
SDgetchunkinfo
public static boolean SDgetchunkinfo(int sdsid, HDFChunkInfo chunk_def, int[] clflags) throws HDFException - Parameters:
sdsid
- IN: the SD identifier returned by SDselectchunk_def
- OUT: HDFChunkInfo, the chunking infoclflags
- OUT: int[1], the type of chunking- Returns:
- c_info contains information about the chunking method,
clflags[0] == the chunking flags
NOTE:The chunking algorithm-specific information is passed in an appropriate sub-class of HDFChunkInfo.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
SDreadchunk
- Parameters:
sdsid
- IN: the SD interface id, returned by SDselectorigin
- IN: int[], origintheData
- OUT: byte[], the data in an array of bytes- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to read into a Java array use the alternative routine below.
-
SDreadchunk
- Parameters:
sdsid
- IN: the SD interface id, returned by SDselectorigin
- IN: int[], origintheData
- IN: Object, a Java array of appropriate type, dimensions, and size.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
-
SDsetchunkcache
- Throws:
HDFException
-
SDwritechunk
- Parameters:
sdsid
- IN: the SD interface id, returned by SDselectorigin
- IN: int[], origindata
- IN: byte[], data to be written, in an array of bytes- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write from a Java array use the alternative routine below.
-
SDwritechunk
- Parameters:
sdsid
- IN: the SD interface id, returned by SDselectorigin
- IN: int[], origintheData
- IN: Object, a Java array of appropriate type, dimensions, and size.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts to the Java array to a contiguous array of bytes and then writes to the file.
-
VFfieldesize
- Throws:
HDFException
-
VFfieldisize
- Throws:
HDFException
-
VFfieldname
- Throws:
HDFException
-
VFfieldorder
- Throws:
HDFException
-
VFfieldtype
- Throws:
HDFException
-
VFnfields
- Throws:
HDFException
-
VHmakegroup
public static int VHmakegroup(int file_id, int[] tag_array, int[] ref_array, int n_objects, String vgroup_name, String vgroup_class) throws HDFException - Throws:
HDFException
-
VHstoredata
public static 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 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 Vdata- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write from a Java array use the alternative routine below.
-
VHstoredata
public static 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 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 Vdata- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts to the Java array to a contiguous array of bytes and then writes to the file.
-
VHstoredatam
public static 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 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 field- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write from a Java array use the alternative routine below.
-
VHstoredatam
public static 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 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 field- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts to the Java array to a contiguous array of bytes and then writes to the file.
-
VQueryref
- Throws:
HDFException
-
VQuerytag
- Throws:
HDFException
-
VSQuerycount
- Parameters:
vdata_id
- IN, vdata id as returned by VSattachn_records
- OUT, int[1], the number of records in the vdata- Returns:
- n_records[0] == the number of records
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSQueryfields
- Parameters:
vdata_id
- IN, vdata id as returned by VSattachfields
- OUT, String[1], the names of the fields- Returns:
- fields[0] == a comma delimited string with the names of the fields.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSQueryinterlace
- Parameters:
vdata_id
- IN, vdata id as returned by VSattachinterlace
- OUT, int[1], the interlace mode,- Returns:
- interlace[0] == the number of records, HDFConstants.FULL_INTERLACE or HDFConstants.NO_INTERLACE
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSQueryname
- Parameters:
vdata_id
- IN, vdata id as returned by VSattachvdata_name
- OUT, String[1], the name of the vdata- Returns:
- vdata_name[0] == the name
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSQueryref
- Throws:
HDFException
-
VSQuerytag
- Throws:
HDFException
-
VSQueryvsize
- Parameters:
vdata_id
- IN, vdata id as returned by VSattachvdata_size
- OUT, int[1], the size of the vdata- Returns:
- vdata_size[0] == Native size, in bytes, of a record in the vdata
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSattach
- Throws:
HDFException
-
VSdetach
- Throws:
HDFException
-
VSgetid
- Throws:
HDFException
-
VSgetclass
- Parameters:
vdata_id
- IN, vdata id as returned by VSattachhdfclassname
- OUT, String[1], the class name of the vdata- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSgetname
- Parameters:
vdata_id
- IN, vdata id as returned by VSattachhdfname
- OUT, String[1], the name of the vdata- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSelts
- Throws:
HDFException
-
VSfdefine
public static boolean VSfdefine(int vdata_id, String fieldname, int numbertype, int order) throws HDFException - Throws:
HDFException
-
VSfexist
- Throws:
HDFException
-
VSfind
- Throws:
HDFException
-
VSsetblocksize
- Throws:
HDFException
-
VSsetnumblocks
- Throws:
HDFException
-
VSgetfields
- Parameters:
vdata_id
- IN, vdata id as returned by VSattachfieldname
- OUT, String[1], the names of the fields- Returns:
- fieldname[0] == a comma delimited string with the names of the fields.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSgetinterlace
- Throws:
HDFException
-
VSinquire
- Parameters:
vdata_id
- IN, vdata id as returned by VSattachiargs
- OUT, int[3], n_records, interlace, vdata_sizesargs
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSinquire
- Parameters:
vdata_id
- IN, vdata id as returned by VSattachiargs
- OUT, int[2], block_size, num_blocks- Returns:
- iargs[0] = blocksize, iargs[1] = num_blocks
NOTE: the parameters for the Java interface are not in the same order as the C interface.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSlone
- Parameters:
fid
- IN, File identifier returned by Hopenref_array
- OUT, int[?], the refsbuffersize
- 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.
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSread
public static int VSread(int vdata_id, byte[] databuf, int nrecord, int interlace) throws HDFException - Parameters:
vdata_id
- IN: the Vdata iddatabuf
- OUT: byte[], the data in an array of bytesnrecord
- IN: int, number of recordsinterlace
- IN: int, interlace- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to read into a Java array use the alternative routine below.
-
VSread
public static int VSread(int vdata_id, Object theData, int nrecord, int interlace) throws HDFException - Parameters:
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, interlace- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
-
VSseek
- Throws:
HDFException
-
VSsetfields
- Throws:
HDFException
-
VSsetinterlace
- Throws:
HDFException
-
VSsizeof
- Throws:
HDFException
-
VSappendable
- Throws:
HDFException
-
VSfindclass
- Throws:
HDFException
-
VSgetversion
- Throws:
HDFException
-
VSsetclass
- Throws:
HDFException
-
VSsetexternalfile
- Throws:
HDFException
-
VSsetname
- Throws:
HDFException
-
VSwrite
public static int VSwrite(int vdata_id, byte[] databuf, int n_records, int interlace) throws HDFException - Parameters:
vdata_id
- IN: the Vdata iddatabuf
- IN: byte[], the data in an array of bytesn_records
- IN: int, number of recordsinterlace
- IN: int, interlace- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write a Java array use the alternative routine below.
-
VSwrite
public static int VSwrite(int vdata_id, Object databuf, int n_records, int interlace) throws HDFException - Parameters:
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, interlace- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.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
- Throws:
HDFException
-
Vattach
- Throws:
HDFException
-
Vdetach
- Throws:
HDFException
-
Vend
- Throws:
HDFException
-
Vgetid
- Throws:
HDFException
-
Vgetclass
- Parameters:
vgroup_id
- IN: the Vgroup idhdfclassname
- OUT: String[1], the HDF class of the vgroup.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
Vgetname
- Parameters:
vgroup_id
- IN: the Vgroup idhdfname
- OUT: String[1], the name of the vgroup.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
Visvg
- Throws:
HDFException
-
Visvs
- Throws:
HDFException
-
Vgettagrefs
public static int Vgettagrefs(int vgroup_id, int[] tags, int[] refs, int arraysize) throws HDFException - Parameters:
vgroup_id
- IN: the Vgroup idtags
- OUT: int[arraysize], the tagsrefs
- OUT: int[arraysize], the refsarraysize
- IN: int, the number of tags/refs to return- Returns:
- tags[] = tags for objects 0 - n, refs[] = refs for objects 0 - n
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
Vgettagref
- Parameters:
vgroup_id
- - IN: the Vgroup idindex
- - IN: the index of the objecttagref
- - OUT: tagref[0]=tag, tagref[1]=ref- Returns:
- tags[0] = tag for object #index, refs[0] = ref for objects #index
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
Vntagrefs
- Throws:
HDFException
-
Vinqtagref
- Throws:
HDFException
-
Vlone
- Parameters:
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_array- Returns:
- ref_array[] = refs 0 - ...
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
Vaddtagref
- Throws:
HDFException
-
Vdeletetagref
- Throws:
HDFException
-
Vfind
- Throws:
HDFException
-
Vfindclass
- Throws:
HDFException
-
Vflocate
- Throws:
HDFException
-
Vgetnext
- Throws:
HDFException
-
Vinquire
public static boolean Vinquire(int vgroup_id, int[] n_entries, String[] vgroup_name) throws HDFException - Parameters:
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 Vgroup- Returns:
- n_entries[0] = number of entries, vgroup_name[0] = the name
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
Vinsert
- Throws:
HDFException
-
Vnrefs
- Throws:
HDFException
-
Vsetclass
- Throws:
HDFException
-
Vsetname
- Throws:
HDFException
-
Vattrinfo
- Parameters:
id
- IN: Vgroup identifier returned by Vattachindex
- IN: 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,- Returns:
- name[0] = name, argv[0] = data_type, argv[1] = count, argv[2] = size, argv[3] = nfields, argv[4] = refnum
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
Vfindattr
- Throws:
HDFException
-
Vgetattr
- Parameters:
id
- IN: the Vdata idindex
- IN: the index of the attributedata
- OUT: byte[], the data in an array of bytes- Returns:
- data = the value of the attribute, in an array of bytes
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to read into a Java array use the alternative routine below.
-
Vgetattr
- Parameters:
id
- IN: the Vdata idindex
- IN: the index of the attributetheData
- OUT: Object, a Java array of appropriate type, dimensions, and size.- Returns:
- data = the value of the attribute, in an array of Java objects
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
-
Vgetversion
- Throws:
HDFException
-
Vnattrs
- Throws:
HDFException
-
Vsetattr
public static boolean Vsetattr(int id, String attr_name, int data_type, int count, String values) throws HDFException - Throws:
HDFException
-
Vsetattr
public static boolean Vsetattr(int id, String attr_name, int data_type, int count, byte[] data) throws HDFException - Parameters:
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 bytes- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write into a Java array use the alternative routine below.
-
Vsetattr
public static boolean Vsetattr(int id, String attr_name, int data_type, int count, Object theData) throws HDFException - Parameters:
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.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts the data to a contiguous array of bytes and then converts writes it.
-
VSattrinfo
public static boolean VSattrinfo(int id, int index, int attr_index, String[] name, int[] argv) throws HDFException - Parameters:
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,- Returns:
- name[0] = name, argv[0] = data_type, argv[1] = count, argv[2] = size
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSfindex
- Parameters:
id
- IN: the Vdata idname
- IN: the name of the attributefindex
- IN: int[1], the index of the attribute- Returns:
- findex[0] = the index
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
VSfindattr
- Throws:
HDFException
-
VSfnattrs
- Throws:
HDFException
-
VSgetattr
- Parameters:
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 bytes- Returns:
- data = the value of the attribute, in an array of bytes
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to read into a Java array use the alternative routine below.
-
VSgetattr
public static boolean VSgetattr(int id, int index, int attr_index, Object theData) throws HDFException - Parameters:
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.- Returns:
- data = the value of the attribute, in an array of Java objects
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
-
VSisattr
- Throws:
HDFException
-
VSnattrs
- Throws:
HDFException
-
VSsetattr
public static boolean VSsetattr(int id, int index, String attr_name, int data_type, int count, String values) throws HDFException - Parameters:
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: Strin, the data in an String- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write from a Java array use the alternative routine below.
-
VSsetattr
public static boolean VSsetattr(int id, int index, String attr_name, int data_type, int count, byte[] values) throws HDFException - Parameters:
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 bytes- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write into a Java array use the alternative routine below.
-
VSsetattr
public static boolean VSsetattr(int id, int index, String attr_name, int data_type, int count, Object theData) throws HDFException - Parameters:
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.- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts the data to a contiguous array of bytes and then converts writes it.
-
DF24getdims
- Throws:
HDFException
-
DF24reqil
- Throws:
HDFException
-
DF24getimage
public static boolean DF24getimage(String fileName, byte[] imagedata, int width, int height) throws HDFException - Parameters:
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 image- Returns:
- data = the image in an array of bytes
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to read into a Java array use the alternative routine below.
-
DF24getimage
public static boolean DF24getimage(String fileName, Object theImagedata, int width, int height) throws HDFException - Parameters:
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 image- Returns:
- data = the value of the attribute, in an array of Java objects
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
-
DF24lastref
- Throws:
HDFException
-
DF24restart
- Throws:
HDFException
-
DF24readref
- Throws:
HDFException
-
DF24nimages
- Throws:
HDFException
-
DF24addimage
public static boolean DF24addimage(String filename, byte[] image, int width, int height) throws HDFException - Parameters:
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 image- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write from a Java array use the alternative routine below.
-
DF24addimage
public static boolean DF24addimage(String filename, Object theImage, int width, int height) throws HDFException - Parameters:
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 image- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts the data into a contiguous array of bytes and then writes it to the file
-
DF24putimage
public static boolean DF24putimage(String filename, byte[] image, int width, int height) throws HDFException - Parameters:
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 image- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write from a Java array use the alternative routine below.
-
DF24putimage
public static boolean DF24putimage(String filename, Object theImage, int width, int height) throws HDFException - Parameters:
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 image- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts the data into a contiguous array of bytes and then writes it to the file
-
DF24setcompress
- Parameters:
type
- IN: int, the type of compressioncinfo
- IN: HDFCompInfo, the compression parameters- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
DF24setdims
- Throws:
HDFException
-
DF24setil
- Throws:
HDFException
-
DFR8getdims
public static boolean DFR8getdims(String fileName, int[] argv, boolean[] haspalette) throws HDFException - Throws:
HDFException
-
DFR8getimage
public static boolean DFR8getimage(String fileName, byte[] imagedata, int width, int height, byte[] palette) throws HDFException - Parameters:
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 table- Returns:
- data = imagedata: the image in an array of bytes, palette: the look up table, in an array of bytes
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to read into a Java array use the alternative routine below.
-
DFR8getimage
public static boolean DFR8getimage(String fileName, Object theImagedata, int width, int height, byte[] palette) throws HDFException - Parameters:
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 table- Returns:
- data = theImagedata: the value of the attribute, in an array of Java objects palette: the look up table, in an array of bytes
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: reads the data as a contiguous array of bytes and then converts it to an appropriate Java object.
-
DFR8lastref
- Throws:
HDFException
-
DFR8restart
- Throws:
HDFException
-
DFR8readref
- Throws:
HDFException
-
DFR8nimages
- Throws:
HDFException
-
DFR8addimage
public static boolean DFR8addimage(String filename, byte[] image, int width, int height, short compress) throws HDFException - Parameters:
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 compression- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write from a Java array use the alternative routine below.
-
DFR8addimage
public static boolean DFR8addimage(String filename, Object theImage, int width, int height, short compress) throws HDFException - Parameters:
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 compression- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts the data into a contiguous array of bytes and then writes it to the file
-
DFR8putimage
public static boolean DFR8putimage(String filename, byte[] image, int width, int height, short compress) throws HDFException - Parameters:
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 compression- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.NOTE: to write from a Java array use the alternative routine below.
-
DFR8putimage
public static boolean DFR8putimage(String filename, Object theImage, int width, int height, short compress) throws HDFException - Parameters:
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 compression- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.Note: converts the data into a contiguous array of bytes and then writes it to the file
-
DFR8setcompress
- Parameters:
type
- IN: int, the type of compressioncinfo
- IN: HDFCompInfo, the compression parameters- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
DFR8getpalref
- Parameters:
palref
- OUT: short[1], the HDF ref of the palette- Returns:
- palref[0] = the ref of the palette
- Throws:
HDFException
- should be thrown for errors in the HDF library call, but is not yet implemented.
-
DFR8setpalette
- Throws:
HDFException
-
DFR8writeref
- Throws:
HDFException
-
SDreaddata_short
public static boolean SDreaddata_short(int sdsid, int[] start, int[] stride, int[] count, short[] theData) throws HDFException - Throws:
HDFException
-
SDreaddata_int
public static boolean SDreaddata_int(int sdsid, int[] start, int[] stride, int[] count, int[] theData) throws HDFException - Throws:
HDFException
-
SDreaddata_long
public static boolean SDreaddata_long(int sdsid, int[] start, int[] stride, int[] count, long[] theData) throws HDFException - Throws:
HDFException
-
SDreaddata_float
public static boolean SDreaddata_float(int sdsid, int[] start, int[] stride, int[] count, float[] theData) throws HDFException - Throws:
HDFException
-
SDreaddata_double
public static boolean SDreaddata_double(int sdsid, int[] start, int[] stride, int[] count, double[] theData) throws HDFException - Throws:
HDFException
-
HCget_config_info
New API for hdf-42r1- Throws:
HDFException
-
SDgetcompinfo(int, HDFCompInfo)