Gwyddion Module Overview

Gwyddion Module Overview — Overview of Gwyddion modules

Overview

Gwyddion is quite a modular application. In fact, most of its basic functionallity is provided by modules. Modules allow to easily extend Gwyddion without the need to recompile. Modules need to be copied in appropriate directories only followed by Gwyddion restart. Modules are then automatically detected, registered and the functions provided by modules are added to Gwyddion menu.

There are several distinct module types:

  • data processing modules – these modules provide functions for processing of two-dimensional data arrays (e. g. fast fourier transform module), or changing the graphical presentation of data (e. g. shading module). Data processing modules usually get data (e. g. two-dimensional field of SPM data), ask for processing options and do requested data processing. For more interactive use, we recommend to use tool module type.

  • file loading and saving modules

  • graph modules – these modules are used to process special class of data in the apllication – graphs of one-dimensional functions (e. g. profiles obtained by Profile selection tool).

  • tool modules – tools are modules extended to provide more interactive interface (namely connected with selections by mouse). This means ability of active recomputation of the requested parameters while creating and changing selections on the original data (e. g. read value tool, three-point leveling tool).

  • layer modules – FIXME

The types above are in fact function types, not module types. One module can provide a single function or a whole bunch of completely unrelated functions, even of different type. However, it's usual to group functions containing considreable amount of common code to one module to allow its sharing, and use separate modules for unrelated functions.

More precisely, a file (i.e., a shared/dynamically linked library) always corresponds to a one Gwyddion module. A module can register zero or more functions (features).