Changes between Version 31 and Version 32 of UvmatHelp


Ignore:
Timestamp:
Jun 2, 2013, 6:21:39 PM (7 years ago)
Author:
sommeria
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • UvmatHelp

    v31 v32  
    5252The red pushbuttons command the main actions. The color of pushbuttons or other elements turns to yellow while their callback is active.
    5353
    54 === 2.2 The menu bar ===
     54=== 2.2 The upper menu bar ===
    5555The menu bar at the top of the GUI contains the following buttons:
    5656
    5757 * '''[Open]''': gives access to the browser for the main input field. 
    5858   * '''[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.
    59    * '''[browse campaign...]''':  scan the data organised as a project/campaign, see [wiki:#a3.7Dataorganisationinaproject:section 3.7 section 3.7].
     59   * '''[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.
    6161
    6262 * '''[Open_1] ''': used like '''[Open]''' to select a second field, for comparisons with the main one.
    6363
    64  * '''[Export] ''': used to export the displayed data, either as arrays in the Matlab workspace, either as a figure or a movie (for a succession of views).
     64 * '''[Export] ''': used to export the currently displayed data, either as array structure in the Matlab workspace, either as a figure or a movie (for a succession of views), or plotted on an existing figure (axes) for comparison with previous data.
    6565
    6666 * '''[Projection object] ''': used to create projection objects (points, lines, patches, gridded planes) for data analysis and interpolation
     
    7777   * '''[PIV(CIV)]''':  gives access to the GUI '''civ.fig''' for Particle Imaging Velocimetry
    7878
    79  * '''[Help] ''': displays the html help file
     79 * '''[Help] ''': displays this help file using the Matlab browser.
    8080
    8181<doc58|center>
    8282
    8383=== 2.3 Displaying the input file name ===
    84   After selection by the browser,  the path and file names are determined. The path is splitted 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 by these edit boxes, without the browser.
    85 
    86   Once a root name has been introduced, navigation among  the file indices is provided by the red push buttons '''[runplus]''' ( '''[+>]''')  and   '''[runmin] ''' ('''<HTML>[ <-]</HTML>'''). The central push button '''[run0]''' ('''[0]''') refreshes the current plot. See [section 3.4->#sec3.4] for more details.
    87 
    88 When available, the time of each frame or field is displayed in the edit box '''[abs_time]''', 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 [section 3.5->#sec3.5] (in case of conflict, the latter prevails).
    89 
    90 -'''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.
     84After 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.
     85
     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 [wiki:#a3.4Navigationamongfileindices: 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 an image documentation file, see [wiki:#a3.5Imagedocumentationfiles.xml: section 3.5] (in case of conflict, the latter prevails).
     89
     90-'''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.
    9191
    9292=== 2.4 General tools ===
    93 -'''Mouse motion:''' the local coordinates and field values are obtained by moving the mouse over a plotting axes. They are displayed in the text box '''[text_display]''' on the upper right.
    94 
    95 -'''Zoom:''' is activated by selecting the check box '''[CheckZoom]''' on the upper right. Zoom in by pressing the left mouse button on the graph. Zoom out by pressing the right mouse button. A zoomed region can be displayed as a new figure by drawing a rectangle with the mouse, while pressing the left mouse button (release the button to stop drawing). The zoomed region can be translated  through the initial field by pressing the directional arrows of the key board.
    96 
    97 -'''Graph limits:''' they automatically adjust to the field when the check box '''[CheckFixLimits]''' is not selected (default). Otherwise they remain fixed, and can be adjusted by the check boxes '''[num_MinX]''', '''[num_MaxX]''', '''[num_MinY]''', '''[num_MaxY]'''.
    98 
    99 -'''Coordinate aspect ratio:''' when '''[CheckFixAspectRatio]''' is selected (the default option for images), the scale ratio for the  x and y coordinates is fixed to 1 by default (it can be manually adjusted by the edit box '''[num_AspectRatio]'''. When '''[CheckFixAspectRatio]''' is not selected the graph scales along x and y automatically adjust to the figure size.
    100 
    101 -'''Extracting graphs:'''   The graph displayed in the central window can be copied to a separate figure by pressing the menu bar command '''[Export/extract figure]'''. This allows plot editing, exporting in image format and printing, using standard Matlab graphic tools. A movie can be produced using the command [Export/make movie avi].
    102 
    103 -'''Extracting data''' as Matlab arrays. Information stored in the GUI uvmat  (as 'UserData' in the figure) can be extracted in the Matlab work space by the menu bar command  '''[Export/field in workspace]''' (or by pressing the right mouse button on the GUI). Type '>>Data_uvmat.Field' to get the current input field as a Matlab structure. An image or scalar matrix is for instance obtained as Data_uvmat.Field.A.
    104 
    105 [<doc115|right>->#top]
     93 * '''Mouse motion:''' the local coordinates and field values are obtained by moving the mouse over a plotting axes. They are displayed in the text box '''[text_display]''' on the upper right.
     94
     95 * '''Zoom:''' is activated by selecting the check box '''[!CheckZoom]''' on the upper right. Zoom in by pressing the left mouse button on the graph. Zoom out by pressing the right mouse button. Alternatively, a zoomed region can be displayed as a separate figure by selecting '''[!CheckZoomFig]''' and  drawing a rectangle with the mouse. The zoomed region can be translated  through the initial field by pressing the directional arrows of the keyboard.
     96
     97 * '''Graph limits:''' they automatically adjust to the field when the check box '''[!CheckFixLimits]''' is not selected (default). Otherwise they remain fixed, and can be adjusted by the check boxes '''[num_MinX]''', '''[num_MaxX]''', '''[num_MinY]''', '''[num_MaxY]'''.
     98
     99 * '''Coordinate aspect ratio:''' when '''[!CheckFixAspectRatio]''' is selected (the default option for images), the scale ratio for the  x and y coordinates is fixed to 1 by default (it can be manually adjusted by the edit box '''[num_AspectRatio]'''. When '''[CheckFixAspectRatio]''' is not selected the graph scales along x and y automatically adjust to the figure size.
     100
     101 * '''Extracting graphs:'''   The graph displayed in the central window can be copied to a separate figure by pressing the menu bar command '''[Export/extract figure]'''. This allows plot editing, exporting in image format and printing, using standard Matlab graphic tools. Plots can be also exported on an existing figure for data comparison, using the option '''[Export/export on axis]'''. A movie can be produced using the command [Export/make movie avi].
     102
     103 * '''Extracting data''' as Matlab arrays. Information stored in the GUI uvmat  (as 'UserData' in the figure) can be extracted in the Matlab work space by the menu bar command  '''[Export/field in workspace]''' (or by pressing the right mouse button on the GUI). Type '>>Data_uvmat.Field' to get the current input field as a Matlab structure. An image or scalar matrix is for instance obtained as Data_uvmat.Field.A.
     104
    106105
    107106== 3 Input files and navigation with uvmat ==