API Reference

API Reference#

This section will focus on developer information as well as how to use the program. PyGMI was not really originally designed to be used like a conventional library, since it is GUI orientated. I have, however, exposed some functionality to allow access to its routines.

Quick Summary:

  • Many routines make use of the PyGMI Data class, which can be found in pygmi.raster.datatypes.

  • Import and export routines can be found in modules names iodefs - for example pygmi.raster.iodefs, pygmi.vector.iodefs and pygmi.rsense.iodefs.

  • Once data is imported, it can be used in the relevant function.

  • As a general rule of thumb, most classes in PyGMI relate to the GUI. The functions are not GUI related and may, therefore, be more useful for developers.

This page contains auto-generated API reference documentation [1].