![]() |
HDF User’s GuideVersion 4.2.7 |
[Top] |
Index
Numerics24-bit raster image 277-291compressing , data 284data representation 277determining the dimensions of a 287modifying the interlace mode of a 287querying the reference number of the most-recently-accessed 290querying the total number of , in a file 290reading a , with a given reference number 289routines for obtaining information about 290setting the interlace mode for a 283specifying that the next , read to be the first 28924-bit Raster Image APIdescription 424-bit raster image API 280routine categories 280routine list 28124-bit raster image data setcompression methods 278contents of a 277description 277interlace modes 27924-bit raster image data set dimensiondescription 2788-bit raster imagecompressing 266description 259determining the reference number of the most-recently-accessed 274determining the reference number of the palette of the most-recently-accessed 274querying the dimensions of a 271querying the total number of , in a file 273reading a , with a given reference number 273routines for obtaining information about 273specifying the next , to be read 273specifying the reference number for a 2708-bit Raster Image APIdescription 48-bit raster image API 262routine categories 262routine list 262compression methods 260description 2598-bit raster image data set dimensiondescription 2608-bit raster image data set palettedescription 260AANannlendescription 382parameter list 382ANannlistdescription 383parameter list 383ANatype2tagdescription 384parameter list 386ANcreatedescription 371parameter list 372ANcreatefdescription 371parameter list 372ANendparameter list 372ANendaccessparameter list 372ANfileinfodescription 382parameter list 382ANget_tagrefdescription 383parameter list 386ANid2tagrefdescription 384parameter list 386description 367getting the length of an , using the multifile annotation API 382obtaining a list of , corresponding to given search criteria using the multifile annotation API 383obtaining information about every , in a file using the multifile annotation API 382obtaining the number of , corresponding to given search criteria using the multifile annotation API 382selecting an , using the multifile annotation API 377writing an , using the multifile annotation API 372Annotation APIdescription 4Annotation data modeldescription 367ANnumanndescription 382parameter list 383ANreadanndescription 378parameter list 378ANselectdescription 377parameter list 378ANstartdescription 371parameter list 372ANtag2atypedescription 385parameter list 386ANtagref2iddescription 384parameter list 386ANwriteanndescription 373parameter list 373Array rank 20Attribute indexdescription 330BBlock sizesetting the , for unlimited SDS dimensions 42Buffer interlacingdescription 157CCalibrated datareading 111writing 110Color lookup tabledescription 336Command-line utilities 457-??categories of 5description 457list of 457purpose 457COMP_JPEG definedescription 278COMP_NONE definedescription 278Composite image tagslist of 509Compressing an HDF file 472Compressing RIS8 images in an HDF file 471Converting 24-bit raw raster images to RIS8 images 468Converting 8-bit raster images to the HDF format 467Converting an HDF RIS24 image to an HDF RIS8 image 471Converting floating-point data to an SDS or RIS8 object 463Converting raw palette data to the HDF palette format 469Converting several RIS8 images to one 3D SDS 470Coordinate system attributeDD24readrefparameter list 289Data elementdescription 477Data objectdescription 477Description annotationdescription 367DF*lastref routinelist and descriptions of all 405methods of determining a reference number through the use of a 404DF24addimagedescription 281parameter list 282DF24getdimsdescription 287parameter list 288DF24getimagedescription 286parameter list 288DF24lastrefdescription 290parameter list 291DF24nimagesdescription 290parameter list 290DF24putimagedescription 281parameter list 282DF24readrefdescription 289DF24reqildescription 287parameter list 288DF24restartdescription 290parameter list 290DF24setcompressdescription 284parameter list 285DF24setildescription 283parameter list 285DFANaddfdsdescription 394parameter list 394DFANaddfiddescription 394parameter list 394DFANgetdescdescription 401parameter list 402DFANgetdesclendescription 401parameter list 402DFANgetfdsdescription 399parameter list 399DFANgetfdslendescription 398parameter list 399DFANgetfiddescription 398parameter list 399DFANgetfidlendescription 398parameter list 399DFANgetlabeldescription 401parameter list 402DFANgetlablendescription 401parameter list 402DFANlablistdescription 405DFANputdescdescription 396parameter list 396DFANputlabeldescription 395parameter list 396DFPaddpaldescription 361parameter list 361DFPgetpaldescription 363parameter list 363DFPlastrefdescription 365DFPnpalsdescription 364parameter list 365DFPputpaldescription 361parameter list 361DFPreadrefdescription 364parameter list 364DFPrestartdescription 364DFPwriterefdescription 362parameter list 362DFR8addimagedescription 263parameter list 263DFR8getdimsdescription 271parameter list 272DFR8getimagedescription 270parameter list 272DFR8getpalrefdescription 274DFR8lastrefdescription 274DFR8nimagesdescription 273parameter list 274DFR8putimagedescription 263parameter list 263DFR8readrefdescription 273parameter list 273DFR8restartdescription 273DFR8setcompressdescription 266parameter list 267DFR8setpalettedescription 264parameter list 265DFR8writerefdescription 270parameter list 270DFSD scientific data set 409-??assigning string attributes to a 422assigning value attributes to a 423contents of a 409creating a 412description 409determining the number of , in a file 418obtaining reference numbers for a 419optional objects 410preventing the reassignment of , attributes 415reading 416-??reading the dimension attributes of a 430-??reading the value attributes of a 428required objects 409resetting the default interlace settings for a 415specifying the data type of a 413specifying the dimensions and data type of a 417writing 412-??writing several 414writing the dimension scale of a 430DFSD scientific data set APIroutine categories 410routine list 411use of file identifiers in the 411use of predefined attributes in the 422-??DFSD scientific data set dimensionwriting the string attributes of a 429DFSDadddatadescription 412parameter list 412DFSDcleardescription 415parameter list 416DFSDendslabdescription 419DFSDgetcaldescription 428parameter list 429DFSDgetdatadescription 416parameter list 416DFSDgetdatalendescription 426parameter list 427DFSDgetdatastrsdescription 426parameter list 427DFSDgetdimlendescription 430DFSDgetdimsdescription 417parameter list 417DFSDgetdimscaledescription 430DFSDgetdimstrsdescription 430DFSDgetfillvaluedescription 428parameter list 429DFSDgetNTdescription 417parameter list 417DFSDgetrangedescription 428parameter list 429DFSDlastrefdescription 419DFSDndatasetsdescription 418DFSDputdatadescription 412parameter list 412DFSDreadrefdescription 419parameter list 419DFSDreadslabdescription 421parameter list 422DFSDrestartdescription 418DFSDsetcaldescription 424parameter list 424DFSDsetdatastrsdescription 422parameter list 423DFSDsetdimsdescription 415parameter list 415DFSDsetdimscaledescription 430parameter list 430DFSDsetdimstrsdescription 429parameter list 430DFSDsetfillvaluedescription 424parameter list 424DFSDsetlengthsDFSDsetNTdescription 413parameter list 414DFSDsetrangedescription 424parameter list 424DFSDstartslabdescription 419parameter list 420DFSDwriterefdescription 414parameter list 414DFSDwriteslabdescription 420parameter list 421Dimension attribute 92Dimension compatbility modedetermining the current 81Dimension compatibility modedescription 80setting the future 80Dimension format attributedescription 429Dimension label attributedescription 429Dimension namedescription 21Dimension recordcreation of a 91Dimension scaledescription 22Dimension unit attributedescription 429Displaying vdata information 463dumper 458EEditing the contents of an HDF file 477Error reporting APIdescription 431returning the code of the nth-most-recent error 432returning the description of an error code 432routine list 431writing error stack information to a file 432writing errors to a console window 433External data filegetting information 55moving data to a 56reading from a 58specifying the directory search path in a 52specifying the location of the next, to be created 53External SDS arraydefinition 52Extracting 8-bit raster images and palettes from HDF files 469Extracting palette data from an HDF file 470FField datapacking or unpacking 167File annotationcomparison with object annotation 368description 368File attributedescription 92File description annotationassigning a , using the single-file annotation API 394reading a , using the single-file annotation API 398File interlacingdescription 157File label annotationassigning a , using the single-file annotation API 394reading a 378reading a , using the single-file annotation API 398fill modedescription 108fill valuedescription 108description 103fill value attributereading a 109writing a 109FILL_ATTR definedescription 326Format attributedescription 103, 423fptohdf 463Gaccessing 298compressing 310creating a , in an external file 311getting the index of a 320I/O access type 310obtaining information about a 320reading 313setting the interlace mode for a , or image read 313terminating access to 299General raster image APIchunking 347description 4external file operations using the 311obtaining a palette identifier using the 336obtaining information about the contents of a file using , routines 319obtaining palette information using the 337reading palette data using the 339routine list 296writing palette data using the 338General raster image arraydescription 294General raster image array namedescription 294predefined 326querying user-defined 330reading user-defined 331setting user-defined 327General raster image attributesdescription 295General raster image data setoptional objects 295required objects 294General raster image data set API 295programming model 297routine categories 295General raster image indexdescription 294General raster image palettesdescription 295General raster image pixel typedata type 294description 294General raster image reference numberdescription 294General raster image tagslist of 508Global attributedescription 92GRattrinfodescription 330parameter list 332GRcreatedescription 298parameter list 300GRenddescription 299parameter list 300GRendaccessdescription 299parameter list 300GRfileinfodescription 319parameter list 320GRfindattrdescription 330parameter list 332GRgetattrdescription 331parameter list 332GRgetchunkinfodescription 356parameter list 358GRgetiminfoparameter list 320GRgetlutiddescription 336parameter list 340GRgetlutinfodescription 337GRidtorefdescription 320GRluttorefdescription 337parameter list 337GRnametoindexparameter list 323Group objectdescription 477GRreadchunkGRreadimagedescription 313parameter list 314GRreadlutdescription 339parameter list 340GRreftoindexdescription 321parameter list 323GRreqimageilparameter list 314GRrequtildescription 338GRselectdescription 298parameter list 300GRsetaccesstypeparameter list 311GRsetaccestypedescription 310GRsetattrdescription 327parameter list 332GRsetchunkdescription 348parameter list 358GRsetchunkcachedescription 357parameter list 358GRsetcompressdescription 310parameter list 311GRsetexternalfiledescription 311parameter list 312GRstartdescription 298parameter list 300GRwriteimagedescription 300parameter list 302GRwritelutdescription 338parameter list 340HHDFdescription 1HDF APIHDF dumper 458HDF installation overview 511-??HDF_CHUNK_DEF uniondefinition of 115hdf24hdf8 471hdfcomp 471hdfed 477annotate command 483close command 485delete command 483display command 484dump command 482getr8 command 486help command 480if conditional 486info command 480next command 482open command 480prev command 481put command 486putr8 command 485revert command 486wait command 486write command 484hdfed command set 479hdfls 475hdfpack 472hdftopal 470hdftor8 469hdiff 462hdp 458command set 458dumprig command 461dumpsds command 459dumpvd command 460dumpvg command 461list command 459HEcleardescription 433HEprintdescription 432HEstringdescription 432HEvaluedescription 432Hishdf/hishdff 13history attributedescription 104HXsetcreatedirdescription 53HXsetdir and HXsetcreatedirparameter list 54II/O access typesetting the 43IMCOMP compressiondescription 261interlace mode 157JJPEG compressionJPEG compression quality factordescription 261LLabel annotationdescription 367Label attributeListing basic information about an HDF file 475Local attributedescription 92Lone vdatadescription 182Lone vgroupdescription 231Low-level interface 2MMFGR_INTERLACE_LINE definedescription 298MFGR_INTERLACE_PIXEL defineMFGR_INTERLACE_PLANE definedescription 298missing_value attributedescription 104description of the 369list of tags used in 393programming model for the 370routine categories 369routine list 370type definitions specific to the 370NNative format option 14netCDF data modelHDF support of 132Not-a-Number 108OObject annotationcomparison with file annotation 368description 368Object description annotationassigning a , using the single-file annotation API 396reading a , using the single-file annotation API 401Object label annotationassigning a , using the single-file annotation API 395reading a , using the single-file annotation API 400Obsolete tagslist of 510Old and new dimension implementation 80PPacking or unpacking field data 167adding to a RIS8 object 264backward compatibility issues 365color mapping using a 359description 359obtaining the reference number of the most recently accessed 365querying the number of , in a file 364reading a , with a given reference number 364retrieving the reference number of the specified 337specifying the next palette to be accessed to be the first 364specifying the reference number of a 362Palette APIroutine categories 360routine list 360paltohdf 469Performance Issues 437-??Pixel interlacingdescription 279Pixelsdescription 259accessing a 104list of , with labels and descriptions 104list of parameters 105naming conventions for 104Predefined dimension string attributetypes of 429Predefined string attributetypes of 423Rr24hdf8 468r8tohdf 467Range attributedescription 103reading a 108writing a 107Range attributes 107Raster image idsee Raster image identifier 294Raw data informationRecord variabledetermining whether an SDS is a 42Reference numberchecking before assigning an object annotation 403determining 403determining the , for the last object accessed 404querying a list of , for a given tag 405Reference number, overwriting data for a specified 414RGB valuesdescription 277ristosds 470RLE compressiondescription 261SScan-line interlacingdescription 279Scan-plane interlacingdescription 279Scientific data set tagslist of 509SD scientific data modelannotations and the 22appending data to a 41chunked 115chunked , obtaining information about a 121chunked , reading data from a 120chunked , writing to a 118chunks , setting the maximum number to cache 117compressing data in a 47contents of a 19data type 20default data representation 14dimension scales for more than one , 91establishing access to a 26locating a , by reference number 73making a chunked , from a generic 115optional objects 21reading from a 58required objects 20string attributes of dimensions 106terminating access to a 28writing to a 31SD scientific data set APIcompression methods supported 47description 4, 22routine categories 22routine list 24SD scientific data set arraydescription 20distinguishing from a coordinate variable 88SD scientific data set array namedescription 20SD scientific data set attribute 92SD scientific data set dimensiondescription 20naming a 79obtaining information about a 82selecting a 78SD scientific data set dimension indexdescription 21SD scientific data set dimension scalesdescription 81writing 81SD scientific data set dimension string attributereading a 107writing a 106SD scientific data set string attributedescription 105reading a 105writing a 105SD scientific data setsrelated , definition 91SDattrinfodescription 96parameter list 98SDdiminfodescription 82SDenddescription 29parameter list 29SDendaccessdescription 28parameter list 29SDexternalfiledescription 54SDfileinfoSDfindattrdescription 96parameter list 98SDget_numopenfilesdescription 113SDgetcaldescription 111parameter list 111SDgetChunkInfodescription 121SDgetdatastrsdescription 105parameter list 106SDgetdimiddescription 79parameter list 80SDgetdimstrsdescription 107parameter list 107SDgetexternalfileSDgetfillvaluedescription 109parameter list 110SDgetinfoSDgetrangedescription 108parameter list 108SDidtorefdescription 73SDiscoordvardescription 88SDisrecorddescription 42SDnametoindexparameter list 73SDreadattrdescription 97parameter list 98SDreadChunkdescription 120parameter list 121SDreaddatadescription 58parameter list 59SDreftoindexdescription 73parameter list 73SDS idsee SD scientific data set identifier 20SDselectparameter list 29SDsetaccesstypedescription 43parameter list 43SDsetattrdescription 93parameter list 98SDsetblocksizedescription 42parameter list 43SDsetcaldescription 110parameter list 111SDsetChunkdescription 115SDsetChunkCachedescription 117parameter list 118SDsetcompressdescription 47SDsetdatastrsdescription 105SDsetdimnamedescription 79parameter list 80SDsetdimstrsparameter list 107SDsetdimval_bwcompdescription 81parameter list 81SDsetdimval_compdescription 80SDsetexternalfileparameter list 56SDsetfillmodeparameter list 110SDsetfillvaluedescription 109parameter list 110SDsetnbitdatasetSDsetrangedescription 107parameter list 108SDstartdescription 27SDwriteChunkparameter list 120SDwritechunkdescription 119SDwritedatadescription 31parameter list 33writing data to chunked SDSs using 118Self-descriptiondefinition 1sfgcfilldescription of 109sfgfilldescription of 109sfrcattdescription of 97sfrnattdescription of 97sfwcdatadescription of 33sfwdatadescription of 33Single-file Annotation APIroutine categories 391list of tags used in 393programming model for the 393routine list 392Slabaccessing a , using the single-file scientific data set API 419description 32Stridesdescription 32support of , in the single-file scientific data set API 421Ttitle attributedescription 104UUnit attributedescription 103, 423Unlimited dimension 21User_defined attributeallowed data types for a 92writing a 93User-defined attribute 92-??naming rules 92querying for a 96reading a 97Utility tagslist of 508VVaddtagrefdescription 218parameter list 219Vattachdescription 215parameter list 216Vattrinfodescription 251parameter list 252Vdata ??-207attributes of a 190creating 155description 137determining if the given , is an attribute 194determining the reference number from a , name 183multi-component field 138querying information on a given , attribute 193querying the number of attributes of a 192querying the total number of , attributes 192querying the values of a given , attribute 191resetting the current position within a 160resetting the current record position within a 161retrieving the index of a , attribute given the attribute name 193searching for a , by field name 184searching for lone , 182searching for the reference number of a 183selecting the set of , to be read 174setting the attribute of a , 191writing buffers into 162writing to a 161writing to a multifield 159Vdata APIdescription 4routine categories 139Vdata classassigning to a vdata 156description 137Vdata data modeldescription 137Vdata fielddefining 156description 138description of a predefined 156initializing for write access 157locating a , within a vdata stored in a vgroup 242querying the index of a , given the field name 190querying the number of attributes of a 192removing alignment bytes when writing to a 168setting the attribute of a , 191Vdata field namedescription 137Vdata field orderdescription 138Vdata identifierdetermining the next 257Vdata interlace modespecifying the 157Vdata nameassigning to a vdata 156description 137Vdata recorddescription 138Vdeletedescription 247parameter list 248Vdeletetagrefdescription 247parameter list 248Vdetachdescription 216parameter list 216Venddescription 216parameter list 216VF field information retrieval routine set 206VFfieldesizedescription 206VFfieldisizedescription 207VFfieldnamedescription 206VFfieldorderdescription 207VFfieldtypedescription 207Vfinddescription 235parameter list 236Vfindattrdescription 249parameter list 250Vfindclassdescription 235parameter list 236Vflocatedescription 242parameter list 243VFnfieldsdescription 207Vgetattrdescription 252parameter list 253Vgetclassdescription 234parameter list 235Vgetclassnamelenparameter list 235Vgetiddescription 231parameter list 234Vgetnamedescription 234parameter list 235Vgetnamelenparameter list 235Vgetnextdescription 257parameter list 258Vgettagrefdescription 240parameter list 241Vgettagrefsdescription 240parameter list 241Vgetversiondescription 248Vgroup ??-258accessing a 215assigning a class to a 217assigning a name to a 217attributes of a 248containing two RIS8 objects and a vdata 210conventions on content and structure 211description 209determining the name of a 257inserting a HDF object into a 218inserting a vdata or vgroup into a 218locating a 231locating a , given the class name 235locating a field within a vdata stored in a 242locating a lone 231means of uniquely identifying a 214organization of 210querying the number of , members 257querying the total number of , attributes 250querying the version of a given , 248retrieving the index of a , attribute given the attribute name 249retrieving the reference number of a 243retrieving the tag of a 243returning , member information 241setting the attribute of a 249sharing of vgroups and vdatas between more than one 210similarity to the Unix file system 209terminating access to 216testing whether an HDF object within a , is a vdata 241testing whether an HDF object within a , is a vgroup 241description 4routine categories 211routine list 213Vgroup API programming model 214Vgroup classdescription 210Vgroup identifier 214determining the next 257VHmakegroupdescription 219parameter list 219Vinqtagrefdescription 241parameter list 242Vinquiredescription 257parameter list 258Vinsertdescription 218parameter list 219Visvgdescription 241parameter list 242Visvsdescription 241parameter list 242Vlonedescription 231Vnattrsdescription 250Vnrefsdescription 242parameter list 243Vntagrefsdescription 239parameter list 241VQueryrefdescription 243parameter list 243VQuerytagdescription 243parameter list 243VS vdata information retrieval routine set 205VSattrinfodescription 193parameter list 194VSeltsdescription 205parameter list 206Vsetdescribing a heated mesh 211Vset nodedescription 211Vset tagslist of 510Vsetattrdescription 249parameter list 250Vsetclassdescription 218parameter list 219Vsetnamedescription 217parameter list 219VSfdefinedescription 156parameter list 159VSfexistdescription 184parameter list 184VSfinddescription 183parameter list 184when to use , in obtaining a vdata's reference number 143VSfindattrdescription 193parameter list 194VSfindexdescription 190parameter list 191VSfnattrsdescription 192parameter list 193VSfpackdescription 167parameter list 169VSgetattrdescription 191parameter list 192VSgetclassdescription 206parameter list 206VSgetfieldsdescription 205parameter list 206VSgetiddescription 183parameter list 184when to use , in obtaining a vdata's reference number 143VSgetinterlacedescription 205parameter list 206VSgetnamedescription 206parameter list 206vshow 463VSinquiredescription 199parameter list 200VSisattrdescription 194parameter list 194VSlonedescription 183parameter list 184VSnattrsdescription 192parameter list 193VSQuery vdata information retrieval routine set 204VSQuerycountparameter list 205VSQueryfieldsdescription 204parameter list 205VSQueryinterlacedescription 204parameter list 205VSQuerynamedescription 204parameter list 205VSQueryrefdescription 204parameter list 205VSQuerytagdescription 204parameter list 205VSQueryvsizedescription 204parameter list 205VSreaddescription 174parameter list 175setting the file interlace mode using 157VSseekdescription 175misused to append data 160VSsetattrdescription 191parameter list 192VSsetclassdescription 156parameter list 159VSsetfieldsparameter list 159VSsetinterlacedescription 157parameter list 159VSsetnamedescription 156parameter list 159VSsizeofdescription 205parameter list 206Vstartparameter list 216VSwritedescription 161parameter list 163setting the file interlace mode using 157
HDF 4.2.7 - February 2012 Copyright |
The HDF Group www.hdfgroup.org ![]() |