![]() |
HDF User’s GuideVersion 4.2.5 |
[Top] |
Index
Numericscompressing , data 266data representation 259determining the dimensions of a 269modifying the interlace mode of a 269querying the reference number of the most-recently-accessed 272querying the total number of , in a file 272reading a , with a given reference number 271routines for obtaining information about 272setting the interlace mode for a 265specifying that the next , read to be the first 27124-bit Raster Image APIdescription 424-bit raster image API 262routine categories 262routine list 26324-bit raster image data setcompression methods 260contents of a 259description 259interlace modes 26124-bit raster image data set dimensiondescription 2608-bit raster imagecompressing 248description 241determining the reference number of the most-recently-accessed 256determining the reference number of the palette of the most-recently-accessed 256querying the dimensions of a 253querying the total number of , in a file 255reading a , with a given reference number 255routines for obtaining information about 255specifying the next , to be read 255specifying the reference number for a 2528-bit Raster Image APIdescription 48-bit raster image API 244routine categories 244routine list 244compression methods 242description 2418-bit raster image data set dimensiondescription 2428-bit raster image data set palettedescription 242AANannlendescription 361parameter list 362ANannlistdescription 362parameter list 363ANatype2tagdescription 364parameter list 365ANcreatedescription 351parameter list 351ANcreatefdescription 351parameter list 351ANendparameter list 351ANendaccessparameter list 351ANfileinfodescription 361parameter list 362ANget_tagrefdescription 363parameter list 365ANid2tagrefdescription 363parameter list 365description 347getting the length of an , using the multifile annotation API 361obtaining a list of , corresponding to given search criteria using the multifile annotation API 362obtaining information about every , in a file using the multifile annotation API 361obtaining the number of , corresponding to given search criteria using the multifile annotation API 362selecting an , using the multifile annotation API 357writing an , using the multifile annotation API 352Annotation APIdescription 4Annotation data modeldescription 347ANnumanndescription 362parameter list 363ANreadanndescription 357parameter list 358ANselectdescription 357parameter list 358ANstartdescription 351parameter list 351ANtag2atypedescription 364parameter list 365ANtagref2iddescription 364parameter list 365ANwriteanndescription 352parameter list 352Array rank 20Attribute indexdescription 311BBlock sizesetting the , for unlimited SDS dimensions 42Buffer interlacingdescription 151CCalibrated datareading 109writing 108Color lookup tabledescription 316Command-line utilities 437-??categories of 5description 437list of 437purpose 437COMP_JPEG definedescription 260COMP_NONE definedescription 260Composite image tagslist of 54Compressing an HDF file 452Compressing RIS8 images in an HDF file 451Converting 24-bit raw raster images to RIS8 images 448Converting 8-bit raster images to the HDF format 447Converting an HDF RIS24 image to an HDF RIS8 image 451Converting floating-point data to an SDS or RIS8 object 443Converting raw palette data to the HDF palette format 449Converting several RIS8 images to one 3D SDS 450Coordinate system attributeDD24readrefparameter list 271Data elementdescription 457Data objectdescription 457Description annotationdescription 347DF*lastref routinelist and descriptions of all 384methods of determining a reference number through the use of a 383DF24addimagedescription 263parameter list 264DF24getdimsdescription 269parameter list 270DF24getimagedescription 268parameter list 270DF24lastrefdescription 272parameter list 273DF24nimagesdescription 272parameter list 272DF24putimagedescription 263parameter list 264DF24readrefdescription 271DF24reqildescription 269parameter list 270DF24restartdescription 272parameter list 272DF24setcompressdescription 266parameter list 267DF24setildescription 265parameter list 267DFANaddfdsdescription 374parameter list 374DFANaddfiddescription 373parameter list 374DFANgetdescdescription 381parameter list 381DFANgetdesclendescription 381parameter list 381DFANgetfdsdescription 379parameter list 379DFANgetfdslendescription 378parameter list 379DFANgetfiddescription 378parameter list 379DFANgetfidlendescription 378parameter list 379DFANgetlabeldescription 380parameter list 381DFANgetlablendescription 380parameter list 381DFANlablistdescription 384DFANputdescdescription 375parameter list 376DFANputlabeldescription 375parameter list 376DFPaddpaldescription 341parameter list 341DFPgetpaldescription 343parameter list 343DFPlastrefdescription 345DFPnpalsdescription 344parameter list 345DFPputpaldescription 341parameter list 341DFPreadrefdescription 344parameter list 344DFPrestartdescription 344DFPwriterefdescription 342parameter list 342DFR8addimagedescription 245parameter list 245DFR8getdimsdescription 253parameter list 254DFR8getimagedescription 252parameter list 254DFR8getpalrefdescription 256DFR8lastrefdescription 256DFR8nimagesdescription 255parameter list 256DFR8putimagedescription 245parameter list 245DFR8readrefdescription 255parameter list 255DFR8restartdescription 255DFR8setcompressdescription 248parameter list 249DFR8setpalettedescription 246parameter list 247DFR8writerefdescription 252parameter list 252DFSD scientific data set 389-??assigning string attributes to a 403assigning value attributes to a 403contents of a 389creating a 392description 389determining the number of , in a file 398obtaining reference numbers for a 399optional objects 390preventing the reassignment of , attributes 395reading 396-??reading the dimension attributes of a 410-??reading the value attributes of a 408required objects 389resetting the default interlace settings for a 395specifying the data type of a 393specifying the dimensions and data type of a 397writing 392-??writing several 394writing the dimension scale of a 410DFSD scientific data set APIroutine categories 390routine list 391use of file identifiers in the 391use of predefined attributes in the 402-??DFSD scientific data set dimensionwriting the string attributes of a 409DFSDadddatadescription 392parameter list 392DFSDcleardescription 395parameter list 396DFSDendslabdescription 399DFSDgetcaldescription 408parameter list 409DFSDgetdatadescription 396parameter list 396DFSDgetdatalendescription 406parameter list 407DFSDgetdatastrsdescription 406parameter list 407DFSDgetdimlendescription 410DFSDgetdimsdescription 397parameter list 397DFSDgetdimscaledescription 410DFSDgetdimstrsdescription 410DFSDgetfillvaluedescription 408parameter list 409DFSDgetNTdescription 397parameter list 397DFSDgetrangedescription 408parameter list 409DFSDlastrefdescription 399DFSDndatasetsdescription 398DFSDputdatadescription 392parameter list 392DFSDreadrefdescription 399parameter list 399DFSDreadslabdescription 401parameter list 402DFSDrestartdescription 398DFSDsetcaldescription 404parameter list 404DFSDsetdatastrsdescription 403parameter list 403DFSDsetdimsdescription 395parameter list 395DFSDsetdimscaledescription 410parameter list 410DFSDsetdimstrsdescription 409parameter list 410DFSDsetfillvaluedescription 404parameter list 404DFSDsetlengthsDFSDsetNTdescription 393parameter list 394DFSDsetrangedescription 404parameter list 404DFSDstartslabdescription 399parameter list 400DFSDwriterefdescription 394parameter list 394DFSDwriteslabdescription 400parameter list 401Dimension attribute 90Dimension compatbility modedetermining the current 79Dimension compatibility modedescription 78setting the future 78Dimension format attributedescription 409Dimension label attributedescription 409Dimension namedescription 21Dimension recordcreation of a 89Dimension scaledescription 22Dimension unit attributedescription 409Displaying vdata information 443dumper 438EEditing the contents of an HDF file 457Error reporting APIdescription 411returning the code of the nth-most-recent error 412returning the description of an error code 412routine list 411writing error stack information to a file 412writing errors to a console window 413External data filedefinition 52moving data to a 55reading from a 57specifying the directory search path in a 52specifying the location of the next, to be created 53writing to a 52External SDS arraydefinition 52Extracting 8-bit raster images and palettes from HDF files 449Extracting palette data from an HDF file 450FField datapacking or unpacking 160File annotationcomparison with object annotation 348description 348File attributedescription 90File description annotationassigning a , using the single-file annotation API 374reading a , using the single-file annotation API 378File interlacingdescription 151File label annotationassigning a , using the single-file annotation API 373reading a 357reading a , using the single-file annotation API 377fill modedescription 106fill valuedescription 106description 101fill value attributereading a 107writing a 107FILL_ATTR definedescription 307Format attributefptohdf 443Gaccessing 280compressing 291creating a , in an external file 292getting the index of a 301I/O access type 291obtaining information about a 301reading 294setting the interlace mode for a , or image read 294terminating access to 281General raster image APIchunking 326description 4external file operations using the 292obtaining a palette identifier using the 316obtaining information about the contents of a file using , routines 300obtaining palette information using the 317reading palette data using the 319routine list 278writing palette data using the 318General raster image arraydescription 276General raster image array namedescription 276predefined 307querying user-defined 311reading user-defined 311setting user-defined 307General raster image attributesdescription 277General raster image data setoptional objects 277required objects 276General raster image data set API 277programming model 279routine categories 277General raster image indexdescription 276General raster image palettesdescription 277General raster image pixel typedata type 276description 276General raster image reference numberdescription 276General raster image tagslist of 53Global attributedescription 90GRattrinfodescription 311parameter list 312GRcreatedescription 280parameter list 281GRenddescription 281parameter list 281GRendaccessdescription 281parameter list 281GRfileinfodescription 300parameter list 301GRfindattrdescription 311parameter list 312GRgetattrdescription 311parameter list 312GRgetchunkinfodescription 335parameter list 337GRgetiminfoparameter list 301GRgetlutiddescription 316parameter list 319GRgetlutinfodescription 317GRidtorefdescription 301GRluttorefdescription 317parameter list 317GRnametoindexparameter list 303Group objectdescription 457GRreadchunkGRreadimagedescription 294parameter list 295GRreadlutdescription 319parameter list 319GRreftoindexdescription 302parameter list 303GRreqimageilparameter list 295GRrequtildescription 318GRselectdescription 280parameter list 281GRsetaccesstypeparameter list 292GRsetaccestypedescription 291GRsetattrdescription 307parameter list 312GRsetchunkdescription 327parameter list 337GRsetchunkcachedescription 336parameter list 337GRsetcompressdescription 291parameter list 292GRsetexternalfiledescription 293parameter list 293GRstartdescription 280parameter list 281GRwriteimagedescription 282parameter list 283GRwritelutdescription 318parameter list 319HHDFdescription 1HDF APIHDF dumper 438HDF installation overview 56-??HDF_CHUNK_DEF uniondefinition of 113hdf24hdf8 451hdfcomp 451hdfed 457annotate command 463close command 465delete command 463display command 464dump command 462getr8 command 466help command 460if conditional 466info command 460next command 462open command 460prev command 461put command 466putr8 command 465revert command 466wait command 466write command 464hdfed command set 459hdfls 455hdfpack 452hdftopal 450hdftor8 449hdiff 442hdp 438command set 438dumprig command 441dumpsds command 439dumpvd command 440dumpvg command 441list command 439HEcleardescription 413HEprintdescription 412HEstringdescription 412HEvaluedescription 412Hishdf/hishdff 13history attributedescription 102HXsetcreatedirdescription 53HXsetdir and HXsetcreatedirparameter list 54II/O access typesetting the 42IMCOMP compressiondescription 243interlace mode 151JJPEG compressionJPEG compression quality factordescription 243LLabel annotationdescription 347Label attributeListing basic information about an HDF file 455Local attributedescription 90Lone vdatadescription 175Lone vgroupdescription 218Low-level interface 2MMFGR_INTERLACE_LINE definedescription 280MFGR_INTERLACE_PIXEL defineMFGR_INTERLACE_PLANE definedescription 280missing_value attributedescription 102description of the 349list of tags used in 372programming model for the 350routine categories 349routine list 349type definitions specific to the 350NNative format option 14netCDF data modelHDF support of 130Not-a-Number 106OObject annotationcomparison with file annotation 348description 348Object description annotationassigning a , using the single-file annotation API 375reading a , using the single-file annotation API 381Object label annotationassigning a , using the single-file annotation API 375reading a , using the single-file annotation API 380Obsolete tagslist of 55Old and new dimension implementation 78PPacking or unpacking field data 160adding to a RIS8 object 246backward compatibility issues 345color mapping using a 339description 339obtaining the reference number of the most recently accessed 345querying the number of , in a file 344reading a , with a given reference number 344retrieving the reference number of the specified 317specifying the next palette to be accessed to be the first 344specifying the reference number of a 342Palette APIroutine categories 340routine list 340paltohdf 449Performance Issues 417-??Pixel interlacingdescription 261Pixelsdescription 241accessing a 102list of , with labels and descriptions 102list of parameters 103naming conventions for 102Predefined dimension string attributetypes of 409Predefined string attributetypes of 403Rr24hdf8 448r8tohdf 447Range attributedescription 101reading a 106writing a 105Range attributes 105Raster image idsee Raster image identifier 276Record variabledetermining whether an SDS is a 42Reference numberchecking before assigning an object annotation 383determining 383determining the , for the last object accessed 383querying a list of , for a given tag 384Reference number, overwriting data for a specified 394RGB valuesdescription 259ristosds 450RLE compressiondescription 243SScan-line interlacingdescription 261Scan-plane interlacingdescription 261Scientific data set tagslist of 54SD scientific data modelannotations and the 22appending data to a 41chunked 113chunked , obtaining information about a 118chunked , reading data from a 118chunked , writing to a 116chunks , setting the maximum number to cache 115compressing data in a 47contents of a 19data type 20default data representation 14dimension scales for more than one , 89establishing access to a 26locating a , by reference number 71making a chunked , from a generic 113optional objects 21reading from a 57required objects 20string attributes of dimensions 104terminating access to a 28writing to a 31SD scientific data set APIcompression methods supported 47routine categories 22routine list 24SD scientific data set arraydescription 20distinguishing from a coordinate variable 86SD scientific data set array namedescription 20SD scientific data set attribute 90SD scientific data set dimensiondescription 20naming a 77obtaining information about a 80selecting a 77SD scientific data set dimension indexdescription 21SD scientific data set dimension scalesdescription 79writing 80SD scientific data set dimension string attributereading a 104writing a 104SD scientific data set string attributedescription 103reading a 103writing a 103SD scientific data setsrelated , definition 89SDattrinfodescription 94parameter list 96SDdiminfodescription 80SDenddescription 28parameter list 29SDendaccessdescription 28parameter list 29SDexternalfiledescription 54SDfileinfoSDfindattrdescription 94parameter list 96SDget_numopenfilesdescription 111SDgetcaldescription 109parameter list 109SDgetChunkInfodescription 118SDgetdatastrsdescription 103parameter list 104SDgetdimiddescription 77parameter list 78SDgetdimstrsdescription 104parameter list 105SDgetfillvaluedescription 107parameter list 108SDgetinfoSDgetrangedescription 106parameter list 106SDidtorefdescription 72SDiscoordvardescription 86SDisrecorddescription 42SDnametoindexparameter list 71SDreadattrdescription 95parameter list 96SDreadChunkdescription 118parameter list 118SDreaddatadescription 57parameter list 58SDreftoindexdescription 71parameter list 71SDS idsee SD scientific data set identifier 20SDselectparameter list 29SDsetaccesstypedescription 42parameter list 43SDsetattrdescription 91parameter list 96SDsetblocksizedescription 42parameter list 43SDsetcaldescription 108parameter list 109SDsetChunkdescription 113SDsetChunkCachedescription 115parameter list 116SDsetcompressdescription 47SDsetdatastrsdescription 103SDsetdimnamedescription 77parameter list 78SDsetdimstrsparameter list 105SDsetdimval_bwcompdescription 79parameter list 79SDsetdimval_compdescription 78SDsetexternalfileparameter list 55SDsetfillmodeparameter list 108SDsetfillvaluedescription 107parameter list 108SDsetnbitdatasetSDsetrangedescription 105parameter list 106SDstartdescription 27SDwriteChunkparameter list 118SDwritechunkdescription 117SDwritedatadescription 31parameter list 33writing data to chunked SDSs using 116Self-descriptiondefinition 1sfgcfilldescription of 107sfgfilldescription of 107sfrcattdescription of 95sfrnattdescription of 95sfwcdatadescription of 33sfwdatadescription of 33Single-file Annotation APIroutine categories 371list of tags used in 372programming model for the 373routine list 372Slabaccessing a , using the single-file scientific data set API 399description 31Stridesdescription 32support of , in the single-file scientific data set API 401Ttitle attributedescription 102UUnit attributeUnlimited dimension 21User_defined attributeallowed data types for a 90writing a 91User-defined attribute 90-??count 90index 90naming rules 90querying for a 94reading a 95Utility tagslist of 53VVaddtagrefdescription 205parameter list 206Vattachdescription 202parameter list 203Vattrinfodescription 233parameter list 233attributes of a 180creating 149description 133determining if the given , is an attribute 184determining the reference number from a , name 176multi-component field 134querying information on a given , attribute 184querying the number of attributes of a 183querying the total number of , attributes 182querying the values of a given , attribute 181resetting the current position within a 153resetting the current record position within a 154retrieving the index of a , attribute given the attribute name 183searching for a , by field name 177searching for lone , 175searching for the reference number of a 176selecting the set of , to be read 167setting the attribute of a , 181writing buffers into 155writing to a 154writing to a multifield 152Vdata APIdescription 4routine categories 135Vdata classassigning to a vdata 150description 133Vdata data modeldescription 133Vdata fielddefining 151description 134description of a predefined 151initializing for write access 151locating a , within a vdata stored in a vgroup 226querying the index of a , given the field name 180querying the number of attributes of a 183removing alignment bytes when writing to a 160setting the attribute of a , 181Vdata field namedescription 133Vdata field orderdescription 134Vdata identifierdetermining the next 239Vdata interlace modespecifying the 151Vdata nameassigning to a vdata 150description 133Vdata recorddescription 134Vdeletedescription 231parameter list 232Vdeletetagrefdescription 231parameter list 232Vdetachdescription 203parameter list 203Venddescription 203parameter list 203VF field information retrieval routine set 195VFfieldesizedescription 196VFfieldisizedescription 196VFfieldnamedescription 196VFfieldorderdescription 196VFfieldtypedescription 196Vfinddescription 220parameter list 220Vfindattrdescription 235parameter list 235Vfindclassdescription 220parameter list 220Vflocatedescription 226parameter list 227VFnfieldsdescription 196Vgetattrdescription 234parameter list 235Vgetclassdescription 219parameter list 220Vgetclassnamelenparameter list 220Vgetiddescription 218parameter list 218Vgetnamedescription 219parameter list 220Vgetnamelendescription 219parameter list 220Vgetnextdescription 239parameter list 240Vgettagrefdescription 224parameter list 225Vgettagrefsdescription 225parameter list 225Vgetversiondescription 232parameter list 233accessing a 202assigning a class to a 204assigning a name to a 204attributes of a 232containing two RIS8 objects and a vdata 198conventions on content and structure 199description 197determining the name of a 239inserting a HDF object into a 205inserting a vdata or vgroup into a 205locating a 218locating a , given the class name 220locating a field within a vdata stored in a 226locating a lone 218means of uniquely identifying a 201organization of 198querying the number of , members 239querying the total number of , attributes 233querying the values of a given , attribute 234querying the version of a given , 232retrieving the index of a , attribute given the attribute name 235retrieving the reference number of a 227retrieving the tag of a 227returning , member information 225setting the attribute of a 234sharing of vgroups and vdatas between more than one 198similarity to the Unix file system 197terminating access to 203testing whether an HDF object within a , is a vdata 226testing whether an HDF object within a , is a vgroup 225description 4routine categories 199routine list 200Vgroup API programming model 201Vgroup classdescription 198Vgroup identifier 201determining the next 239VHmakegroupdescription 205parameter list 206Vinqtagrefdescription 225parameter list 226Vinquiredescription 239parameter list 240Vinsertdescription 205parameter list 206Visvgdescription 225parameter list 226Visvsdescription 226parameter list 226Vlonedescription 218Vnattrsdescription 233parameter list 233Vnrefsdescription 226parameter list 227Vntagrefsdescription 224parameter list 225VQueryrefdescription 227parameter list 227VQuerytagdescription 227parameter list 227VS vdata information retrieval routine set 194VSattrinfodescription 184parameter list 184VSeltsdescription 195parameter list 195Vsetdescribing a heated mesh 199Vset nodedescription 199Vset tagslist of 55Vsetattrdescription 234parameter list 235Vsetclassdescription 204parameter list 206Vsetnamedescription 204parameter list 206VSfdefinedescription 151parameter list 152VSfexistdescription 177parameter list 177VSfinddescription 176parameter list 177when to use , in obtaining a vdata's reference number 138VSfindattrdescription 183parameter list 184VSfindexdescription 180parameter list 181VSfnattrsdescription 183parameter list 183VSfpackdescription 160parameter list 162VSgetattrdescription 181parameter list 182VSgetclassdescription 195parameter list 195VSgetfieldsdescription 195parameter list 195VSgetiddescription 176parameter list 177when to use , in obtaining a vdata's reference number 138VSgetinterlacedescription 195parameter list 195VSgetnamedescription 195parameter list 195vshow 443VSinquiredescription 189parameter list 190VSisattrdescription 184parameter list 184VSlonedescription 176parameter list 177VSnattrsdescription 182parameter list 183VSQuery vdata information retrieval routine set 193VSQuerycountparameter list 194VSQueryfieldsdescription 194parameter list 194VSQueryinterlacedescription 194parameter list 194VSQuerynamedescription 194parameter list 194VSQueryrefdescription 194parameter list 194VSQuerytagdescription 194parameter list 194VSQueryvsizedescription 194parameter list 194VSreaddescription 167parameter list 168setting the file interlace mode using 151VSseekdescription 168misused to append data 153VSsetattrdescription 181parameter list 182VSsetclassdescription 150parameter list 152VSsetfieldsparameter list 152VSsetinterlacedescription 152parameter list 152VSsetnamedescription 150parameter list 152VSsizeofdescription 195parameter list 195Vstartparameter list 203VSwritedescription 154parameter list 155setting the file interlace mode using 151
HDF4.2.5 - February 2010 Copyright |
The HDF Group www.hdfgroup.org ![]() |