NAME¶

Gwyddion::dump -- Gwyddion plug-in proxy dump dumb file format handling.

FUNCTIONS¶

read( filename )

Read a Gwyddion plug-in proxy dump file.

The file is returned as a hash table of dump key, value pairs.

Data fields are packed as references to hashes with following keys (not all has to be present): `xres' (x-resolution, in number of samples), `yres' (y-resolution, in number of samples), `xreal' (real x size, in base SI units), `yreal' (real y size, in base SI units), `unit-xy' (lateral units, base SI, like `m'), `unit-z' (value units, base SI, like `m' or `A'), `data' (the data field data itself, an array of floats).

Fatal errors are not handled, the function simply dies. If you have anything meaningful to do after a fatal error, you have to catch the error.

write( data, filename )

Write a Gwyddion plug-in proxy dump file.

The hash table to write is expected to follow the same conventions as those returned by read(), please see its description for more.

Fatal errors are not handled, the function simply dies. If you have anything meaningful to do after a fatal error, you have to catch the error.