Changes between Version 42 and Version 43 of UvmatHelp


Ignore:
Timestamp:
Jun 5, 2013, 9:34:43 PM (11 years ago)
Author:
sommeria
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • UvmatHelp

    v42 v43  
    44== 1 Generalities ==
    55=== 1.1 Aim ===
    6 The package uvmat can be used to visualise, scan and analyse a wide variety of input data: all image and movie formats recognised by Matlab (see [#a3.1Inputdataformats section 3.1]),  NetCDF binary files(see [#a7.1TheNetCDFformat: section 7]). It is however particularly designed for laboratory data obtained  from imaging systems: it includes a Particle Image Velocimetry  software, as well as tools for geometric calibration, masks, grid generation and image pre-processing (e.g. background removal), and editing xml documentation files. Stereoscopic PIV, PIV-LIF and 3D PIV in a volume (still under development) are handled.
     6The package uvmat can be used to visualise, scan and analyse a wide variety of input data: all image and movie formats recognised by Matlab (see [#a3.1Inputdataformats section 3.1]),  NetCDF binary files(see [#a7.1TheNetCDFformat: section 7]). It is however particularly designed for laboratory data obtained  from imaging systems: it includes a Particle Image Velocimetry  software, as well as tools for geometric calibration, masks, grid generation and image pre-processing (e.g. background removal), and editing documentation files in the format xml. Stereoscopic PIV, PIV-LIF and 3D PIV in a volume (still under development) are handled.
    77
    88This package can be used without knowledge of the Matlab language, but it is designed to be complemented by user defined Matlab functions, providing flexibility for further data analysis. It provides convenient tools to develop a set of processing functions with a standardised system for input-output.
     
    1111
    1212=== 1.2 The package ===
    13 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).
     13The 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).
    1414
    1515 * '''browse_data.fig''' scans the data directory of a project
    1616 * '''civ.fig:''' runs the software for Particle Imaging Velocimetry
    17  * '''editxml.fig:'''  displays and edits xml files according to an xml schema. xml reading and editing is performed by the toolbox [http://www.artefact.tk/software/matlab/xml/ xmltree] , copied in the subdirectory /@xmltree.
    18  * '''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 * '''editxml.fig:'''  displays and edits xml files according to an xml schema. xml reading and editing is performed by the toolbox [http://www.artefact.tk/software/matlab/xml/ xmltree], integrated in the package ''uvmat' as a subdirectory /@xmltree.
     18 * '''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, integrated in the package ''uvmat'' as a subdirectory /toolbox_calib.
    1919 * '''get_field.fig:''' selects coordinates and field in a general NetCDF file.
    2020 * '''series.fig:''' apply various processing functions to series of fields. These functions are stored in the subdirectory /series.
     
    2727The present on-line file is the reference document for the version currently available on the svn server. It is accessible within Matlab by help buttons in the GUIs.
    2828
    29 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 **.
     29A 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 tag of a GUI uicontrol is quoted as '''[uicontrol tag]''', a file name in the package is 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 **.
    3030
    3131Information is also provided as comments in each function. Type '>>help fct_name'  to get it, or open it with an editor.
     
    4242== 2 Overview of the GUI uvmat.fig ==
    4343=== 2.1 Opening the GUI ===
    44 Type '>>uvmat' in the Matlab prompt to display the GUI. If the function is unknown by Matlab, add the appropriate path (see the Matlab command '>>help path'). When the GUI is opening, the date of last modfication is displayed in the central window. During opening, the program checks the Matlab path to all the functions of the package (using the function ''check_functions.m''). If a function is missing, or if it is overridden by a function with the same name at another path location, a message is  displayed in the central window at the opening of the  GUI '''uvmat.fig'''. Finally, if the svn server is availlable,  the latest version number of the uvmat package is indicated (if  a line-command version of svn is available).
     44Type '>>uvmat' in the Matlab prompt to display the GUI. If the function is unknown by Matlab, add the appropriate path (see the Matlab command '>>help path'). When the GUI is opening, the date of last modfication is displayed in the central window. During opening, the program checks the Matlab path to all the functions of the package (using the function ''check_functions.m''). If a function is missing, or if it is overridden by a function with the same name at another path location, a message is  displayed in the central window at the opening of the  GUI '''uvmat.fig'''. Finally, if the svn server is accessible by line-command, the latest version number of the uvmat package is indicated.
    4545
    4646<img55|center>
    4747
    48 The GUI contains an upper menu bar, a central display window, a lower left window for histogram, edit boxes and command buttons.
    49 
    50 Each of theses graphic elements is described by a tag name, which can be displayed by moving the mouse over it: a tool tip window appears with the tag name followed by a short help description. The element tag and content can be also displayed in a zoom window, and possibly edited there, by a right hand mouse selection on the element. As a rule, tag names for checkboxes begins by 'Check', while tags of elements with numerical content begins by 'num_'.
    51 
    52 The red pushbuttons command the main actions. The color of pushbuttons or other elements turns to yellow while their callback is active.
     48The GUI contains an upper menu bar, a central graphic display window, a lower left window for histogram, a top right text display window, columns of edit boxes and command buttons on both side.
     49
     50Each of the graphic elements (''uicontrols'') is described by a ''tag name'', which can be displayed by moving the mouse over it: a tool tip window appears with the tag name followed by a short help description. The element tag and content can be also displayed in a zoom window, and possibly edited there, by a right hand mouse selection on the element. As a rule, tag names for checkboxes begins by 'Check', while tags of elements with numerical content begins by ''num_''.
     51
     52The red pushbuttons command the main actions. The color of pushbuttons or other elements turns to yellow while their ''callback function'' is active.
    5353
    5454=== 2.2 The upper menu bar ===
     
    5656
    5757 * '''[Open]''': gives access to the browser for the main input field. 
    58    * '''[browse...]''': open a general file browser ''browser_uvmat''. A path can be directly entered by copy-paste in the upper edit window of the browser. In the list of files, directories are marqued by '+/'.  Select the first line '+/..' to move up in the directory tree, and the arrow <-- to move backward. The dates of file creation can be displayed by pressing the button '''[dates]'''. file ordering by name or date can be chosen by the popumenu above.
     58   * '''[browse...]''': open a general file browser ''browser_uvmat''. In the displayed list, a file can be selected for opening  (by a single mouse click),or directories are marqued by '+/'.  Select the first line '+/..' to move up in the directory tree, and the arrow <-- to move backward. The dates of file creation can be displayed by pressing the button '''[dates]'''. file ordering by name or date can be chosen by the popumenu above. A path can be directly entered by copy-paste in the upper edit window of the browser.
    5959   * '''[browse campaign...]''':  scan the data organised as a project/campaign, see [wiki:#a3.7Dataorganisationinaproject section 3.7].
    6060   *  Previously opened fields are memorised in the menu and can be  directly selected again.