fddx_in2 - open a DDS dataset for input, passing headers
SYNOPSIS
#include <fdds.h> (fixed-format sources)
#include <f90dds.h> (free-format sources)
integer function fddx_in2(alias, value, title)
-
character*(*) alias
character*(*) value
character*(*) title
DESCRIPTION
Function "fddx_in2" opens an input dataset in a way that will
pass all headers followed by all samples, on a trace by trace basis,
to the application. Headers will be converted to the host-dependent
equivalent sample type. Samples will be converted to host-dependent
float or complex, depending on their type in the input stream. Upon
return, the input buffer dictionary is in "scan" mode, and accessible
to the fdds_scan routines.
Sample type conversions:
- Sample types int, short, long, float, and double will be converted
to float.
- Sample types complex and complex double will be converted to complex.
- Use other input types cautiously, as conversion behaviour
may be undefined.
ARGUMENTS
"alias" is used to interrogate the par: dictionary
for optional definitions
alias= dictionary name
alias_data= binary file name
alias_format= [segy,fcube,...]
"value" is used as a fallback when alias= is absent.
"value" is commonly set to "stdin:" to allow piped
input, but can have other application specific names as well.
E.g. "vel".
"title" should be a brief , one line description of the
application program.
OUTPUT
Upon successful completion, fddx_in2 returns a positive binary
tag (integer) for the internal binary data stream. A return value of
-2 indicates the dataset is not specified and no default value
is given. A return value of -1 signifies all other open failures.
AUTHOR
Jerry Ehlers, BP America (May 2003)