.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title ".::Gwyddion::dump 3pm"
.TH .::Gwyddion::dump 3pm 2024-03-09 "perl v5.38.2" gwyddion
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Gwyddion::dump \-\- Gwyddion plug\-in proxy dump dumb file format handling.
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.IP "read( filename )" 4
.IX Item "read( filename )"
Read a Gwyddion plug-in proxy dump file.
.Sp
The file is returned as a hash table of dump key, value pairs.
.Sp
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).
.Sp
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.
.IP "write( data, filename )" 4
.IX Item "write( data, filename )"
Write a Gwyddion plug-in proxy dump file.
.Sp
The hash table to write is expected to follow the same conventions as
those returned by \fBread()\fR, please see its description for more.
.Sp
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.