[Top] [Prev] [Next] [Bottom]

10.3 The Single-File Annotation Interface

The functions and routines that comprise the single-file annotation interface have names that begin with the string "DFAN" and the equivalent Fortran-77 routine names are prefaced by "da".This interface is the older annotation interface and only supports annotation access within one particular HDF file. It doesn't support the concept of an annotation identifier used in the newer multifile interface, therefore annotations created with the multifile interface cannot be accessed or manipulated with single-file interface functions. The multifile interface is described in Section 10.9 on page 264.

DFANaddfid, DFANgetfid, DFANaddfds, and DFANgetfds are the functions used for annotating files and are sufficient for most read and write operations.

10.3.1 Single-File Annotation Library Routines

These functions are divided into the following categories:

The DFAN function calls are defined in the following table and on their respective pages in the HDF Reference Guide.

TABLE 10A DFAN Library Routines
Purpose

Functions

Description

C

Fortran-77

Write

DFANaddfid

daafid

Assigns a file label to a specific file.

DFANaddfds

daafds

Assigns a file description to a specific file.

DFANputlabel

daplab

Assigns an object label to a specific data object.

DFANputdesc

dapdesc

Assigns an object description to a specific data object.

Read

DFANgetfidlen

dagfidl

Returns the length of a file label.

DFANgetfid

dagfid

Reads the text of a file label.

DFANgetfdslen

dagfdsl

Returns the length of a file description.

DFANgetfds

dagfds

Reads the text of a file description.

DFANgetlablen

dagllen

Returns the length of an object label.

DFANgetlabel

daglab

Reads the text of an object label.

DFANgetdesclen

dagdlen

Returns the length of an object description.

DFANgetdesc

dagdesc

Reads the text of an object description.

General Inquiry

DFANlablist

dallist

Gets a list of all the labels in a file for a particular tag.

DFANlastref

dalref

Returns the reference number of the last annotation accessed.

Maintenance

DFANclear

None

Clear the internal tables and strcutures used by the DFAN interface.

10.3.2 Tags in the Annotation Interface

See Table 10B below for a list of the annotation tags defined in HDF versions 2.0, 3.0 and 4.0. Newly-defined tags names in each version are bolded. For a more complete list of tags consult the HDF Specification and Developer's Guide.

TABLE 10B List of Annotation Interface Tags in HDF Versions 2.0, 3.0 and 4.0
Interface

Data Object

Tag Name

v2.0

v3.0

v4.0

DFR8

Raster Image: 8-bit (uncompressed)

DFTAG_RI8

DFTAG_RI

DFTAG_RI

Compressed Image: 8-bit

DFTAG_CI8

DFTAG_CI

DFTAG_CI

Image Dimension: 8-bit

DFTAG_ID8

DFTAG_ID

DFTAG_ID

Image Palette: 8-bit

DFTAG_IP8

DFTAG_LUT

DFTAG_LUT

DF24

Raster Image Group

None

DFTAG_RIG

DFTAG_RIG

Raster Image (uncompressed)

None

DFTAG_RI

DFTAG_RI

Compressed Image

None

DFTAG_CI

DFTAG_CI

Image Dimension

None

DFTAG_ID

DFTAG_ID

DFP

Color Look-up Table

DFTAG_LUT

DFTAG_LUT

DFTAG_LUT

DFSD

Scientific Data Group

DFTAG_SDG

DFTAG_SDG

DFTAG_NDG

Scientific Data

DFTAG_SD

DFTAG_SD

DFTAG_SD

Scientific Data Dimension

DFTAG_SDD

DFTAG_SDD

DFTAG_SDD

Scientific Data Scale Attribute

DFTAG_SDS

DFTAG_SDS

DFTAG_SDS

Scientific Data Label Attribute

DFTAG_SDL

DFTAG_SDL

DFTAG_SDL

Scientific Data Unit Attribute

DFTAG_SDU

DFTAG_SDU

DFTAG_SDU

Scientific Data Format Attribute

DFTAG_SDF

DFTAG_SDF

DFTAG_SDF

Scientific Data Max/Min Attribute

DFTAG_SDM

DFTAG_SDM

DFTAG_SDM

Scientific Data Coordinates Attribute

DFTAG_SDC

DFTAG_SDC

DFTAG_SDC

DFAN

File Identifier

DFTAG_FID

DFTAG_FID

DFTAG_FID

File Descriptor

DFTAG_FD

DFTAG_FD

DFTAG_FD

Data Identifier Label

DFTAG_DIL

DFTAG_DIL

DFTAG_DIL

Data Identifier Annotation

DFTAG_DIA

DFTAG_DIA

DFTAG_DIA

Vdata

Vdata Storage

DFTAG_VS

DFTAG_VS

DFTAG_VS

Vgroups

Vgroup Storage

DFTAG_VG

DFTAG_VG

DFTAG_VG



[Top] [Prev] [Next] [Bottom]

hdfhelp@ncsa.uiuc.edu
HDF User's Guide - 06/04/97, NCSA HDF Development Group.