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

NAME

6       mstl_print - Printing of MSTrace information.
7
8

SYNOPSIS

10       #include <libmseed.h>
11
12       void   mstl_printtracelist ( MSTraceList *mstl, flag timeformat,
13                                    flag details, flag gaps );
14
15       void   mstl_printsynclist ( MSTraceList *mstl, char *dccid,
16                                   flag subsecond );
17
18       void   mstl_printgaplist ( MSTraceList *mstl, flag timeformat,
19                                  double *mingap, double *maxgap );
20
21

DESCRIPTION

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

GAP/OVERLAP RULES

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

SEE ALSO

75       ms_intro(3)
76
77

AUTHOR

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