1MST_PRINT(3)               Library Functions Manual               MST_PRINT(3)
2
3
4

NAME

6       mst_print - Printing of MSTrace information.
7
8

SYNOPSIS

10       #include <libmseed.h>
11
12       void   mst_printtracelist ( MSTraceGroup *mstg, flag timeformat,
13                                   flag details, flag gaps );
14
15       void   mst_printsynclist ( MSTraceGroup *mstg, char *dccid,
16                                  flag subsecond );
17
18       void   mst_printgaplist ( MSTraceGroup *mstg, flag timeformat,
19                                 double *mingap, double *maxgap );
20
21

DESCRIPTION

23       mst_printtracelist  prints  a formatted list of the MSTrace segments in
24       the given MSTraceGroup.  If the details flag is greater than 0 the sam‐
25       ple rate and sample count are printed for each trace.  If the gaps flag
26       is greater than zero the time gap from the  previous  MSTrace  (if  the
27       source name matches) is printed.  All output is printed using ms_log(3)
28       at level 0.
29
30       mst_printsynclist prints a formatted list of the  MSTrace  segments  in
31       the  given MSTraceGroup similar to mst_printtracelist but the format is
32       a SYNC listing.  If a dccid string is supplied it will  be  used  along
33       with  the  current  system date to create the SYNC header line.  If the
34       subsecond flag is true (non-zero) the time values  in  the  SYNC  lines
35       will  include  full libmseed precision, otherwise they will be truncted
36       to integer second values.
37
38       mst_printgaplist prints a formatted list of the  gaps  between  MSTrace
39       segments  in  the  given MSTraceGroup.  If mingap or maxgap is not NULL
40       their values will be enforced and  only  gaps/overlaps  matching  their
41       implied criteria will be printed.
42
43       The  timeformat  argument  for  both  mst_printtracelist and mst_print‐
44       gaplist controls the format of the resulting  time  strings.   Possible
45       formats are:
46
47       0 : SEED time format (2005,146,00:00:00.000000)
48       1 : ISO time format (2005-05-26T00:00:00.000000)
49       2 : Epoch time, seconds since the epoch (1117065600.00000000)
50
51       Both mst_printtracelist and mst_printgaplist represent time overlaps as
52       negative gaps.  For a single sample overlap the value  of  the  gap  is
53       calculated  as  zero,  this will be printed as "-0" or negative zero to
54       indicate an overlap.
55
56

GAP/OVERLAP RULES

58       The existence of gaps and overlaps is implicit in the structure of  the
59       MSTraceGroup, no special processing is done to detect gaps and overlaps
60       in these routines.
61
62       The value of a gap is calculated as the difference between the time  of
63       the  last  sample before the gap and the time of the first sample after
64       the gap.  No sample 'coverage' time is included.
65
66       The value of an overlap is calculated as the time between  two  samples
67       which represent the maximum amount of timeseries overlap.
68
69       When  the  MSTraces in the MSTraceGroup include a small segment that is
70       completely overlapped by another larger segment the  gap/overlap  value
71       will  not be correct for either the smaller segment or the segment fol‐
72       lowing it.
73
74

SEE ALSO

76       ms_intro(3)
77
78

AUTHOR

80       Chad Trabant
81       IRIS Data Management Center
82
83
84
85Libmseed API                      2008/11/21                      MST_PRINT(3)