Changes between Version 21 and Version 22 of UvmatHelp


Ignore:
Timestamp:
Jun 1, 2013, 11:00:02 PM (11 years ago)
Author:
sommeria
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • UvmatHelp

    v21 v22  
    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.
    7 
    8   This 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.
    9 
    10   Installation is described in [http://servforge.legi.grenoble-inp.fr/projects/soft-uvmat/wiki#UVMAT].
     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 xml documentation files. Stereoscopic PIV, PIV-LIF and 3D PIV in a volume (still under development) are handled.
     7
     8This 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.
     9
     10Installation is described in [http://servforge.legi.grenoble-inp.fr/projects/soft-uvmat/wiki#UVMAT].
    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 [xmltree->http://www.artefact.tk/software/matlab/xml/] , 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] , 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.
    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.
    … …  
    2222 * '''view_field.fig:''' is a GUI complementing uvmat for plotting projected data.
    2323
    24   Functions in the package are used to generate file names, read files and plot data, and perform various ancillary tasks.
     24Functions in the package are used to generate file names, read files and plot data, and perform various ancillary tasks.
    2525
    2626=== 1.3 Documentation and help ===
    27   The 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.
    28    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 **.
    29 
    30   Information is also provided as comments in each function. Type '>>help fct_name'  to get it, or open it with an editor.
    31 
    32   Finally a on-line [http://servforge.legi.grenoble-inp.fr/projects/soft-uvmat/wiki#Tutorial tutorial] is provided with test images and data files.
     27The 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.
     28
     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 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 **.
     30
     31Information is also provided as comments in each function. Type '>>help fct_name'  to get it, or open it with an editor.
     32
     33Finally a on-line [http://servforge.legi.grenoble-inp.fr/projects/soft-uvmat/wiki#Tutorial tutorial] is provided with test images and data files.
    3334
    3435=== 1.4 Copyright and licence ===