Changes between Version 15 and Version 16 of UvmatHelp


Ignore:
Timestamp:
Jun 1, 2013, 4:42:19 PM (7 years ago)
Author:
sommeria
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • UvmatHelp

    v15 v16  
    99
    1010=== 1.2 The package ===
    11   The master piece is a Matlab GUI, made of a Matlab figure '''uvmat.fig''' and an associated set of sub-functions in the file {uvmat.m}. The menu bar at the top of the GUI, push buttons and editing box in  '''uvmat.fig''' activate the Matlab sub-functions (callback functions) in {uvmat.m}.  The package also contains the following set of GUI (see [overview of the package->#overview] for a complete list).
    12 
    13 -'''browse_data.fig''' scans the data directory of a project - '''civ.fig:''' runs the software for Particle Imaging Velocimetry  - '''editxml.fig:'''  displays and edits xml files according to an xml schema. xml reading and editing is performed by the toolbox [xmltree->http://www.artefact.tk/software/matlab/xml/] , copied in the subdirectory /@xmltree. - '''geometry_calib.fig''': determines geometric calibration parameters for relating image to physical coordinates. The toolbox [->http://www.vision.caltech.edu/bouguetj/calib_doc/] is used, copied in the subdirectory /toolbox_calib.  - '''get_field.fig:''' selects coordinates and field in a general NetCDF file. The subdirectory /get_field contains functions called by the GUI get_field. - '''series.fig:''' apply various processing functions to series of fields. These functions are stored in the subdirectory /series. -'''set_object.fig:''' creates and edits geometric objects used to project data: points, lines, planes... -'''view_field.fig:''' is a GUI complementing uvmat for plotting projected data.
     11  The master piece is a Matlab GUI, made of a Matlab figure '''uvmat.fig''' and an associated set of sub-functions in the file ''uvmat.m''. The menu bar at the top of the GUI, push buttons and editing box in  '''uvmat.fig''' activate the Matlab sub-functions (callback functions) in ''uvmat.m''.  The package also contains the following set of GUI (see [#Appendix:overviewofthepackage: overview of the package] for a complete list).
     12
     13 * '''browse_data.fig''' scans the data directory of a project
     14 *  '''civ.fig:''' runs the software for Particle Imaging Velocimetry 
     15 * '''editxml.fig:'''  displays and edits xml files according to an xml schema. xml reading and editing is performed by the toolbox [xmltree->http://www.artefact.tk/software/matlab/xml/] , copied in the subdirectory /@xmltree.
     16 * '''geometry_calib.fig''': determines geometric calibration parameters for relating image to physical coordinates. The toolbox [->http://www.vision.caltech.edu/bouguetj/calib_doc/] is used, copied in the subdirectory /toolbox_calib. 
     17 * '''get_field.fig:''' selects coordinates and field in a general NetCDF file. The subdirectory /get_field contains functions called by the GUI get_field.
     18 * '''series.fig:''' apply various processing functions to series of fields. These functions are stored in the subdirectory /series. 
     19 * '''set_object.fig:''' creates and edits geometric objects used to project data: points, lines, planes...
     20 * '''view_field.fig:''' is a GUI complementing uvmat for plotting projected data.
    1421
    1522  Functions in the package are used to generate file names, read files and plot data, and perform various ancillary tasks.
     
    1724=== 1.3 Documentation and help ===
    1825  The present on-line file is the reference document for the version currently available on the svn server. A html version ({uvmat_doc.html}) of this document is provided with the package, and accessible by help buttons in the GUIs.
    19     A short comment about  each GUI uicontrol (push buttons, edit boxes, menus..), as well as the tag name of this uicontrol, is provided as a tool tip window by moving the mouse over it. In the present help document, the tags of GUI uicontrols are quoted as '''[uicontrol tag]''', names of files in the package are quoted as {fct name.m}, and commands on the Matlab workspace as  '>> command’  . Features not yet implemented or tested (in particular 3D features) are marked by **.
     26    A short comment about  each GUI uicontrol (push buttons, edit boxes, menus..), as well as the tag name of this uicontrol, is provided as a tool tip window by moving the mouse over it. In the present help document, the tags of GUI uicontrols are quoted as '''[uicontrol tag]''', names of files in the package are quoted as ''fct name.m'', and commands on the Matlab workspace as  '>> command’  . Features not yet implemented or tested (in particular 3D features) are marked by **.
    2027
    2128  Information is also provided as comments in each function. Type '>>help fct_name'  to get it, or open it with an editor.
    2229
    23   Finally a on-line [tutorial->105] is also provided with test images and data files.
     30  Finally a on-line [http://servforge.legi.grenoble-inp.fr/projects/soft-uvmat/wiki#Tutorial tutorial] is provided with test images and data files.
    2431
    2532=== 1.4 Copyright and licence ===