Gwyddion Application Library Reference Manual: Gwyddion Application Library Reference Manual

For Gwyddion 3.6. The latest version of this document can be found on-line at http://gwyddion.net/documentation/libgwyapp/.

Main Program and Resources

gwyapp — Library initialisation
app — Core application interface, window management
settings — Application and module settings
GwyResourceEditor — Base/helper class for resource editors
GwyGradientEditor — Color gradient editor
menu — Menu and sensitivity functions
help — User guide access
logging — Program message log

Data Management

GwyFile — Dictionary representing a data file
Data browser — Manage files and data in them
File operations — High level file functions
filelist — Document history
GwyAppImageWindow — Windows for data shown as images
GwyAppGraphWindow
Metadata browser — Display and edit data object metadata
undo — Undo and redo facility
Log — Logging data processing operations
Log browser — Display data processing history
Validate — Check data sanity and consistency

Gwyddion Module Library

Module loader — Basic module loader interface
Module browser — Gwyddion module browser
File modules — File loading and saving modules
module-process
Tool modules — Interactive tool modules
Graph modules — Graph modules
Synthetic data modules — Synthetic data modules
Volume data modules — Volume data processing modules
XYZ data modules — XYZ surface data processing modules
Curve map modules — Curve map data processing modules

Module Utilities

GwyParamDef — Module parameter definitions
GwyParams — Module parameter value sets
GwyParamTable — User interface for parameter sets
GwyParamResource — Resources holding set of parameters
GwyDialog — Data processing module dialog
GwyTool — Base class for tools
GwyPlainTool — Base class for simple tools
Module utilties — Module utility functions
File module utils — Utility functions for file modules
Synth module utils — Helper functions for data synthesis modules
GwyDataChooser — Data object choosers
GwyResultsExport — Controls for value set export
wait — Informing the world we are busy

Gwyddion Module Tutorial

Gwyddion Module Overview — Overview of Gwyddion modules
Minimal Module — Dissection of a minimal Gwyddion data processing module
Beyond the Minimal Module — Common module idioms
Data Processing Modules — More about data processing modules
File Modules — More about file modules
Graph Modules — More about graph modules
Tool Modules — More about tool modules
Gwyddion Module Installation — Compilation, distribution and installation of Gwyddion modules

Index of all symbols

Annotation Glossary