fddx_inhdr - initialize DDS dataset for input, selected headers


SYNOPSIS

#include <fdds.h> (fixed-format sources)
#include <f90dds.h> (free-format sources)

integer function fddx_inhdr(alias, value, title, sprime, hprime, hdrs)

character(*) alias
character(*) value
character(*) title
integer sprime
integer hprime
character(*) hdrs

DESCRIPTION

Routine, "fddx_inhdr", opens an input dataset. All input headers specified in the string, "hdrs", must exist on the input and will be at the beginning of each trace (in the order specified) in the format specified by "hprime"; followed by the "Samples" in the format specified by "sprime"; and then all other headers will follow in their native-formats. So the specified headers and Samples can be referenced directly in the trace array indexed by the order specified. Use "fddx_index" to get the offset index to the first data sample of each trace. The dataset is open with "r+" so that is can be modified.

After opening a file for input with "fddx_inhdr" the input buffer Dictionary will be left open for scanning. The open process will look for "alias" for the Dictionary (or usp, segy or su binary on input), "alias_data" for overriding the binary, and "alias_format" for overriding the format. The input parameter, "value", is the default value (eg. "stdin:" or "stdout:") used for a fallback in cases where "alias" is not specified by the user. The input parameter, "title", should be a brief one line description of the application program. It will return a binary tag associated with the internal binary upon successful opening, a value of -2 if the dataset is not specified and no default value is given, otherwise a value of -1 to signify an open failure.

The specified "sprime" and "hprime" types can be any prime type defined for fdds_index". "sprime" can also have a value < 0, in which case the Samples will be DDS_COMPLEX or DDS_REAL depending on whether the input samples are complex or not.

AUTHOR

Jerry Ehlers, BP America (May 2003)