.::Gwyddion::dump(3pm)

💖 NAME 💖

Gwyddion::dump — bestie, this is the module that handles the Gwyddion plug-in proxy dump dumb file format. That's a whole lot of words, but basically: it reads and writes those dump files for you. Slay. ✨

It lives in the gwyddion manual, section 3pm, iykyk.

---

🌸 FUNCTIONS 🌸

🦋 read( filename )

Read a Gwyddion plug-in proxy dump file. That's it, that's the job. 🎀

The file comes back to you as a hash table of dump key, value pairs. Fr fr.

The data fields are packed as references to hashes, and those hashes can have these keys — and lowkey, not all of them have to be present, so don't come for me if one's missing:

• xres — the x-resolution, counted in number of samples
• yres — the y-resolution, counted in number of samples
• xreal — the real x size, in base SI units
• yreal — the real y size, in base SI units
• unit-xy — the lateral units, base SI, like m
• unit-z — the value units, base SI, like m or A
• data — the data field data itself, which is an array of floats

⚠️ okay so important: fatal errors are not handled. The function literally just dies. So if you have anything meaningful to do after a fatal error, you have to catch the error yourself. No cap. 💀

💅 write( data, filename )

Write a Gwyddion plug-in proxy dump file. The glow-up direction this time. ✨

The hash table you hand it is expected to follow the same conventions as the ones returned by read(), so bestie, go peek at that description above for the details. 👑

⚠️ same deal as before: fatal errors are not handled, the function simply dies. If you've got anything meaningful to do after a fatal error, you have to catch the error. Periodt. 🙈

---

so that's the whole page, my love — this was Perl v5.40.1 energy, dated 2025-05-22, straight from the gwyddion manual. 🫶🌸 Go read some dump files, you absolute icon. 💖