home *** CD-ROM | disk | FTP | other *** search
/ Encyclopedia of Graphics File Formats Companion / GFF_CD.ISO / formats / hdf / spec / app_b.txt < prev    next >
Text File  |  1994-06-01  |  7KB  |  255 lines
  1. B.1    NCSA HDF Calling Interfaces and Utilities
  2.  
  3. Routine Lists    B.1
  4.  
  5. National Center for Supercomputing Applications
  6.  
  7. March 1993
  8.  
  9.                                                                 
  10.  
  11. March 1993
  12.  
  13.  
  14.  
  15.  
  16. Appendix  B    Routine Lists
  17.  
  18.  
  19.  
  20. C    FORTRAN    
  21. Name    Name    Purpose
  22.  
  23. Raster Image Routines
  24.  
  25. DFR8setpalette    d8spal    sets the default palette to be used for 
  26.             subsequent images.
  27.  
  28. DFR8addimage    d8aimg    appends the RIS8 for the image to the file.
  29.  
  30. DFR8putimage    d8pimg    writes out the RIS8 for the image as the first 
  31.             image in the file.
  32.  
  33. DFR8writeref    d8wref    sets the reference number of the image to 
  34.             write next
  35.  
  36. DFR8getdims    d8gdims    retrieves the dimensions of the image and 
  37.             indicates whether a palette is associated and 
  38.             stored with the image.
  39.  
  40. DFR8getimage    d8gimg    retrieves the image and any associated 
  41.             palette, and stores them in arrays.
  42.  
  43. DFR8readref    d8rref    sets the reference number of the image to get 
  44.             next
  45.  
  46. DFR8restart    d8first    gets the next get command to read from the 
  47.             first RIS8 in the file, rather than the next.
  48.  
  49. DFR8nimages    d8nims    counts the number of images stored in the 
  50.             file (FORTRAN version currently not 
  51.             available)
  52.  
  53. DFR8lastref    d8lref    returns reference number of last RIS8 read 
  54.             or written
  55.  
  56. DF24setil    d2setil    sets the interlace to be used when writing 
  57.             out the RIS24 for the image.
  58.  
  59. DF24addimage    d2aimg    appends the RIS24 for the image to the file.
  60.  
  61. DF24putimage    d2aimg    writes out RIS24 for the image to the file.
  62.  
  63. DF24getdims    d2gdims    retrieves the dimensions and interlace of the 
  64.             image.
  65.  
  66. DF24getimage    d2gimg    retrieves the image and stores it in an array.
  67.  
  68. DF24readref    d2rref    sets the reference number of the image to get 
  69.             next
  70.  
  71. DF24restart    d2first     causes the next get command to read from the 
  72.             first RIS24 in the file, rather than the next one.
  73.  
  74. DF24reqil    d2reqil    specifies an interlace to be used in place of 
  75.             the interlace indicated in the file when the 
  76.             next raster image is read.
  77.  
  78.  
  79. Palette Routines
  80.  
  81. DFPaddpal    dpapal    appends a palette to a file.
  82.  
  83. DFPgetpal    dpgpal    reads in the next palette in the file.
  84.  
  85. DFPputpal    dpppal    writes a palette to a file.
  86.  
  87. DFPnpals    dpnpals    indicates number of palettes in a file.
  88.  
  89. DFPwriteref    dpwref    sets the reference number of the next palette 
  90.         to be written.
  91.  
  92. DFPreadref    dprref    sets the reference number of the next palette 
  93.         to be retrieved.
  94.  
  95. DFPrestart    dprest    specifies that the next call to DFPgetpal 
  96.         reads the first palette in the file, rather than 
  97.         the next.
  98.  
  99. DFPlastref    dplref    returns the value of the reference number 
  100.         most recently read or written.
  101.  
  102.  
  103. Annotation Routines
  104.  
  105. DFANputlabel    daplab    puts label of tag/ref.
  106.  
  107. DFANputdesc    dapdesc    puts description of tag/ref.
  108.  
  109. DFANgetlablen    dagllen    gets length of label of tag/ref.
  110.  
  111. DFANgetlabel    daglab    gets label of tag/ref.
  112.  
  113. DFANgetdesclen    dagdlen gets length of description of tag/ref.
  114.  
  115. DFANgetdesc    dagdesc    gets description of tag/ref.
  116.  
  117. DFANlablist    dallist    gets list of labels for a particular tag.
  118.  
  119. DFANaddfid    daafid    adds file ID.
  120.  
  121. DFANaddfds    daafds    adds file  description. 
  122.  
  123. DFANgetfidlen    dagfidl    gets file ID  length.
  124.  
  125. DFANgetfid    dagfid    gets file ID. 
  126.  
  127. DFANgetfdslen    dagfdsl    gets file description length.
  128.  
  129. DFANgetfds    dagfds    gets file description.
  130.  
  131. DFANlastref    dalref    returns ref of last annotation read or written.
  132.  
  133.  
  134.  
  135. Scientific Dataset Routines
  136.  
  137. DFSDadddata    dsadata    appends the data to the file, not overwriting 
  138.             other file contents.
  139.  
  140. DFSDputdata    dspdata    writes the data to a new file, truncating old 
  141.             file if it exists.
  142.  
  143. DFSDsetNT    dssnt    tells which number type is to be used for 
  144.             next DFSDadddata or DFSDputdata
  145.  
  146. DFSDsetdims    dssdims    sets the rank and dimension  sizes for 
  147.             succeeding  SDSs
  148.  
  149. DFSDclear    dsclear    clears all possible set values.
  150.  
  151. DFSDsetdimstrs    dssdist    sets label, unit,  and format specifications 
  152.             for a dimension and its scale.
  153.  
  154. DFSDsetdimscale    dssdisc    sets the scale for a dimension.
  155.  
  156.  
  157. DFSDsetdatastrs    dissdast sets label, unit, and format specifications 
  158.             for the data.
  159.  
  160. DFSDsetlengths    dsslens    sets maximum lengths for strings that will 
  161.             hold labels, units, formats, and the name of 
  162.             the coordinate system.
  163.  
  164. DFSDsetrange    dssrang    sets maximum and minimum data values.
  165.  
  166. DFSDsetcal    dsscal    sets calibration information associated with 
  167.             data
  168.  
  169. DFSDstartslice    dssslc    prepares system to write part of a dataset to 
  170.             a file.
  171.  
  172. DFSDputslice    dspslc    writes part of a dataset to a file.
  173.  
  174. DFSDendslice    dseslc    indicates write completion for part of a 
  175.             dataset.
  176.  
  177. DFSDgetdata    dsgdata    reads the next dataset in the file.
  178.  
  179. DFSDgetNT    dsgnt    gets the number type of data that will be 
  180.             read with DFSDgetdata.
  181.  
  182. DFSDgetdims    dsgdims    gets the number of dimensions of the 
  183.             dataset and the sizes of the dimensions for 
  184.             the next SDS in the file.
  185.  
  186. DFSDgetdimstrs    dsgdist    reads the label, unit, and format for a 
  187.             dimension and its scale.
  188.  
  189. DFSDgetdimscale    dsgdisc    reads the scale for a dimension.
  190.  
  191. DFSDgetdatastrs    dsgdast    reads the label, unit, and format  
  192.             specification for the data.
  193.  
  194. DFSDgetrange    dsgrang    reads the maximum and minimum values.
  195.  
  196. DFSDgetcal    dsgcal    gets calibration information associated with 
  197.             data
  198.  
  199. DFSDreadref    dsrref    sets the reference number of the SDS to get 
  200.             next
  201.  
  202. DFSDrestart    dsfirst    sets the next get command to read from the 
  203.             first SDS in the file, rather than the next.
  204.  
  205. DFSDgetslice    dsgslc    reads part of a dataset.
  206.  
  207. DFSDnumber        returns the number of SDSs in the file.
  208.  
  209. DFSDlastref    dslref    returns the value of the last reference 
  210.             number of an SDS read from or written to 
  211.             the file.
  212.  
  213.  
  214. Utility Routines
  215.  
  216. hdfls    displays the tags, ref numbers, and (optionally) lengths of 
  217.     data elements.
  218.  
  219. hdfed    lets you browse in an HDF file and manipulate some of the 
  220.     data. 
  221.  
  222. fptohdf    converts floating-point data to HDF floating-point data 
  223.     and/or 8-bit raster images.
  224.  
  225. ristsds    converts a series RIS8 HDF files into a single 3D SDS HDF 
  226.     file
  227.  
  228. r8tohdf    converts one or more raw 8-bit images to HDF RIS8 format 
  229.     and writes them to a file, possibly with palettes.
  230.  
  231. hdftor8    converts images and or palettes from HDF format to raw 
  232.     format and stores them in two corresponding sets of files.
  233.  
  234. hdfcomp    compresses 8-bit raster images from an HDF file, storing 
  235.     them in a new HDF file.
  236.  
  237. r24hdf8    converts a raw RGB 24-bit image to an 8-bit RIS8 with a 
  238.     palette.
  239.  
  240. hdf24hdf8 quantizes a HDF RGB 24 bit "pixel" image into a 8 bit 
  241.     image with RGB palette and stores it as a HDF 8-bit raster 
  242.     image file
  243.  
  244. paltohdf converts a raw palette to HDF format.
  245.  
  246. hdftopalconverts palette in an HDF file to raw format.
  247.  
  248. hdfseq/hdfrseq    displays sequences of images directly to the screen from  
  249.     HDF files containing raster images.
  250.  
  251. hdfpack    compacts and HDF file by reading in all the objects in an 
  252.     HDF file and writing them out to a new file.
  253.  
  254.  
  255.