Changes between Version 58 and Version 59 of UvmatHelp


Ignore:
Timestamp:
Jun 11, 2013, 7:44:08 AM (7 years ago)
Author:
sommeria
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • UvmatHelp

    v58 v59  
    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.
    1414
    1515 * '''browse_data.fig:''' scans the data directory of a project
     
    1818 * '''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.
    20  * '''series.fig:''' apply various processing functions to series of fields. These functions are stored in the subdirectory /series.
     20 * '''series.fig:''' applies various processing functions to series of fields. A set of functions is integrated in the package as a subdirectory /series, but new functions can be introduced by the user.
    2121 * '''set_object.fig:''' creates and edits geometric objects used to project data: points, lines, planes...
    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, to read files and plot data, and to perform various ancillary tasks. The full set of functions is listed in [#Appendix:overviewofthepackage overview of the package].
    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 
    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 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 **.
     27The present on-line document is the reference document for the version currently available on the svn server. Features not yet implemented or tested (in particular 3D features) are marked by **. The document 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 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’.
    3030
    3131Information is also provided as comments in each function. Type '>>help fct_name'  to get it, or open it with an editor.
     
    7474
    7575 * '''[Run] ''':
    76    * '''[Field series]''': gives access to the GUI '''series.fig''' for analysis of field series
    77    * '''[PIV(CIV)]''':  gives access to the GUI '''civ.fig''' for Particle Imaging Velocimetry
     76   * '''[Field series]''': gives access to the GUI [#a10-Processingfieldseries '''series.fig'''] for processing field series.
     77   * '''[CivX(Fortran)]''':  gives access to the GUI [#a11-PIV:ParticleImagingVelocimetry '''civ.fig'''] for Particle Imaging Velocimetry (CivX version in Fortran).
    7878
    7979 * '''[Help] ''': displays this help file using the Matlab browser.
     
    8484After selection by the browser, the path and file names are determined. The path is split into the two first edit boxes '''[!RootPath]''' and '''[!SubDir],''' while the file name is split into a root name '''[!RootFile]''', file index string '''[!FileIndex]''', and file extension '''[!FileExt]'''. The input file name can be directly entered and modified in these edit boxes, without the browser.
    8585
    86 Once a root name has been introduced, navigation among  the file indices is provided by the red push buttons '''[runplus]''' ( '''[+>]''')  and   '''[runmin] ''' ('''[<-]'''). The central push button '''[run0]''' ('''[0]''') refreshes the current plot. See [#a3.4Navigationamongfileindices section 3.4] for more details.
    87 
    88 When available, the time of each frame or field is displayed in the edit box '''[!TimeValue]''', at the very right. In the case of image pairs, the time interval Dt is displayed between the edit boxes '''[i1], [j1]''' and '''[i2], [j2]'''. This timing information can be read directly in the input file, in the case of movies or Netcdf files, or can be defined in an image documentation file, see [#a3.5Imagedocumentationfiles.xml section 3.5] (in case of conflict, the latter prevails).
     86Once a root name has been introduced, navigation among  the file indices is provided by the red push buttons '''[runplus]''' ( '''[+>]''')  and   '''[runmin] ''' ('''[<-]'''). The central push button '''[run0]''' ('''[!0]''') refreshes the current plot. See [#a3.4Navigationamongfieldindices section 3.4] for more details.
     87
     88When available, the time of each frame or field is displayed in the edit box '''[!TimeValue]''', at the very right. In the case of image pairs, the time interval Dt is displayed between the edit boxes '''[i1], [j1]''' and '''[i2], [j2]'''. This timing information can be read directly in the input file, in the case of movies or Netcdf files, or can be defined in a xml documentation file, see [#a3.5Imagedocumentationfiles.xml section 3.5] (in case of conflict, the latter prevails).
    8989
    9090'''Note: ''' the five last input file names, as well as other pieces of personal information, are stored for convenience in a file (''uvmat_perso.mat'') automatically created in the user preference directory of Matlab (indicated by the Matlab command '>>prefdir'. Browsers then  read default input in this file. A corruption of this file ''uvmat_perso.mat'' may lead to problems for  opening uvmat, type '>>reinit' on the Matlab prompt to delete it and reinitialise the configuration of uvmat.
     
    107107uvmat can read any image format recognised by the Matlab image reading function ''imread.m''. Images can be in true color or B&W, with 8 bit or 16 bit grey levels. Image files containing multiple frames are handled. Movie files can be also opened, using the Matlab function ''!VideoReader.m'', or ''mmreader.m'' for older versions of Matlab.
    108108
    109 ''Uvmat'' can also read various kinds of data in the format Netcdf. Velocity fields obtained by PIV and results of data processing are stored in this format, see [#a7Netcdffilesandget_field.fig section 7] for details. Then different quantities (vorticity, divergence...) can be obtained. The input file type is recognized by the function ''get_file_type.m'' of uvmat and the file is opened by the function ''read_field.m'' according to this file type. it is possible to include new file types by a modification of these two functions.
     109''Uvmat'' can also read various kinds of data in the format Netcdf. Velocity fields obtained by PIV and results of data processing are stored in this format, see [#a7Netcdffilesandget_field.fig section 7] for details. Derived quantities (vorticity, divergence...) can be directly obtained. The input file type is recognized by the function ''get_file_type.m'' of uvmat and the file is opened by the function ''read_field.m'' according to this file type. it is possible to include new input file types by a modification of these two functions.
    110110
    111111The PIV software CIVx requires B&W images in the format png (portable network graphics). It is a binary format for images with lossless (reversible) compression, recommended by w3c (http://www.w3.org/Graphics/PNG). It is an open source patent-free replacement of GIF and can also replace many common uses of TIFF. It can be read directly by all standard programs of image visualisation and processing.  Compressing a raw binary image to its png form typically saves disk storage by a factor of 3.