Help system

PyRAT has a built-in help system, which allows to browse the content of its modules and to display help of individual functions. This is entirely based on the docstrings of each routine, so if these are not existing in the code, no help is available. Consequently your mileage will vary! Dear programmers: please add (good, meaningful) docstrings.

>>> help()                      [list of the available commands and modules]       
>>> help(function)    	        [help for a specific function] 
>>> help(module)                [list of the available functions of a module]
>>> help(module.function)    	[help for a specific function in a module]

Currently, the follwing modules are existing in PyRAT:

• load: Importing / reading data sets
• save: Exporting / writing data to disc
• filter: Various image manipulations.
• transform: Geometrical transforms
• insar: Interferometric processing routines
• polsar: Polarimetric routines
• plugins: The plugin interface routines

---

To list all existing data layers, use listlayer() or info():

>>> info()
/L1	Disc	D	float32	(2432, 6144)
/L2	Disc	D	float32	(4864, 12288)