B.1 NCSA HDF Calling Interfaces and Utilities Routine Lists B.1 National Center for Supercomputing Applications March 1993 March 1993 Appendix B Routine Lists C FORTRAN Name Name Purpose Raster Image Routines DFR8setpalette d8spal sets the default palette to be used for subsequent images. DFR8addimage d8aimg appends the RIS8 for the image to the file. DFR8putimage d8pimg writes out the RIS8 for the image as the first image in the file. DFR8writeref d8wref sets the reference number of the image to write next DFR8getdims d8gdims retrieves the dimensions of the image and indicates whether a palette is associated and stored with the image. DFR8getimage d8gimg retrieves the image and any associated palette, and stores them in arrays. DFR8readref d8rref sets the reference number of the image to get next DFR8restart d8first gets the next get command to read from the first RIS8 in the file, rather than the next. DFR8nimages d8nims counts the number of images stored in the file (FORTRAN version currently not available) DFR8lastref d8lref returns reference number of last RIS8 read or written DF24setil d2setil sets the interlace to be used when writing out the RIS24 for the image. DF24addimage d2aimg appends the RIS24 for the image to the file. DF24putimage d2aimg writes out RIS24 for the image to the file. DF24getdims d2gdims retrieves the dimensions and interlace of the image. DF24getimage d2gimg retrieves the image and stores it in an array. DF24readref d2rref sets the reference number of the image to get next DF24restart d2first causes the next get command to read from the first RIS24 in the file, rather than the next one. DF24reqil d2reqil specifies an interlace to be used in place of the interlace indicated in the file when the next raster image is read. Palette Routines DFPaddpal dpapal appends a palette to a file. DFPgetpal dpgpal reads in the next palette in the file. DFPputpal dpppal writes a palette to a file. DFPnpals dpnpals indicates number of palettes in a file. DFPwriteref dpwref sets the reference number of the next palette to be written. DFPreadref dprref sets the reference number of the next palette to be retrieved. DFPrestart dprest specifies that the next call to DFPgetpal reads the first palette in the file, rather than the next. DFPlastref dplref returns the value of the reference number most recently read or written. Annotation Routines DFANputlabel daplab puts label of tag/ref. DFANputdesc dapdesc puts description of tag/ref. DFANgetlablen dagllen gets length of label of tag/ref. DFANgetlabel daglab gets label of tag/ref. DFANgetdesclen dagdlen gets length of description of tag/ref. DFANgetdesc dagdesc gets description of tag/ref. DFANlablist dallist gets list of labels for a particular tag. DFANaddfid daafid adds file ID. DFANaddfds daafds adds file description. DFANgetfidlen dagfidl gets file ID length. DFANgetfid dagfid gets file ID. DFANgetfdslen dagfdsl gets file description length. DFANgetfds dagfds gets file description. DFANlastref dalref returns ref of last annotation read or written. Scientific Dataset Routines DFSDadddata dsadata appends the data to the file, not overwriting other file contents. DFSDputdata dspdata writes the data to a new file, truncating old file if it exists. DFSDsetNT dssnt tells which number type is to be used for next DFSDadddata or DFSDputdata DFSDsetdims dssdims sets the rank and dimension sizes for succeeding SDSs DFSDclear dsclear clears all possible set values. DFSDsetdimstrs dssdist sets label, unit, and format specifications for a dimension and its scale. DFSDsetdimscale dssdisc sets the scale for a dimension. DFSDsetdatastrs dissdast sets label, unit, and format specifications for the data. DFSDsetlengths dsslens sets maximum lengths for strings that will hold labels, units, formats, and the name of the coordinate system. DFSDsetrange dssrang sets maximum and minimum data values. DFSDsetcal dsscal sets calibration information associated with data DFSDstartslice dssslc prepares system to write part of a dataset to a file. DFSDputslice dspslc writes part of a dataset to a file. DFSDendslice dseslc indicates write completion for part of a dataset. DFSDgetdata dsgdata reads the next dataset in the file. DFSDgetNT dsgnt gets the number type of data that will be read with DFSDgetdata. DFSDgetdims dsgdims gets the number of dimensions of the dataset and the sizes of the dimensions for the next SDS in the file. DFSDgetdimstrs dsgdist reads the label, unit, and format for a dimension and its scale. DFSDgetdimscale dsgdisc reads the scale for a dimension. DFSDgetdatastrs dsgdast reads the label, unit, and format specification for the data. DFSDgetrange dsgrang reads the maximum and minimum values. DFSDgetcal dsgcal gets calibration information associated with data DFSDreadref dsrref sets the reference number of the SDS to get next DFSDrestart dsfirst sets the next get command to read from the first SDS in the file, rather than the next. DFSDgetslice dsgslc reads part of a dataset. DFSDnumber returns the number of SDSs in the file. DFSDlastref dslref returns the value of the last reference number of an SDS read from or written to the file. Utility Routines hdfls displays the tags, ref numbers, and (optionally) lengths of data elements. hdfed lets you browse in an HDF file and manipulate some of the data. fptohdf converts floating-point data to HDF floating-point data and/or 8-bit raster images. ristsds converts a series RIS8 HDF files into a single 3D SDS HDF file r8tohdf converts one or more raw 8-bit images to HDF RIS8 format and writes them to a file, possibly with palettes. hdftor8 converts images and or palettes from HDF format to raw format and stores them in two corresponding sets of files. hdfcomp compresses 8-bit raster images from an HDF file, storing them in a new HDF file. r24hdf8 converts a raw RGB 24-bit image to an 8-bit RIS8 with a palette. hdf24hdf8 quantizes a HDF RGB 24 bit "pixel" image into a 8 bit image with RGB palette and stores it as a HDF 8-bit raster image file paltohdf converts a raw palette to HDF format. hdftopalconverts palette in an HDF file to raw format. hdfseq/hdfrseq displays sequences of images directly to the screen from HDF files containing raster images. hdfpack compacts and HDF file by reading in all the objects in an HDF file and writing them out to a new file.