Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
.::Gwyddion::dump(3)		   gwyddion		  .::Gwyddion::dump(3)

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.

perl v5.24.1			  2016-02-01		  .::Gwyddion::dump(3)

NAME | FUNCTIONS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Gwyddion::dump&sektion=3pm&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help