Crewes Seismic I/O Library File Index. Function Documentation. Functions to access seimic header definitions, страница 8

·  int seisioFileHdr_free (int id)

Deallocates the corresponding seismic file header definition instance.

·  int seisioFileHdr_setText (int id, const char *text)

Sets the text segment of the supplied file header object from a string.

·  int seisioFileHdr_setTextLine (int id, const char *text, int line)

Sets a single line of the text segment of the file header from a string.

·  int seisioFileHdr_getText (int id, char *fileHdrStr)

Returns the text segment of the file header as an array of chars.

·  int seisioFileHdr_putI2 (int id, const char *hdrName, int16 hdrValue)

Put a value (int16, int32 or float) into the data segment.

·  int seisioFileHdr_putI4 (int id, const char *hdrName, int32 hdrValue)

·  int seisioFileHdr_putF4 (int id, const char *hdrName, float hdrValue)

·  int seisioFileHdr_getI2 (int id, const char *hdrName, int16 *hdrValue)

Get a value 2-byte (16 bit) integer value from the header.

·  int seisioFileHdr_getI2ByByte (int id, int byt, int16 *hdrValue)

Get a value 2-byte (16 bit) integer value from the header given a starting byte location.

·  int seisioFileHdr_getI4 (int id, const char *hdrName, int32 *hdrValue)

Get a value 4-byte (32 bit) integer value from the header.

·  int seisioFileHdr_getI4ByByte (int id, int byt, int32 *hdrValue)

Get a value 4-byte (32 bit) integer value from the header given a starting byte location.

·  int seisioFileHdr_getF4 (int id, const char *hdrName, float *hdrValue)

Get a value 4-byte (32 bit) floating point value from the header.

·  int seisioFileHdr_getF4ByByte (int id, int byt, float *hdrValue)

Get a value 4-byte (32 bit) integer value from the header given a starting byte location.

·  int seisioFileHdr_getHdr (int id, char *hdr)

Returns the file header as an array of chars (length=FILE_HDR_LENGTH).

·  int seisioFileHdr_setHdr (int id, char *hdr)

Sets the file header from an array of chars (length must be 3600).

·  char* seisioFileHdr_getInternalText (int id)

Gets the text segment of the file header.

·  char* seisioFileHdr_getInternalData (int id)

Gets a pointer to the data segment of the file header.

Detailed Description

seismic file header object.

Function Documentation

int seisioFileHdr_free (int id)

Deallocates the corresponding seismic file header definition instance.

Parameters:

id   identification number of the seismic file header instance to free

Returns:

non-zero on error (see seisio.h for error definitions).

int seisioFileHdr_getF4 (int id, const char * hdrName, float * hdrValue)

Get a value 4-byte (32 bit) floating point value from the header.

Returns non-zero on failure (see seisio.h for error definitions). Get fails if the corresponding data type is not defined in the seismic  header definition at the requested byte.

Parameters:

id   identification number of the seismic file header instance to access

hdrName   name of the header to access

hdrValue   output argument for value of the header

int seisioFileHdr_getF4ByByte (int id, int byt, float * hdrValue)

Get a value 4-byte (32 bit) integer value from the header given a starting byte location.

Returns non-zero on failure (see seisio.h for error definitions). Get fails if the corresponding data type is not defined in the seismic header definition  at the requested byte.

Parameters:

id   identification number of the seismic file header instance to access

byt   byte number in file header from which the value should be retrieved. Starts at 0.

hdrValue   output argument for value of the header

int seisioFileHdr_getHdr (int id, char * hdr)

Returns the file header as an array of chars (length=FILE_HDR_LENGTH).

The header is formatted in big endian binary and ebcdic text.

Parameters:

id   identification number of the seismic file header instance to access