[[TOC]]
= wxIClass =

'''wxIClass''' is a wxGUI extension. ''Generates spectral signatures for an image by allowing the user to outline regions of interest. The resulting signature file can be used as input for i.maxlik or as a seed signature file for i.cluster.'' (cited from i.class manual)

wxIClass should have similar functionality as [http://grass.osgeo.org/grass64/manuals/html64_user/i.class.html i.class]. Don't be confused with older wxGUI i.class implementation wx.class ([http://trac.osgeo.org/grass/browser/grass-addons/gui/wxpython/wx.class addons], [http://grass.osgeo.org/wiki/WxPython-based_GUI_for_GRASS#wx.class wiki]). wxIClass should replace wx.class.

It will be available in GRASS 7. Now it is in the first development phase and it is developed in private repository. It will be moved to trunk when it's basic functionality is available.

{{{
#!comment
It's available from the menu "File | ".
}}}

== Naming conventions ==
 * module name
  * User friendly name should be found.
  * In the implementation wxIClass is used (and IClass or iclass in C implementation).
  * Now ''Classification'' is used as window title.
 * terms in user interface
  * Map window panes are called ''Preview Displays'' and ''Training Areas Display''.
  * Term ''class'' is used.
 * conventions in implementation
  * C
   * Function names start with `I_iclass_`. (`I` for imagery).
   * Structure names start with `Iclass_`.
   * Term ''category'' is used instead of ''class'' because it is determined by CAT column (rule taken from old `i.class`).
  * Python
== User wiki ==

See also '''[http://grass.osgeo.org/wiki/WxGUI_IClass GRASS User Wiki]''' page (TODO).

== Implemented features ==
 * Main window (`MapFrame`) with two maps and area for plots (similar to i.class window) and with statusbar and toolbar similar to GCP
 * C functions for wxIClass in `lib/imagery`
  * computing statistics (mean, ...)
  * creating raster map
  * simple API for Python
  * saving signature file (writing signature file seems to be broken in old i.class, fixed now)
  * works for multiple classes (categories) and multiple training areas (i.class worked only for one training area)
 * Plots pane showing histograms and coincidence plots (using `PyPlot`)
 * class (category) manager
  * name settings
  * color settings
 * layer management --- one for each display (add, delete, set opacity, move layer to top)
 * ability to change the standard deviation multiplier ("matching" raster map is redrawn)
 * digitizer is integrated into training map display (works, but segfaults when deleting)
 * automatic vector map and raster maps management
  * they are temporary (they are deleted when closing window)
  * they gets unique names (common part and unique number)
   * unique part is from `g.tempfile` function
   * for vector dot from `g.tempfile` is removed
== Planned features ==
 * something like layer manager for both mapwindows (Training and Preview)
  * substituted by combo box (moves map layer to top and sets active map for opacity changing and deleting)
  * better layer order management than with combo box
  * additional functionality
   * copying (or moving) layers from one mapwindow to the second one
 * importing/exporting vector map (also exporting raster could be useful)
 * importing existing signature file (see [http://grass.osgeo.org/grass64/manuals/html64_user/i.class.html i.class manual])
 * dialog to show generated signature file
 * removing subgroup from user interface
=== Digitizer requirements ===
 * add area
 * edit area
 * remove area
  * in user interface removing boundary and centroid separately is inconvenient
  * wxIClass needs removing areas by category
 * undo/redo (would be nice to have)
 * do not add database record for feature

The best solution is probably a set of common classes like `IVDigit` and `IVDigitWindow` which provide all but customizable digitizing functionality. Then wxIClass digitizer part can use some parameters and overriding of inherited methods to customize digitizer. Overriding need to be used e. g. in places where standard digitizer uses `UserSettings`.
== Roadmap ==

 * Refactoring of `MapFrame`s a `MapWindow`s (`mapdisp*.py`, `gcpmapdisp*.py`)
  * reason: creating common `MapFrame` base class and allow specializing in modules like GCP (georectifier) or wxIClass
  * separating statusbar functionality: r48703
  * GCP: r48713, r48764
  * moving code to `MapFrameBase`: r48763, r48769
  * toolbar access methods: r48765, r48766
 * Create/edit imagery group dialog
  * r48891, r48905 (and backport r48915)
 * Digitizer customization
  * r49121, r49152

{{{
#!comment
Overview of commits [http://trac.osgeo.org/grass/log/grass/trunk/gui/wxpython/gui_modules/gmodeler.py here].
}}}

== List of tickets ==

[[TicketQuery(component=wxGUI&keywords=iclass&order=priority)]]