![]() |
HDF User’s GuideVersion 4.2.6 |
[Top] |
Index
Numericscompressing , data 346data representation 339determining the dimensions of a 348modifying the interlace mode of a 349querying the reference number of the most-recently-accessed 351querying the total number of , in a file 351reading a , with a given reference number 350routines for obtaining information about 351setting the interlace mode for a 344specifying that the next , read to be the first 35124-bit Raster Image APIdescription 424-bit raster image API 342routine categories 342routine list 34224-bit raster image data setcompression methods 340contents of a 339description 339interlace modes 34124-bit raster image data set dimensiondescription 3408-bit raster imagecompressing 264description 257determining the reference number of the most-recently-accessed 271determining the reference number of the palette of the most-recently-accessed 271querying the dimensions of a 269querying the total number of , in a file 271reading a , with a given reference number 270routines for obtaining information about 271specifying the next , to be read 271specifying the reference number for a 2678-bit Raster Image APIdescription 48-bit raster image API 260routine categories 260routine list 260compression methods 258description 257optional objects 258-2598-bit raster image data set data model 257-2598-bit raster image data set dimensiondescription 2588-bit raster image data set palettedescription 258AANannlendescription 378parameter list 378ANannlistdescription 379parameter list 379ANatype2tagdescription 380parameter list 381ANcreatedescription 367parameter list 368ANcreatefdescription 367parameter list 368ANendparameter list 368ANendaccessparameter list 368ANfileinfodescription 377parameter list 378ANget_tagrefdescription 379parameter list 381ANid2tagrefdescription 380parameter list 381description 363getting the length of an , using the multifile annotation API 378obtaining a list of , corresponding to given search criteria using the multifile annotation API 378obtaining information about every , in a file using the multifile annotation API 377obtaining the number of , corresponding to given search criteria using the multifile annotation API 378selecting an , using the multifile annotation API 373writing an , using the multifile annotation API 368Annotation APIdescription 4Annotation data modeldescription 363ANnumanndescription 378parameter list 379ANreadanndescription 374parameter list 374ANselectdescription 373parameter list 374ANstartdescription 367parameter list 368ANtag2atypedescription 381parameter list 381ANtagref2iddescription 380parameter list 381ANwriteanndescription 369parameter list 369Array rank 21Attribute indexdescription 311BBlock sizesetting the , for unlimited SDS dimensions 42Buffer interlacingdescription 157CCalibrated datareading 108writing 108Color lookup tabledescription 317Command-line utilities 453-??categories of 5description 453list of 453purpose 453COMP_JPEG definedescription 340COMP_NONE definedescription 340Composite image tagslist of 505Compressing an HDF file 468Compressing RIS8 images in an HDF file 467Converting 24-bit raw raster images to RIS8 images 464Converting 8-bit raster images to the HDF format 463Converting an HDF RIS24 image to an HDF RIS8 image 467Converting floating-point data to an SDS or RIS8 object 459Converting raw palette data to the HDF palette format 465Converting several RIS8 images to one 3D SDS 466Coordinate system attributeDD24readrefparameter list 351Data elementdescription 473Data objectdescription 473Description annotationdescription 363DF*lastref routinelist and descriptions of all 400methods of determining a reference number through the use of a 399DF24addimagedescription 343parameter list 343DF24getdimsdescription 348parameter list 349DF24getimagedescription 348parameter list 349DF24lastrefdescription 352parameter list 352DF24nimagesdescription 351parameter list 351DF24putimagedescription 343parameter list 343DF24readrefdescription 350DF24reqildescription 349parameter list 349DF24restartdescription 351parameter list 351DF24setcompressdescription 346parameter list 346DF24setildescription 344parameter list 346DFANaddfdsdescription 390parameter list 390DFANaddfiddescription 389parameter list 390DFANgetdescdescription 397parameter list 397DFANgetdesclendescription 397parameter list 397DFANgetfdsdescription 395parameter list 395DFANgetfdslendescription 394parameter list 395DFANgetfiddescription 394parameter list 395DFANgetfidlendescription 394parameter list 395DFANgetlabeldescription 396parameter list 397DFANgetlablendescription 396parameter list 397DFANlablistdescription 400DFANputdescdescription 391parameter list 392DFANputlabeldescription 391parameter list 392DFPaddpaldescription 357parameter list 357DFPgetpaldescription 359parameter list 359DFPlastrefdescription 361DFPnpalsdescription 360parameter list 361DFPputpaldescription 357parameter list 357DFPreadrefdescription 360parameter list 360DFPrestartdescription 360DFPwriterefdescription 358parameter list 358DFR8addimagedescription 261parameter list 261DFR8getdimsdescription 269parameter list 269DFR8getimagedescription 268parameter list 269DFR8getpalrefdescription 272DFR8lastrefdescription 271DFR8nimagesdescription 271DFR8putimagedescription 261parameter list 261DFR8readrefdescription 270parameter list 270DFR8restartdescription 271DFR8setcompressdescription 264parameter list 264DFR8setpalettedescription 262parameter list 263DFR8writerefdescription 267parameter list 268DFSD scientific data set 405-??assigning string attributes to a 419assigning value attributes to a 419contents of a 405creating a 408description 405determining the number of , in a file 414obtaining reference numbers for a 415optional objects 406preventing the reassignment of , attributes 411reading 412-??reading the dimension attributes of a 426-??reading the value attributes of a 424required objects 405resetting the default interlace settings for a 411specifying the data type of a 409specifying the dimensions and data type of a 413writing 408-??writing several 410writing the dimension scale of a 426DFSD scientific data set APIroutine categories 406routine list 407use of file identifiers in the 407use of predefined attributes in the 418-??DFSD scientific data set dimensionwriting the string attributes of a 425DFSDadddatadescription 408parameter list 408DFSDcleardescription 411parameter list 412DFSDendslabdescription 415DFSDgetcaldescription 424parameter list 425DFSDgetdatadescription 412parameter list 412DFSDgetdatalendescription 422parameter list 423DFSDgetdatastrsdescription 422parameter list 423DFSDgetdimlendescription 426DFSDgetdimsdescription 413parameter list 413DFSDgetdimscaledescription 426DFSDgetdimstrsdescription 426DFSDgetfillvaluedescription 424parameter list 425DFSDgetNTdescription 413parameter list 413DFSDgetrangedescription 424parameter list 425DFSDlastrefdescription 415DFSDndatasetsdescription 414DFSDputdatadescription 408parameter list 408DFSDreadrefdescription 415parameter list 415DFSDreadslabdescription 417parameter list 418DFSDrestartdescription 414DFSDsetcaldescription 420parameter list 420DFSDsetdatastrsdescription 419parameter list 419DFSDsetdimsdescription 411parameter list 411DFSDsetdimscaledescription 426parameter list 426DFSDsetdimstrsdescription 425parameter list 426DFSDsetfillvaluedescription 420parameter list 420DFSDsetlengthsDFSDsetNTdescription 409parameter list 410DFSDsetrangedescription 420parameter list 420DFSDstartslabdescription 415parameter list 416DFSDwriterefdescription 410parameter list 410DFSDwriteslabdescription 416parameter list 417Dimension attribute 90Dimension compatbility modedetermining the current 79Dimension compatibility modedescription 78setting the future 78Dimension format attributedescription 425Dimension label attributedescription 425Dimension namedescription 21Dimension recordcreation of a 89Dimension scaledescription 22Dimension unit attributedescription 425Displaying vdata information 459dumper 454EEditing the contents of an HDF file 473Error reporting APIdescription 427returning the code of the nth-most-recent error 428returning the description of an error code 428routine list 427writing error stack information to a file 428writing errors to a console window 429External data filedefinition 52getting information 54moving data to a 55reading from a 57specifying the directory search path in a 52specifying the location of the next, to be created 52writing to a 52External SDS arraydefinition 52Extracting 8-bit raster images and palettes from HDF files 465Extracting palette data from an HDF file 466FField datapacking or unpacking 166File annotationcomparison with object annotation 364description 364File attributedescription 90File description annotationassigning a , using the single-file annotation API 390reading a , using the single-file annotation API 394File interlacingdescription 157File label annotationassigning a , using the single-file annotation API 389reading a 374reading a , using the single-file annotation API 393fill modedescription 106fill valuedescription 106description 101fill value attributereading a 107writing a 106FILL_ATTR definedescription 307Format attributefptohdf 459Gaccessing 280compressing 291creating a , in an external file 292getting the index of a 301I/O access type 292obtaining information about a 301reading 294setting the interlace mode for a , or image read 294terminating access to 281General raster image APIchunking 327description 4external file operations using the 292obtaining a palette identifier using the 317obtaining information about the contents of a file using , routines 300obtaining palette information using the 318reading 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 312setting 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 504Global attributedescription 90GRattrinfodescription 311parameter list 312GRcreatedescription 280parameter list 281GRenddescription 281parameter list 281GRendaccessdescription 281parameter list 281GRfileinfodescription 300parameter list 301GRfindattrdescription 311parameter list 312GRgetattrdescription 312parameter list 312GRgetchunkinfodescription 336parameter list 338GRgetiminfoparameter list 301GRgetlutiddescription 317parameter list 319GRgetlutinfodescription 318GRidtorefdescription 302GRluttorefdescription 317parameter list 318GRnametoindexparameter list 303Group objectdescription 473GRreadchunkGRreadimagedescription 294parameter list 295GRreadlutdescription 319parameter list 319GRreftoindexdescription 302parameter list 303GRreqimageilparameter list 295GRrequtildescription 319GRselectdescription 280parameter list 281GRsetaccesstypeparameter list 292GRsetaccestypedescription 292GRsetattrdescription 307parameter list 312GRsetchunkdescription 328parameter list 338GRsetchunkcachedescription 337parameter list 338GRsetcompressdescription 291parameter list 292GRsetexternalfiledescription 293parameter list 293GRstartdescription 280parameter list 281GRwriteimagedescription 282parameter list 283GRwritelutdescription 318parameter list 319HHDFdescription 1HDF APIHDF dumper 454HDF installation overview 507-??HDF_CHUNK_DEF uniondefinition of 113hdf24hdf8 467hdfcomp 467hdfed 473annotate command 479close command 481delete command 479display command 480dump command 478getr8 command 482help command 476if conditional 482info command 476next command 478open command 476prev command 477put command 482putr8 command 481revert command 482wait command 482write command 480hdfed command set 475hdfls 471hdfpack 468hdftopal 466hdftor8 465hdiff 458hdp 454command set 454dumprig command 457dumpsds command 455dumpvd command 456dumpvg command 457list command 455HEcleardescription 429HEprintdescription 428HEstringdescription 428HEvaluedescription 428Hishdf/hishdff 13history attributedescription 102HXsetcreatedirdescription 52HXsetdir and HXsetcreatedirparameter list 53II/O access typesetting the 42IMCOMP compressiondescription 259interlace mode 158JJPEG compressionJPEG compression quality factordescription 259LLabel annotationdescription 363Label attributeListing basic information about an HDF file 471Local attributedescription 90Lone vdatadescription 181Lone vgroupdescription 230Low-level interface 2MMFGR_INTERLACE_LINE definedescription 280MFGR_INTERLACE_PIXEL defineMFGR_INTERLACE_PLANE definedescription 280missing_value attributedescription 101description of the 365list of tags used in 388programming model for the 366routine categories 365routine list 365type definitions specific to the 366NNative format option 14netCDF data modelHDF support of 129Not-a-Number 106OObject annotationcomparison with file annotation 364description 364Object description annotationassigning a , using the single-file annotation API 391reading a , using the single-file annotation API 397Object label annotationassigning a , using the single-file annotation API 391reading a , using the single-file annotation API 396Obsolete tagslist of 506Old and new dimension implementation 78PPacking or unpacking field data 166adding to a RIS8 object 262backward compatibility issues 361color mapping using a 355description 355obtaining the reference number of the most recently accessed 361querying the number of , in a file 360reading a , with a given reference number 360retrieving the reference number of the specified 317specifying the next palette to be accessed to be the first 360specifying the reference number of a 358Palette APIroutine categories 356routine list 356paltohdf 465Performance Issues 433-??Pixel interlacingdescription 341Pixelsdescription 257accessing a 102list of , with labels and descriptions 101list of parameters 102naming conventions for 101Predefined dimension string attributetypes of 425Predefined string attributetypes of 419Rr24hdf8 464r8tohdf 463Range attributedescription 101reading a 105writing a 105Range attributes 105Raster image idsee Raster image identifier 276Raw data informationRecord variabledetermining whether an SDS is a 42Reference numberchecking before assigning an object annotation 399determining 399determining the , for the last object accessed 399querying a list of , for a given tag 400Reference number, overwriting data for a specified 410RGB valuesdescription 339ristosds 466RLE compressiondescription 259SScan-line interlacingdescription 341Scan-plane interlacingdescription 341Scientific data set tagslist of 505SD 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 20data type 21default 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 22reading from a 57required objects 20string attributes of dimensions 104terminating access to a 28writing to a 31SD scientific data set APIcompression methods supported 47routine categories 23routine list 23SD scientific data set arraydescription 20distinguishing from a coordinate variable 86SD scientific data set array namedescription 21SD scientific data set attribute 90SD scientific data set dimensiondescription 21naming 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 95SDdiminfodescription 80SDenddescription 28parameter list 28SDendaccessdescription 28parameter list 28SDexternalfiledescription 53SDfileinfoSDfindattrdescription 94parameter list 95SDget_numopenfilesdescription 111SDgetcaldescription 108parameter list 109SDgetChunkInfodescription 118SDgetdatastrsdescription 103parameter list 103SDgetdimiddescription 77parameter list 78SDgetdimstrsdescription 104parameter list 105SDgetexternalfiledescription 54SDgetfillvaluedescription 107parameter list 108SDgetinfoSDgetrangedescription 105parameter list 106SDidtorefdescription 72SDiscoordvardescription 86SDisrecorddescription 42SDnametoindexparameter list 71SDreadattrdescription 95parameter list 95SDreadChunkdescription 118parameter list 118SDreaddatadescription 57parameter list 57SDreftoindexdescription 71parameter list 71SDS idsee SD scientific data set identifier 20SDselectparameter list 28SDsetaccesstypedescription 42parameter list 43SDsetattrdescription 91parameter list 95SDsetblocksizedescription 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 106parameter list 108SDsetnbitdatasetSDsetrangedescription 105parameter list 106SDstartdescription 27SDwriteChunkparameter list 117SDwritechunkdescription 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 387list of tags used in 388programming model for the 389routine list 388Slabaccessing a , using the single-file scientific data set API 415description 31Stridesdescription 32support of , in the single-file scientific data set API 417Ttitle attributedescription 102UUnit attributeUnlimited dimension 21User_defined attributeallowed data types for a 90writing a 91User-defined attribute 90-??naming rules 90querying for a 94reading a 95Utility tagslist of 504VVaddtagrefdescription 217parameter list 218Vattachdescription 215parameter list 216Vattrinfodescription 248parameter list 249attributes of a 189creating 155description 139determining if the given , is an attribute 192determining the reference number from a , name 183multi-component field 140querying information on a given , attribute 192querying the number of attributes of a 191querying the total number of , attributes 191querying the values of a given , attribute 190resetting the current position within a 159resetting the current record position within a 160retrieving the index of a , attribute given the attribute name 192searching for a , by field name 184searching for lone , 181searching for the reference number of a 182selecting the set of , to be read 173setting the attribute of a , 189writing buffers into 161writing to a 160writing to a multifield 159Vdata APIdescription 4routine categories 141Vdata classassigning to a vdata 156description 139Vdata data modeldescription 139Vdata fielddefining 157description 140description of a predefined 157initializing for write access 157locating a , within a vdata stored in a vgroup 239querying the index of a , given the field name 189querying the number of attributes of a 191removing alignment bytes when writing to a 167setting the attribute of a , 189Vdata field namedescription 139Vdata field orderdescription 140Vdata identifierdetermining the next 254Vdata interlace modespecifying the 157Vdata nameassigning to a vdata 156description 139Vdata recorddescription 140Vdeletedescription 245parameter list 245Vdeletetagrefdescription 245parameter list 245Vdetachdescription 215parameter list 216Venddescription 215parameter list 216VF field information retrieval routine set 204VFfieldesizedescription 204VFfieldisizedescription 204VFfieldnamedescription 204VFfieldorderdescription 204VFfieldtypedescription 204Vfinddescription 233parameter list 234Vfindattrdescription 247parameter list 247Vfindclassdescription 234parameter list 234Vflocatedescription 239parameter list 240VFnfieldsdescription 204Vgetattrdescription 249parameter list 250Vgetclassdescription 233parameter list 233Vgetclassnamelenparameter list 233Vgetiddescription 231parameter list 183, 232Vgetnamedescription 232parameter list 233Vgetnamelenparameter list 233Vgetnextdescription 254parameter list 255Vgettagrefdescription 238parameter list 238Vgettagrefsdescription 238parameter list 238Vgetversiondescription 246accessing a 215assigning a class to a 217assigning a name to a 217attributes of a 245containing two RIS8 objects and a vdata 211conventions on content and structure 211description 209determining the name of a 255inserting a HDF object into a 217inserting a vdata or vgroup into a 218locating a 230locating a field within a vdata stored in a 239locating a lone 230means of uniquely identifying a 214organization of 210querying the number of , members 255querying the total number of , attributes 247querying the version of a given , 245retrieving the index of a , attribute given the attribute name 246retrieving the reference number of a 240retrieving the tag of a 240returning , member information 239setting the attribute of a 246sharing of vgroups and vdatas between more than one 210similarity to the Unix file system 209terminating access to 215testing whether an HDF object within a , is a vdata 239testing whether an HDF object within a , is a vgroup 239description 4routine categories 212routine list 212Vgroup API programming model 214Vgroup classdescription 210Vgroup identifier 214determining the next 254VHmakegroupdescription 218parameter list 218Vinqtagrefdescription 239parameter list 239Vinquiredescription 255parameter list 255Vinsertdescription 218parameter list 218Visvgdescription 239parameter list 239Visvsdescription 239parameter list 239Vlonedescription 230Vnattrsdescription 247Vnrefsdescription 240parameter list 240Vntagrefsdescription 237parameter list 238VQueryrefdescription 240parameter list 241VQuerytagdescription 240parameter list 241VS vdata information retrieval routine set 203VSattrinfodescription 192parameter list 193VSeltsdescription 203parameter list 204Vsetdescribing a heated mesh 212Vset nodedescription 211Vset tagslist of 506Vsetattrdescription 246parameter list 247Vsetclassdescription 217parameter list 218Vsetnamedescription 217parameter list 218VSfdefinedescription 157parameter list 158VSfexistdescription 184parameter list 184VSfinddescription 183parameter list 184when to use , in obtaining a vdata's reference number 144VSfindattrdescription 192parameter list 193VSfindexdescription 189parameter list 189VSfnattrsdescription 191parameter list 191VSfpackdescription 166parameter list 168VSgetattrdescription 190parameter list 190VSgetclassdescription 203parameter list 204VSgetfieldsdescription 203parameter list 204VSgetiddescription 182parameter list 184when to use , in obtaining a vdata's reference number 144VSgetinterlacedescription 203parameter list 204VSgetnamedescription 203parameter list 204vshow 459VSinquiredescription 198parameter list 198VSisattrdescription 192parameter list 193VSlonedescription 182parameter list 184VSnattrsdescription 191parameter list 191VSQuery vdata information retrieval routine set 202VSQuerycountparameter list 203VSQueryfieldsdescription 202parameter list 203VSQueryinterlacedescription 202parameter list 203VSQuerynamedescription 202parameter list 202VSQueryrefdescription 202parameter list 203VSQuerytagdescription 202parameter list 203VSQueryvsizedescription 202parameter list 203VSreaddescription 173parameter list 174setting the file interlace mode using 158VSseekdescription 174misused to append data 159VSsetattrdescription 189parameter list 190VSsetclassdescription 156parameter list 158VSsetfieldsparameter list 158VSsetinterlacedescription 158parameter list 158VSsetnamedescription 156parameter list 158VSsizeofdescription 203parameter list 204Vstartparameter list 216VSwritedescription 160parameter list 161setting the file interlace mode using 158
HDF 4.2.6 - August 2011 Copyright |
The HDF Group www.hdfgroup.org ![]() |