MST_PRINT(3)

✨ MST_PRINT ✨

okay bestie, welcome to the libmseed manual, section 3 (that's library functions, for the uninitiated 💅). Today's main character is mst_print — the printing of MSTrace information. Yes, it's literally just vibes to text, and honestly? iconic.

---

🎀 NAME 🎀

mst_print — Printing of MSTrace information. that's it, that's the girl. she prints. 🖨️✨

---

🌸 SYNOPSIS 🌸

#include <libmseed.h>

void   mst_printtracelist ( MSTraceGroup *mstg, flag timeformat,
                            flag details, flag gaps );

void   mst_printsynclist ( MSTraceGroup *mstg, char *dccid,
                           flag subsecond );

void   mst_printgaplist ( MSTraceGroup *mstg, flag timeformat,
                          double *mingap, double *maxgap );

three little functions, all of them besties, all of them printing your MSTraceGroup data in a different outfit 💖

---

🦋 DESCRIPTION 🦋

💜 mst_printtracelist

not me starting with the classic. mst_printtracelist prints a formatted list of the MSTrace segments in the given MSTraceGroup. that's the whole job. she shows up, she lists, she leaves.

but wait, there's range ✨

• if the details flag is greater than 0, the sample rate and the sample count get printed for each trace. cute AND informative 💅
• if the gaps flag is greater than zero, the time gap from the previous MSTrace gets printed — but ONLY if the source name matches. no source name match, no gap. it's giving loyal. 🫶

and where does all this output go? through ms_log(3) at level 0. periodt.

💙 mst_printsynclist

mst_printsynclist prints a formatted list of the MSTrace segments in the given MSTraceGroup — basically mst_printtracelist's sibling, except the format is a SYNC listing. same energy, different fit. 👑

• if you supply a dccid string, it gets used together with the current system date to build the SYNC header line. your string + today's date = header, no cap.
• if the subsecond flag is true (non-zero), the time values in the SYNC lines include full libmseed precision. if it's not, they get truncated to integer second values. so like, decimals or no decimals, your call. 🔥

💚 mst_printgaplist

mst_printgaplist prints a formatted list of the gaps between MSTrace segments in the given MSTraceGroup. the drama detector, fr fr.

• if mingap or maxgap is not NULL, their values get enforced, and only the gaps/overlaps matching their implied criteria get printed. filter on, bestie. 🧚

⏰ the timeformat argument

this one applies to both mst_printtracelist and mst_printgaplist, and it controls the format of the resulting time strings. possible formats:

• 0 — SEED time format (2005,146,00:00:00.000000)
• 1 — ISO time format (2005-05-26T00:00:00.000000)
• 2 — Epoch time, seconds since the epoch (1117065600.00000000)

🙈 negative gaps (the plot twist)

both mst_printtracelist and mst_printgaplist represent time overlaps as negative gaps. yes, overlaps get a minus sign. it's giving "I'm not a gap, I'm the opposite of a gap."

and here's the detail nobody expects: for a single sample overlap, the value of the gap is calculated as zero — and that gets printed as "-0" (negative zero) to indicate an overlap. not me being obsessed with a negative zero. it's literally the main character of this paragraph. 💅

---

💀 GAP/OVERLAP RULES 💀

okay this is the serious section, so pay attention bestie, because it's all about what these routines do and don't do:

the existence of gaps and overlaps is implicit in the structure of the MSTraceGroup. no special processing is done to detect gaps and overlaps in these routines. they don't go looking. they just read what's there. 🫶

the value of a gap is calculated as the difference between the time of the last sample before the gap and the time of the first sample after the gap. no sample 'coverage' time is included. none. zero. nada. ✨

the value of an overlap is calculated as the time between two samples which represent the maximum amount of timeseries overlap. 📐

and now the warning, listen up: when the MSTraces in the MSTraceGroup include a small segment that is completely overlapped by another larger segment, the gap/overlap value will not be correct for either the smaller segment or the segment following it. so like… be aware. this is a documented bug situation and we respect her honesty. 😭

---

👑 SEE ALSO 👑

• ms_intro(3) — go read it, it's the whole intro, it's the prequel 💜

---

🌈 AUTHOR 🌈

Chad Trabait IRIS Data Management Center

---

Libmseed API · 2008/11/21 · MST_PRINT(3)

and that's the whole page bestie — printed, formatted, gap-checked, overlap-noted, signed off. slay 💅✨💖