The HDF Group

HDF User’s Guide

Version 4.2.7


[Top] [Prev][Next]


List of Tables


Chapter 1 - Introduction to HDF
Chapter 2 - HDF Fundamentals
TABLE 2A Hopen Parameter List 11
TABLE 2B File Access Code Flags 12
TABLE 2C Hclose Parameter List 12
TABLE 2D Hgetlibversion and Hgetfileversion Parameter Lists 13
TABLE 2E Hishdf/hishdff Parameter List 13
TABLE 2F Standard HDF Data Types and Flags 14
TABLE 2G Native Format Data Type Definitions 15
TABLE 2H Little-Endian Format Data Type Definitions 15
TABLE 2I Limit Definitions 16
TABLE 2J Correspondence Between Fortran and HDF C Data Types 17
Chapter 3 - Scientific Data Sets (SD API)
TABLE 3A SD Interface Routines 24
TABLE 3B File Access Code Flags 27
TABLE 3C SDstart, SDcreate, SDselect, SDendaccess, and SDend Parameter Lists 29
TABLE 3D SDwritedata Parameter List 33
TABLE 3E SDisrecord Parameter List 42
TABLE 3F SDsetblocksize and SDsetaccesstype Parameter List 43
TABLE 3G SDsetcompress Parameter List 49
TABLE 3H sfscompress Parameter List 49
TABLE 3I HXsetdir and HXsetcreatedir Parameter Lists 54
TABLE 3J SDsetexternalfile Parameter List 56
TABLE 3K SDreaddata Parameter List 59
TABLE 3L SDfileinfo, SDgetinfo, and SDgetcompinfo Parameter Lists 68
TABLE 3M SDnametoindex, SDnametoindices, and SDgetnumvars_byname Parameter Lists 73
TABLE 3N SDreftoindex, SDidtoref, SDidtype, and SDcheckempty Parameter Lists 74
TABLE 3O SDsetnbitdataset Parameter List 78
TABLE 3P SDgetdimid and SDsetdimname Parameter Lists 80
TABLE 3Q SDsetdimval_comp and SDisdimval_bwcomp Parameter Lists 81
TABLE 3R SDsetdimscale, SDdiminfo, and SDgetdimscale Parameter Lists 83
TABLE 3S SDiscoordvar Parameter List 89
TABLE 3T SDsetattr, SDfindattr, SDattrinfo, and SDreadattr Parameter Lists 98
TABLE 3U Predefined Attributes List 104
TABLE 3V Predefined Attribute Definitions 105
TABLE 3W SDsetdatastrs and SDgetdatastrs Parameter Lists 106
TABLE 3X SDsetdimstrs and SDgetdimstrs Parameter Lists 107
TABLE 3Y SDsetrange and SDgetrange Parameter Lists 108
TABLE 3Z SDsetfillvalue, SDgetfillvalue, and SDsetfillmode Parameter Lists 110
TABLE 3AA SDsetcal and SDgetcal Parameter Lists 111
TABLE 3AB SDgetfilename, SDgetnamelen, SDreset_maxopenfiles, SDget_maxopenfiles, and
SDget_numopenfiles Parameter Lists 113
TABLE 3AC SDsetnbitdataset Parameter List 115
TABLE 3AD SDsetchunk Parameter List 117
TABLE 3AE sfschnk Parameter List 117
TABLE 3AF SDsetchunkcache Parameter List 118
TABLE 3AG SDwritechunk Parameter List 120
TABLE 3AH SDreadchunk Parameter List 121
TABLE 3AI SDgetchunkinfo Parameter List 122
TABLE 3AJ sfgichnk Parameter List 122
TABLE 3AK Summary of HDF and XDR File Compatibility for the HDF and netCDF APIs 134
TABLE 3AL NC Interface Routine Calls and their SD Equivalents 135
Chapter 4 - Vdatas (VS API)
TABLE 4A Vdata Interface Routines 140
TABLE 4B Vstart, VSattach, VSdetach, and Vend Parameter Lists 144
TABLE 4C VHstoredata and VHstoredatam Parameter Lists 152
TABLE 4D Predefined Data Types and Field Names for Vdata Fields 157
TABLE 4E VSsetname, VSsetclass, VSfdefine, VSsetfields, and VSsetinterlace Parameter Lists 159
TABLE 4F VSseek and VSwrite Parameter Lists 163
TABLE 4G VSsetblocksize and VSsetnumblocks Parameter Lists 167
TABLE 4H VSfpack Parameter List 169
TABLE 4I VSread Parameter List 175
TABLE 4J VSlone, VSgetid, VSfind, and VSfexist Parameter Lists 184
TABLE 4K VSgetvdatas, VSisinternal, and VSofclass Parameter Lists 190
TABLE 4L VSfindex Parameter List 191
TABLE 4M VSsetattr and VSgetattr Parameter Lists 192
TABLE 4N VSnattrs and VSfnattrs Parameter Lists 193
TABLE 4O VSfindattr, VSattrinfo, and VSisattr Parameter Lists 194
TABLE 4P VSinquire Parameter List 200
TABLE 4Q VSgetblockinfo Parameter List 204
TABLE 4R VSQuery Routines Parameter Lists 205
TABLE 4S VSelts, VSgetfields, VSgetinterlace, VSsizeof, VSgetname, and VSgetclass Parameter Lists 206
TABLE 4T VF Routines Parameter Lists 207
Chapter 5 - Vgroups (V API)
TABLE 5A Vgroup Interface Routines 213
TABLE 5B Vstart, Vattach, Vdetach, and Vend Parameter Lists 216
TABLE 5C Vsetname, Vsetclass, Vaddtagref, Vinsert, and VHmakegroup Parameter Lists 219
TABLE 5D Vlone, Vgetid, Vgetvgroups, and Vgisinternal Parameter Lists 234
TABLE 5E Vgetname, Vgetnamelen, Vgetclass, and Vgetclassnamelen Parameter Lists 235
TABLE 5F Vfind and Vfindclass Parameter Lists 236
TABLE 5G Vntagrefs, Vgettagref, and Vgettagrefs Parameter Lists 241
TABLE 5H Vinqtagref, Visvg, and Visvs Parameter Lists 242
TABLE 5I Vflocate and Vnrefs Parameter Lists 243
TABLE 5J VQueryref and VQuerytag Parameter Lists 243
TABLE 5K Vdelete and Vdeletetagref Parameter Lists 248
TABLE 5L Vgetversion, Vsetattr, and Vfindattr Parameter Lists 250
TABLE 5M Vnattrs and Vnattrs2 Parameter Lists 251
TABLE 5N Vattrinfo and Vattrinfo2 Parameter Lists 252
TABLE 5O Vgetattr and Vgetattr2 Parameter Lists 253
TABLE 5P Vgetnext and Vinquire Parameter Lists 258
Chapter 6 - 8-Bit Raster Images (DFR8 API)
TABLE 6A 8-Bit Raster Image Compression Method List 261
TABLE 6B DFR8 Library Routines 262
TABLE 6C DFR8putimage and DFR8addimage Parameter List 263
TABLE 6D DFR8setpalette Parameter List 265
TABLE 6E DFR8setcompress Parameter List 267
TABLE 6F DFR8writeref Parameter List 270
TABLE 6G DFR8getdims and DFR8getimage Parameter List 272
TABLE 6H DFR8readref Parameter List 273
TABLE 6I DFR8nimages Parameter List 274
TABLE 6J DFR8nimages Parameter List 274
Chapter 7 - 24-bit Raster Images (DF24 API)
TABLE 7A 24-Bit Raster Image Compression Method List 279
TABLE 7B 24-Bit Raster Image Interlace Format 280
TABLE 7C DF24 Library Routines 281
TABLE 7D DF24putimage and DF24addimage Parameter List 282
TABLE 7E DF24setil and DF24setcompress Parameter List 285
TABLE 7F DF24getimage, DF24getdims and DF24reqil Parameter List 288
TABLE 7G DF24readref Parameter List 289
TABLE 7H DF24restart Parameter List 290
TABLE 7I DF24nimages Parameter List 290
TABLE 7J DF24lastref Parameter List 291
Chapter 8 - General Raster Images (GR API)
TABLE 8A GR Library Routines 296
TABLE 8B GRstart, GRselect, GRcreate, GRendaccess, and GRend, Parameter Lists 300
TABLE 8C GRwriteimage Parameter List 302
TABLE 8D GRsetcompress and GRsetaccesstype Parameter List 311
TABLE 8E GRsetexternalfile Parameter List 312
TABLE 8F GRreadimage and GRreqimageil Parameter Lists 314
TABLE 8G GRfileinfo and GRgetiminfo Parameter Lists 320
TABLE 8H GRidtoref, GRreftoindex, GRnametoindex, and GRgetcompinfo Parameter Lists 323
TABLE 8I GRsetattr, GRfindattr, GRattrinfo, and GRgetattr Parameter Lists 332
TABLE 8J GRgetlutid, GRgetlutinfo, and GRluttoref Parameter Lists 337
TABLE 8K GRgetlutid, GRwritelut, GRreqlutil, and GRreadlut Parameter Lists 340
TABLE 8L GRsetchunk, GRgetchunkinfo, GRsetchunkcache, GRwritechunk, and
GRreadchunk Parameter Lists 358
Chapter 9 - Palettes (DFP API)
TABLE 9A DFP Library Routines 360
TABLE 9B DFPputpal and DFPaddpal Parameter List 361
TABLE 9C DFPwriteref Parameter List 362
TABLE 9D DFPgetpal Parameter List 363
TABLE 9E DFPreadref Parameter List 364
TABLE 9F DFPnpals Parameter List 365
Chapter 10 - Annotations (AN API)
TABLE 10A AN Library Routines 370
TABLE 10B ANstart, ANcreate, ANcreatef, ANendaccess and ANend Parameter Lists 372
TABLE 10C ANwriteann Parameter List 373
TABLE 10D ANselect and ANreadann Parameter Lists 378
TABLE 10E ANfileinfo and ANannlen Parameter Lists 382
TABLE 10F ANnumann and ANannlist Parameter Lists 383
TABLE 10G ANget_tagref, ANid2tagref, ANtagref2id, ANatype2tag, and ANtag2atype Parameter Lists 386
Chapter 11 - Single-file Annotations (DFAN API)
TABLE 11A DFAN Library Routines 392
TABLE 11B List of Annotation Interface Tags in HDF Versions 2.0, 3.0 and 4.0 393
TABLE 11C DFANaddfid and DFANaddfds Parameter List 394
TABLE 11D DFANputlabel and DFANputdesc Parameter List 396
TABLE 11E DFANgetfidlen, DFANgetfid, DFANgetfdslen, and DFANgetfds Parameter List 399
TABLE 11F DFANgetlablen, DFANgetlabel, DFANgetdesc and DFANgetdesclen Parameter List 402
TABLE 11G DFANclear Parameter List 403
TABLE 11H List and Descriptions of the DF*writeref and DF*lastref Routines 405
TABLE 11I DFANlablist Parameter List 406
Chapter 12 - Single-File Scientific Data Sets (DFSD API)
TABLE 12A DFSD Library Routines 411
TABLE 12B DFSDadddata and DFSDputdata Parameter List 412
TABLE 12C DFSDsetNT and DFSDwriteref Parameter List 414
TABLE 12D DFSDsetdims Parameter List 415
TABLE 12E DFSDclear Parameter List 416
TABLE 12F DFSDgetdata Parameter List 416
TABLE 12G DFSDgetNT and DFSDgetdims Parameter List 417
TABLE 12H DFSDreadref Parameter List 419
TABLE 12I DFSDstartslab Parameter List 420
TABLE 12J DFSDwriteslab Parameter List 421
TABLE 12K DFSDreadslab Parameter List 422
TABLE 12L DFSDsetlengths and DFSDsetdatastrs Parameter List 423
TABLE 12M DFSDsetfillvalue, DFSDsetrange and DFSDsetcal Parameter List 424
TABLE 12N DFSDgetdatalen and DFSDgetdatastrs Parameter List 427
TABLE 12O DFSDgetfillvalue, DFSDgetcal and DFSDgetrange Parameter List 429
TABLE 12P DFSDsetlengths and DFSDsetdimstrs Parameter List 430
TABLE 12Q DFSDsetdimscale Parameter List 430
Chapter 13 - Error Reporting
TABLE 13A Error Reporting Routine List 431
TABLE 13B HDF Error Codes 434
Chapter 14 - HDF Performance Issues
TABLE 14A Results of the Write Operation to 1,000 1x1x1 Element Scientific Data Sets 438
TABLE 14B Results of the Write Operation to One 10x10x10 Element Scientific Data Set 439
TABLE 14C Results of the Write Operation to 1,000 1x1x1 Element Scientific Data Sets 440
TABLE 14D Results of the Write Operation to 1,000 1x1x1 SDSs with Shared Dimensions 441
TABLE 14E Results of the Write Operation to the 50 10x10x10 SDSs with the Fill Value Write Enabled 442
TABLE 14F Results of the Write Operation to the 50 SDSs with the Fill Value Write Disabled 442
TABLE 14G Results of the SDS Write Operation with the New and Old Dimension Scales 443
TABLE 14H Results of the SDS Write Operation with Only the New Dimension Scale 444
Chapter 15 - HDF Command-line Utilities
TABLE 15A The HDF Command-line Utilities 457
TABLE 15B hdp Option Flags 458
TABLE 15C The hdp Command Set 458
TABLE 15D hdiff Option Flags 462
TABLE 15E vshow Option Flags 463
TABLE 15F hdfimport Options and Parameters 465
TABLE 15G hdfimport ASCII Text, Native Floating Point, or Native Integer Input Fields 466
TABLE 15H r8tohdf Option Flags 468
TABLE 15I hdftor8 Option Flags: 469
TABLE 15J hdfcomp Option Flags 471
TABLE 15K hdfpack Option Flags 472
TABLE 15L hdfls Option Flags 475
TABLE 15M hdfed Option Flags 478
TABLE 15N The hdfed Command Set 479
TABLE 15O h4cc Options and Compiler Options 490
TABLE 15P Environment Variables 491
TABLE 15Q h4fc Option Flags 492
TABLE 15R Environment Variables 492
TABLE 15S h4redeploy Option Flags 493
Chapter 16 - Raw Data Information
TABLE 16A Raw Data Information Retrieval Routines 496
TABLE 16B ANgetdatainfo Parameter List 497
TABLE 16C SDgetdatainfo Parameter List 498
TABLE 16D SDgetattdatainfo Parameter List 498
TABLE 16E HDF4 Predefined Attributes 500
TABLE 16F SDgetoldattdatainfo Parameter List 500
TABLE 16G SDgetanndatainfo Parameter List 501
TABLE 16H GRgetdatainfo Parameter List 502
TABLE 16I GRgetattdatainfo Parameter List 502
TABLE 16J Vgetattdatainfo Parameter List 503
TABLE 16K VSgetdatainfo Parameter List 504
TABLE 16L VSgetattdatainfo Parameter List 504
TABLE AA The HDF Utility Tags 508
TABLE AB The HDF General Raster Image Tags 508
TABLE AC The HDF Composite Image Tags 509
TABLE AD The HDF Scientific Data Set Tags 509
TABLE AE The HDF Vset Tags 510
TABLE AF The Obsolete HDF Tags 510
TABLE AG Pre-defined Attributes in the DFSD and SD APIs 513

HDF 4.2.7 - February 2012
Copyright
The HDF Group
www.hdfgroup.org
The HDF Group