MS_WRITEMSEED(3)

💖 MS_WRITEMSEED(3) 💖

okay bestie, so this is a page from the Library Functions Manual and it's literally about ms_writemseed — writing Mini-SEED records to files. sit down, hydrate, we're doing this 🫶

---

✨ NAME ✨

ms_writemseed — Write Mini-SEED records to files.

no cap, that's the whole job. it packs your data into Mini-SEED records and yeets them into a file 💅

---

🌸 SYNOPSIS 🌸

#include <libmseed.h>

int  msr_writemseed ( MSRecord *msr, char *msfile, flag overwrite,
                      int reclen, flag encoding, flag byteorder,
                      flag verbose );

int  mst_writemseed ( MSTrace *mst, char *msfile, flag overwrite,
                      int reclen, flag encoding, flag byteorder,
                      flag verbose );

int  mst_writemseedgroup ( MSTraceGroup *msr, char *msfile,
                           flag overwrite, int reclen, flag encoding,
                           flag byteorder, flag verbose );

three icons, three functions, same energy 💫

---

🦋 DESCRIPTION 🦋

so these routines will packed the data contained in the MSRecord, MSTrace or MSTraceGroup into Mini-SEED records and write them to the file you specify. yes, "will packed" — that's the original wording and we respect the author's truth 🙈 the overwrite flag is the one in charge of whether the output file gets overwritten or appended to. it's giving "choose your own adventure" but for file contents.

Mini-SEED records get created using the record length you pass as reclen, plus the Mini-SEED encoding and byteorder. and here's the slay part: if you set any of those key characteristics — record length, encoding format, byte order — to -1, the defaults swoop in and save you. the default values are:

• reclen = 4096 bytes
• encoding = 11 (Steim2)
• byteorder = 1 (MSBF or big-endian)

reclen should be set to the desired data record length in bytes, and it must be expressible as 2 raised to the power of X where X is between (and including) 8 to 20. that's not a vibe suggestion, that's a law of the land 🧚

encoding should be set to one of the following supported Mini-SEED data encoding formats:

• DE_ASCII (0)
• DE_INT16 (1)
• DE_INT32 (3)
• DE_FLOAT32 (4)
• DE_FLOAT64 (5)
• DE_STEIM1 (10)
• DE_STEIM2 (11)

the encoding aliases are defined in libmseed.h. and MSTrace.sampletype should indicated the sample type as either 'a' (ASCII), 'i' (32-bit integers), 'f' (32-bit floats) or 'd' (64-bit doubles). (again, "should indicated" — author's words, we keep them 💜)

now the important part, bestie, listen up: the encoding format must be appropriate for the sample type of the MSTrace samples. for example, Steim compression and integer encoding formats require integer samples, and float encoding formats require the appropriate size floats as input. and as a counter example — and this is the one that gets people every single time — float samples cannot be packed using Steim compression or integer encoding formats. periodt. 💀

byteorder must be either 0 (LSBF or little-endian) or 1 (MBF or big-endian).

verbose controls verbosity — a value of zero will result in no diagnostic output. so if you want silence, you get silence. iconic 🌈

---

⭐ RETURN VALUES ⭐

all of these routines return the number of records written on success and -1 on error. that's it, that's the whole deal — count or -1, no in-between 💅

---

🎀 EXAMPLE 🎀

skeleton code for writing Mini-SEED records with msr_writemseed(3):

main() {
  MSRecord *msr;
  int precords;

  msr = msr_init (NULL);

  /* Populate MSRecord values */
  strcpy (msr->network, "XX");
  strcpy (msr->station, "TEST");
  strcpy (msr->channel, "BHE");
  msr->starttime = ms_seedtimestr2hptime ("2004,350,00:00:00.00");
  msr->samprate = 40.0;
  msr->datasamples = dataptr; /* pointer to 32-bit integer data samples */
  msr->numsamples = 1234;
  msr->sampletype = 'i';      /* declare type to be 32-bit integers */

  /* Write record(s) with 4096-byte length, Steim-2 compression, big-endian */
  precords = msr_writemseed (msr, "output.mseed", 1, 4096, DE_STEIM2, 1, 0);

  ms_log (0, "Wrote %d records0, precords);

  msr_free (&msr);
}

yes, the ms_log line has a missing quote and an extra 0 in there. that's exactly how it appears in the original and we are not touching it — copy-paste-at-your-own-risk energy, iykyk 🙈

---

👑 SEE ALSO 👑

ms_intro(3), msr_pack(3) and mst_pack(3).

---

💜 AUTHOR 💜

Chad Trabant IRIS Data Management Center

---

and that's the whole page, bestie!! this came to you from the Libmseed API, dated 2011/01/06 — a certified classic, lowkey vintage, highkey still relevant 🌸 go write some Mini-SEED records, you're gonna eat 💖✨