ms_intro.3

C编写的格式转换程序

.TH MS_INTRO 3 2007/08/16
.SH NAME
Introduction to libmseed

.SH INTRODUCTION

The Mini-SEED library provides a framework for manipulation of SEED
data records including the unpacking and packing of data records.
Functionality is also included for managing waveform data as
continuous traces.  All structures of SEED 2.4 data records are
supported with the following exceptions: Blockette 2000 opaque data
which has an unknown data structure by definition and Blockette 405
which depends on full SEED (SEED including full ASCII headers) for a
full data description.

The primary purpose of the library is to hide the details of Mini-SEED
in order to allow rapid development of Mini-SEED reading/writing
software.  The framework allows everything from manipulation of
Mini-SEED on a record-by-record basis to reading of Mini-SEED into
continuous trace segments to packing of large continuous traces using
a record template.

Certain common tasks have, through library design, been streamlined,
for example: reading Mini-SEED records from a file, adding data from
unpacked records to a group of traces or packing a group of continuous
traces into Mini-SEED records.

The following data encoding formats are supported for both unpacking
and packing: ASCII, INT16, INT32, FLOAT32, FLOAT64, STEIM1 and STEIM2.
The INT and FLOAT encodings each have two versions for quantities with
a different number of bits of representation.  The STEIM decompression
produces 32-bit integers; likewise the compression routines require
32-bit integers as input.  The following data encoding formats are
supported for unpacking only: GEOSCOPE (24-bit, 16/3 and 16/4 gain
ranged), SRO and DWWSSN.

.SH DATA RECORDS

A Mini-SEED record is represented in the library using the data
structure given below.  This structure is used for both unpacking and
packing of Mini-SEED records.  When unpacking with msr_unpack(3) this
structure is populated.  When packing with msr_pack(3) this structure
is used as a template for the resulting data records and as a source
of samples to be packed.

Blockettes following the fixed section of the header are contained in
the blockette chain of BlktLink structures.  Shortcut pointers to
commonly used blockettes are maintained for types 100, 1000 and 1001.

Many common header fields which are not easily accessible/usable in
the raw header are available directly from the structure.  When this
structure is used as a packing template, these common header fields
are packed into the appropriate place in the fixed section or
blockette.  As examples, the ASCII stream identifiers (network,
station, location and channel) are available as NULL terminated
strings, the start time is available as a high precision epoch time
(see ms_time(3)) and the sample rate is available as a double
precision floating point value.

The MSRecord data structure:

.nf
typedef struct MSRecord_s {
  char           *record;            /* Mini-SEED record */
  int32_t         reclen;            /* Length of Mini-SEED record */
  
  /* Pointers to SEED data record structures */
  struct fsdh_s      *fsdh;          /* Fixed Section of Data Header */
  struct BlktLink    *blkts;         /* Root of blockette chain */
  struct blkt_100_s  *Blkt100;       /* Blockette 100, if present */
  struct blkt_1000_s *Blkt1000;      /* Blockette 1000, if present */
  struct blkt_1001_s *Blkt1001;      /* Blockette 1001, if present */
  
  /* Common header fields in accessible form */
  int32_t         sequence_number;   /* SEED record sequence number */
  char            dataquality;       /* Data quality indicator */
  char            network[11];       /* Network designation */
  char            station[11];       /* Station designation */
  char            location[11];      /* Location designation */
  char            channel[11];       /* Channel designation */
  hptime_t        starttime;         /* Record start time */
  double          samprate;          /* Nominal sample rate (Hz) */
  int32_t         samplecnt;         /* Number of samples in record */
  int8_t          encoding;          /* Data encoding format */
  int8_t          byteorder;         /* Byte order of record */
  
  /* Data sample fields */
  void           *datasamples;       /* Data samples */
  int32_t         numsamples;        /* Number of data samples */
  char            sampletype;        /* Sample type code: a, i, f, d */

  /* Stream oriented state information */
  StreamState    *ststate;           /* Stream processing state information */
}
MSRecord;
.fi

.SS Explanation of fields

.IP record:
Pointer to the Mini-SEED record which was unpacked into the MSRecord.

.IP reclen:
When unpacking this is the record length in bytes of the record
pointed to by the 'record' pointer.  When packing this is the length
of records to pack.

.IP fsdh:
A pointer to the Fixed Section of the Data Header, all appropriate
multi-byte quantities are in host byte order.

.IP blkts:
The root of the blockette chain.  The chain is constructed from
linked BlktLink structures.  All appropriate multi-byte quantities
in the blockettes are in host byte order.  The msr_addblockette(3)
routine can be used to add blockettes to this chain.  The BlktLink
structure and SEED blockette structures are defined in libmseed.h.

.IP Blkt100:
.IP Blkt1000:
.IP Blkt1001:
Shortcut pointers to common blockettes in the blockette chain.  If a
given blockette does not exist in the blockette chain the shortcut
pointer will be 0.  If more than one of these blockette types exist
in the chain this pointer will point to the last one.

.IP sequence_number:
SEED record sequence number, should be between 0 and 999999.

.IP dataquality:
Data record and quality indicator, should be 'D', 'R', 'Q' or 'M'.

.IP network:
.IP station:
.IP location:
.IP channel:
SEED stream identifiers as a NULL terminated strings.

.IP starttime:
Record start time, the time of the first sample, as a high precision
epoch time (see ms_time(3)).  This time can be converted using the
various ms_hptime2<X> functions.

.IP samprate:
The sample rate in samples per second in double precision.  During
unpacking this value will be set to the sample rate given in the 100
blockette if it is present, otherwise the sample rate derived from
the factor and multiplier in the fixed section of the header.  In a
packing template this value will be used to derive a factor and
multiplier for the fixed section of the header and will be written
into 100 blockettes if any are in the blockette chain.

.IP samplecnt:
The sample count, i.e. number of data samples in the record.

.IP encoding:
The SEED data sample encoding format.  During packing this dictates
what format will be used to pack the data samples.  Supported packing
formats are 0 (DE_ASCII), 1 (DE_INT16), 3 (DE_INT32), 4 (DE_FLOAT32),
5 (DE_FLOAT64), 10 (DE_STEIM1) and 11 (DE_STEIM2).

.IP byteorder:
Byte order of multi-byte quantities in the record.  A value of 0
indicates little endian and a value of 1 indicates big endian.
During packing this dictates the byte order of the final records.

.IP datasamples:
A pointer to the unpacked data samples.  If no data samples were
unpacked this will be 0.  The 'numsamples' field indicates how many
samples are in this array and the 'sampletype' field indicates what
type of samples they are.

.IP numsamples:
The number of samples pointed to by the 'datasamples' pointer.

.IP sampletype:
The type of samples pointed to by the 'datasamples' pointer.
Supported types are 'a' (ASCII), 'i' (integer), 'f' (float) and 'd'
(double).  The size of each sample type in bytes is returned
by the get_samplesize(3) lookup routine.

.IP ststate:
Pointer to a StreamState struct used internally to track stream
oriented state variables.  Memory for this only allocated when needed.

.SH TRACES

In order to manage continuous trace segments the library defines a
MSTrace data structure and a MSTraceGroup data structure in which MSTrace
structures can be grouped.  While a MSTrace structure is normally used
to hold trace information and associated data samples it can also be
used without data samples as a means to keep trace of data coverage
without actual samples.

Numerous routines are provided for basic management of MSTrace
structures, including the creation of new MSTrace structures, adding
data from Mini-SEED data structures to MSTrace structures, printing
trace information, etc.

The MSTraceGroup data structure acts as a very simple place to begin a
chain of MSTrace structures and keep track of the number of traces.

The MSTrace and MSTraceGroup data structures:

.nf
typedef struct MSTrace_s {
  char            network[11];     /* Network designation */
  char            station[11];     /* Station designation */
  char            location[11];    /* Location designation */
  char            channel[11];     /* Channel designation */
  char            dataquality;     /* Data quality indicator */
  char            type;            /* MSTrace type code */
  hptime_t        starttime;       /* Time of first sample */
  hptime_t        endtime;         /* Time of last sample */
  double          samprate;        /* Nominal sample rate (Hz) */
  int32_t         samplecnt;       /* Num. in trace coverage */
  void           *datasamples;     /* Data samples */
  int32_t         numsamples;      /* Num. samples in datasamples */
  char            sampletype;      /* Sample type code: a, i, f, d */
  void           *prvtptr          /* Private pointer for general use */
  struct MSTrace_s *next;          /* Pointer to next trace */
}
MSTrace;

typedef struct MSTraceGroup_s {
  int32_t           numtraces;     /* Number of MSTraces in trace chain */
  struct MSTrace_s *traces;        /* Root of the trace chain */
}
MSTraceGroup;
.fi

.SS Explanation of fields

.IP dataquality:

SEED data quality indicator, either 'D', 'R', 'Q' or 'M'.  This value
will be (binary) 0 when the quality is unknown or mixed.

.IP network:
.IP station:
.IP location:
.IP channel:
MSTrace identifiers as a NULL terminated strings.

.IP type:
A single character trace type indicator.  This field is not used by
libmseed but could be used for application specific trace
identification.

.IP starttime:
MSTrace start time, the time of the first sample, as a high precision
epoch time (see ms_time(3)).  This time can be converted using the
various ms_hptime2<X> functions.

.IP endtime:
MSTrace end time, the time of the last sample, as a high precision epoch
time (see ms_time(3)).  This time can be converted using the
various ms_hptime2<X> functions.

.IP samprate:
The sample rate in samples per second in double precision.

.IP samplecnt:
The sample count, i.e. number of data samples in the trace.

.IP datasamples:
A pointer to the data samples.  If no data samples are included this
will be 0.  The 'numsamples' field indicates how many samples are in
this array and the 'sampletype' field indicates what type of samples
they are.