![]() |
HDF User’s GuideVersion 4.2r4 |
[Top] |
Index
Numericscompressing , data 264data representation 257determining the dimensions of a 267modifying the interlace mode of a 267querying the reference number of the most-recently-accessed 270querying the total number of , in a file 270reading a , with a given reference number 269routines for obtaining information about 270setting the interlace mode for a 263specifying that the next , read to be the first 26924-bit Raster Image APIdescription 424-bit raster image API 260routine categories 260routine list 26124-bit raster image data setcompression methods 258contents of a 257description 257interlace modes 25924-bit raster image data set dimensiondescription 2588-bit raster imagecompressing 246description 239determining the reference number of the most-recently-accessed 254determining the reference number of the palette of the most-recently-accessed 254querying the dimensions of a 251querying the total number of , in a file 253reading a , with a given reference number 253routines for obtaining information about 253specifying the next , to be read 253specifying the reference number for a 2508-bit Raster Image APIdescription 48-bit raster image API 242routine categories 242routine list 242compression methods 240description 2398-bit raster image data set dimensiondescription 2408-bit raster image data set palettedescription 240AANannlendescription 359parameter list 360ANannlistdescription 360parameter list 361ANatype2tagdescription 362parameter list 363ANcreatedescription 349parameter list 349ANcreatefdescription 349parameter list 349ANendparameter list 349ANendaccessparameter list 349ANfileinfodescription 359parameter list 360ANget_tagrefdescription 361parameter list 363ANid2tagrefdescription 361parameter list 363description 345getting the length of an , using the multifile annotation API 359obtaining a list of , corresponding to given search criteria using the multifile annotation API 360obtaining information about every , in a file using the multifile annotation API 359obtaining the number of , corresponding to given search criteria using the multifile annotation API 360selecting an , using the multifile annotation API 355writing an , using the multifile annotation API 350Annotation APIdescription 4Annotation data modeldescription 345ANnumanndescription 360parameter list 361ANreadanndescription 355parameter list 356ANselectdescription 355parameter list 356ANstartdescription 349parameter list 349ANtag2atypedescription 362parameter list 363ANtagref2iddescription 362parameter list 363ANwriteanndescription 350parameter list 350Array rank 20Attribute indexdescription 309BBlock sizesetting the , for unlimited SDS dimensions 42Buffer interlacingdescription 151CCalibrated datareading 109writing 108Color lookup tabledescription 314Command-line utilities 433categories of 5description 433list of 433purpose 433COMP_JPEG definedescription 258COMP_NONE definedescription 258Composite image tagslist of 54Compressing an HDF file 448Compressing RIS8 images in an HDF file 447Converting 24-bit raw raster images to RIS8 images 444Converting 8-bit raster images to the HDF format 443Converting an HDF RIS24 image to an HDF RIS8 image 447Converting floating-point data to an SDS or RIS8 object 439Converting raw palette data to the HDF palette format 445Converting several RIS8 images to one 3D SDS 446Coordinate system attributeDD24readrefparameter list 269Data elementdescription 453Data objectdescription 453Description annotationdescription 345DF*lastref routinelist and descriptions of all 382methods of determining a reference number through the use of a 381DF24addimagedescription 261parameter list 262DF24getdimsdescription 267parameter list 268DF24getimagedescription 266parameter list 268DF24lastrefdescription 270parameter list 271DF24nimagesdescription 270parameter list 270DF24putimagedescription 261parameter list 262DF24readrefdescription 269DF24reqildescription 267parameter list 268DF24restartdescription 270parameter list 270DF24setcompressdescription 264parameter list 265DF24setildescription 263parameter list 265DFANaddfdsdescription 371parameter list 372DFANaddfiddescription 371parameter list 372DFANgetdescdescription 379parameter list 379DFANgetdesclendescription 379parameter list 379DFANgetfdsdescription 376parameter list 377DFANgetfdslendescription 376parameter list 377DFANgetfiddescription 376parameter list 377DFANgetfidlendescription 375parameter list 377DFANgetlabeldescription 378parameter list 379DFANgetlablendescription 378parameter list 379DFANlablistdescription 382DFANputdescdescription 373parameter list 373DFANputlabeldescription 373parameter list 373DFPaddpaldescription 338parameter list 339DFPgetpaldescription 341parameter list 341DFPlastrefdescription 343DFPnpalsdescription 342parameter list 343DFPputpaldescription 338parameter list 339DFPreadrefdescription 342parameter list 342DFPrestartdescription 342DFPwriterefdescription 340parameter list 340DFR8addimagedescription 243parameter list 243DFR8getdimsdescription 251parameter list 252DFR8getimagedescription 250parameter list 252DFR8getpalrefdescription 254DFR8lastrefdescription 254DFR8nimagesdescription 253parameter list 254DFR8putimagedescription 243parameter list 243DFR8readrefdescription 253parameter list 253DFR8restartdescription 253DFR8setcompressdescription 246parameter list 247DFR8setpalettedescription 244parameter list 245DFR8writerefdescription 250parameter list 250DFSD scientific data set 385assigning string attributes to a 399assigning value attributes to a 399contents of a 385creating a 388description 385determining the number of , in a file 394obtaining reference numbers for a 395optional objects 386preventing the reassignment of , attributes 391reading 392reading the dimension attributes of a 406reading the value attributes of a 404required objects 385resetting the default interlace settings for a 391specifying the data type of a 389specifying the dimensions and data type of a 393writing 388writing several 390writing the dimension scale of a 406DFSD scientific data set APIroutine categories 386routine list 387use of file identifiers in the 387use of predefined attributes in the 398DFSD scientific data set dimensionwriting the string attributes of a 405DFSDadddatadescription 388parameter list 388DFSDcleardescription 391parameter list 392DFSDendslabdescription 395DFSDgetcaldescription 404parameter list 405DFSDgetdatadescription 392parameter list 392DFSDgetdatalendescription 402parameter list 403DFSDgetdatastrsdescription 402parameter list 403DFSDgetdimlendescription 406DFSDgetdimsdescription 393parameter list 393DFSDgetdimscaledescription 406DFSDgetdimstrsdescription 406DFSDgetfillvaluedescription 404parameter list 405DFSDgetNTdescription 393parameter list 393DFSDgetrangedescription 404parameter list 405DFSDlastrefdescription 395DFSDndatasetsdescription 394DFSDputdatadescription 388parameter list 388DFSDreadrefdescription 395parameter list 395DFSDreadslabdescription 397parameter list 398DFSDrestartdescription 394DFSDsetcaldescription 400parameter list 400DFSDsetdatastrsdescription 399parameter list 399DFSDsetdimsdescription 391parameter list 391DFSDsetdimscaledescription 406parameter list 406DFSDsetdimstrsdescription 405parameter list 406DFSDsetfillvaluedescription 400parameter list 400DFSDsetlengthsDFSDsetNTdescription 389parameter list 390DFSDsetrangedescription 400parameter list 400DFSDstartslabdescription 395parameter list 396DFSDwriterefdescription 390parameter list 390DFSDwriteslabdescription 396parameter list 397Dimension attribute 90Dimension compatbility modedetermining the current 79Dimension compatibility modedescription 78setting the future 78Dimension format attributedescription 405Dimension label attributedescription 405Dimension namedescription 21Dimension recordcreation of a 89Dimension scaledescription 22Dimension unit attributedescription 405Displaying vdata information 439dumper 434EEditing the contents of an HDF file 453Error reporting APIdescription 407returning the code of the nth-most-recent error 408returning the description of an error code 408routine list 407writing error stack information to a file 408writing errors to a console window 409External data filedefinition 51moving data to a 54reading from a 56specifying the directory search path in a 52specifying the location of the next, to be created 52writing to a 51External SDS arraydefinition 51Extracting 8-bit raster images and palettes from HDF files 445Extracting palette data from an HDF file 446FField datapacking or unpacking 160File annotationcomparison with object annotation 346description 346File attributedescription 90File description annotationassigning a , using the single-file annotation API 371reading a , using the single-file annotation API 376File interlacingdescription 151File label annotationassigning a , using the single-file annotation API 371reading a 355reading a , using the single-file annotation API 375fill modedescription 106fill valuedescription 106description 101fill value attributereading a 107writing a 107FILL_ATTR definedescription 305Format attributefptohdf 439Gaccessing 278compressing 289creating a , in an external file 290getting the index of a 299obtaining information about a 299reading 292setting the interlace mode for a , or image read 292terminating access to 279General raster image APIchunking 324description 4external file operations using the 290obtaining a palette identifier using the 314obtaining information about the contents of a file using , routines 298obtaining palette information using the 315reading palette data using the 317routine list 276writing palette data using the 316General raster image arraydescription 274General raster image array namedescription 274predefined 305querying user-defined 309reading user-defined 309setting user-defined 305General raster image attributesdescription 275General raster image data setoptional objects 275General raster image data set API 275programming model 277routine categories 275General raster image indexdescription 274General raster image palettesdescription 275General raster image pixel typedata type 274description 274General raster image reference numberdescription 274General raster image tagslist of 53Global attributedescription 90GRattrinfodescription 309parameter list 310GRcreatedescription 278parameter list 279GRenddescription 279parameter list 279GRendaccessdescription 279parameter list 279GRfileinfodescription 298parameter list 299GRfindattrdescription 309parameter list 310GRgetattrdescription 309parameter list 310GRgetchunkinfodescription 333parameter list 335GRgetiminfoparameter list 299GRgetlutiddescription 314parameter list 317GRgetlutinfodescription 315GRidtorefdescription 299GRluttorefdescription 315parameter list 315GRnametoindexparameter list 301Group objectdescription 453GRreadchunkGRreadimagedescription 292parameter list 293GRreadlutdescription 317parameter list 317GRreftoindexdescription 300parameter list 301GRreqimageilparameter list 293GRrequtildescription 316GRselectdescription 278parameter list 279GRsetattrdescription 305parameter list 310GRsetchunkdescription 325parameter list 335GRsetchunkcachedescription 334parameter list 335GRsetcompressdescription 289parameter list 290GRsetexternalfiledescription 290parameter list 291GRstartdescription 278parameter list 279GRwriteimagedescription 280parameter list 281GRwritelutdescription 316parameter list 317HHDFdescription 1HDF APIHDF dumper 434HDF installation overview 56HDF_CHUNK_DEF uniondefinition of 113hdf24hdf8 447hdfcomp 447hdfed 453annotate command 459close command 461delete command 459display command 460dump command 458getr8 command 462help command 456if conditional 462info command 456next command 458open command 456prev command 457put command 462putr8 command 461revert command 462wait command 462write command 460hdfed command set 455hdfls 451hdfpack 448hdftopal 446hdftor8 445hdiff 438hdp 434command set 434dumprig command 437dumpsds command 435dumpvd command 436dumpvg command 437list command 435HEcleardescription 409HEprintdescription 408HEstringdescription 408HEvaluedescription 408Hishdf/hishdff 13history attributedescription 102HXsetcreatedirdescription 52HXsetdir and HXsetcreatedirparameter list 53IIMCOMP compressiondescription 241interlace mode 152JJPEG compressionJPEG compression quality factordescription 241LLabel annotationdescription 345Label attributeListing basic information about an HDF file 451Local attributedescription 90Lone vdatadescription 175Lone vgroupdescription 217Low-level interface 2MMFGR_INTERLACE_LINE definedescription 278MFGR_INTERLACE_PIXEL defineMFGR_INTERLACE_PLANE definedescription 278missing_value attributedescription 102description of the 347list of tags used in 370programming model for the 348routine categories 347routine list 347type definitions specific to the 348NNative format option 14netCDF data modelHDF support of 130Not-a-Number 106OObject annotationcomparison with file annotation 346description 346Object description annotationassigning a , using the single-file annotation API 373reading a , using the single-file annotation API 379Object label annotationassigning a , using the single-file annotation API 373reading a , using the single-file annotation API 378Obsolete tagslist of 55Old and new dimension implementation 78PPacking or unpacking field data 160adding to a RIS8 object 244backward compatibility issues 343color mapping using a 337description 337obtaining the reference number of the most recently accessed 343querying the number of , in a file 342reading a , with a given reference number 342retrieving the reference number of the specified 315specifying the next palette to be accessed to be the first 342specifying the reference number of a 340Palette APIroutine categories 338routine list 338paltohdf 445Performance Issues 413Pixel interlacingdescription 259Pixelsdescription 239accessing a 102list of , with labels and descriptions 102list of parameters 103naming conventions for 102Predefined dimension string attributetypes of 405Predefined string attributetypes of 399Rr24hdf8 444r8tohdf 443Range attributedescription 101reading a 106writing a 105Range attributes 105Raster image idsee Raster image identifier 274Record variabledetermining whether an SDS is a 42Reference numberchecking before assigning an object annotation 381determining 381determining the , for the last object accessed 381querying a list of , for a given tag 382Reference number, overwriting data for a specified 390RGB valuesdescription 257ristosds 446RLE compressiondescription 241SScan-line interlacingdescription 259Scan-plane interlacingdescription 259Scientific 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 56required 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 76SD scientific data set dimension indexdescription 21SD scientific data set dimension scalesdescription 79writing 79SD 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 53SDfileinfoSDfindattrdescription 94parameter list 96SDget_numopenfilesdescription 111SDgetcaldescription 109parameter list 109SDgetChunkInfodescription 118SDgetdatastrsdescription 103parameter list 104SDgetdimiddescription 77parameter list 78SDgetdimstrsdescription 104parameter list 105SDgetfillvaluedescription 107parameter list 108SDgetinfoSDgetrangedescription 106parameter list 106SDidtorefdescription 71SDiscoordvardescription 86SDisrecorddescription 42SDnametoindexparameter list 71SDreadattrdescription 95parameter list 96SDreadChunkdescription 118parameter list 118SDreaddatadescription 57parameter list 57SDreftoindexdescription 71parameter list 71SDS idsee SD scientific data set identifier 20SDselectparameter list 29SDsetattrdescription 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 54SDsetfillmodeparameter 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 369list of tags used in 370programming model for the 371routine list 369Slabaccessing a , using the single-file scientific data set API 395description 31Stridesdescription 32support of , in the single-file scientific data set API 397Ttitle attributedescription 102UUnit attributeUnlimited dimension 21User_defined attributeallowed data types for a 90writing a 91User-defined attribute 90count 90index 90naming rules 90querying for a 94reading a 95Utility tagslist of 53VVaddtagrefdescription 205parameter list 205Vattachdescription 202parameter list 203Vattrinfodescription 231parameter list 232attributes 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 153Vdata 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 225querying the index of a , given the field name 180querying the number of attributes of a 183removing alignment bytes when writing to a 161setting the attribute of a , 181Vdata field namedescription 133Vdata field orderdescription 134Vdata identifierdetermining the next 238Vdata interlace modespecifying the 151Vdata nameassigning to a vdata 150description 133Vdata recorddescription 134Vdeletedescription 230parameter list 230Vdeletetagrefdescription 230parameter list 230Vdetachdescription 203parameter list 203Venddescription 203parameter list 203VF field information retrieval routine set 195VFfieldesizedescription 196VFfieldisizedescription 196VFfieldnamedescription 196VFfieldorderdescription 196VFfieldtypedescription 196Vfinddescription 219parameter list 219Vfindattrdescription 233parameter list 234Vfindclassdescription 219parameter list 219Vflocatedescription 225parameter list 225VFnfieldsdescription 196Vgetattrdescription 233parameter list 234Vgetclassdescription 218parameter list 218Vgetiddescription 217parameter list 218Vgetnamedescription 218parameter list 218Vgetnextdescription 238parameter list 238Vgettagrefdescription 223parameter list 224Vgettagrefsdescription 223parameter list 224Vgetversiondescription 231parameter list 232accessing a 202assigning a class to a 204assigning a name to a 204attributes of a 231containing two RIS8 objects and a vdata 198conventions on content and structure 199description 197determining the name of a 238inserting a HDF object into a 205inserting a vdata or vgroup into a 205locating a 217locating a , given the class name 219locating a field within a vdata stored in a 225locating a lone 217means of uniquely identifying a 201organization of 198querying the number of , members 238querying the total number of , attributes 232querying the values of a given , attribute 233querying the version of a given , 231retrieving the index of a , attribute given the attribute name 233retrieving the reference number of a 226retrieving the tag of a 226returning , member information 224returning the tag/reference number pairs of , contents 223setting the attribute of a 232sharing 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 224testing whether an HDF object within a , is a vgroup 224description 4obsolete routines 238routine categories 199routine list 200Vgroup API programming model 201Vgroup classdescription 198Vgroup identifier 201determining the next 238Vinqtagrefdescription 224parameter list 225Vinquiredescription 238parameter list 238Vinsertdescription 205parameter list 205Visvgdescription 224parameter list 225Visvsdescription 224parameter list 225Vlonedescription 217Vnattrsdescription 232parameter list 232Vnrefsdescription 225parameter list 225Vntagrefsdescription 223parameter list 224VQueryrefdescription 226parameter list 226VQuerytagdescription 226parameter list 226VS vdata information retrieval routine set 194VSattrinfodescription 184parameter list 184VSeltsdescription 195parameter list 195Vsetdescribing a heated mesh 199Vset nodedescription 199Vset tagslist of 55Vsetattrdescription 232parameter list 234Vsetclassdescription 204parameter list 205Vsetnamedescription 204parameter list 205VSfdefinedescription 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 439VSinquiredescription 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 152VSseekdescription 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 152
HDF4.2r4 - February 2009 Copyright |
The HDF Group www.hdfgroup.org ![]() |