| 334 | | * (optional) '''!ListGlobalAttribute:''' list (cell array of character strings) of the names of global attributes Att_1, Att_2... |
| 335 | | * (mandatory) '''!ListVarName:''' list of the variable names Var_1, Var_2....(cell array of character strings). |
| 336 | | * (mandatory) '''!VarDimName:''' list of the dimensions associated with each variable: this is a cell array whose number of element is equal to that of '''!ListVarName'''. Each element is the dimension name for a unidimensional variable, or a cell array specifying the list of dimension names for a multidimensional variable. |
| 337 | | * (optional) '''!VarAttribute:''' cell array of structures of the form !VarAttribute{ivar}.key=value, defining an attribute tag name and value for the variable #ivar (variable number in the list !ListVarName]). |
| | 334 | * (optional) '''ListGlobalAttribute:''' list (cell array of character strings) of the names of global attributes Att_1, Att_2... |
| | 335 | * (mandatory) '''ListVarName:''' list of the variable names Var_1, Var_2....(cell array of character strings). |
| | 336 | * (mandatory) '''VarDimName:''' list of the dimensions associated with each variable: this is a cell array whose number of element is equal to that of '''ListVarName'''. Each element is the dimension name for a unidimensional variable, or a cell array specifying the list of dimension names for a multidimensional variable. |
| | 337 | * (optional) '''VarAttribute:''' cell array of structures of the form !VarAttribute{ivar}.key=value, defining an attribute tag name and value for the variable #ivar (variable number in the list !ListVarName]). |
| 417 | | These are geometrical objects used to define cuts along lines or planes, to interpolate fields on a regular grid, to restrict the analysis or visualisation to field subregions. When a 2D or 3D field is opened by uvmat, a default projection plane object is created. New objects are created by the menu bar command '''[Projection object]''' in '''uvmat.fig'''. The creation of a new object ('''points''', '''line'''....) can be initiated by selecting the corresponding item in the menu. Alternatively, an existing xml object file can be opened by selecting the menu option '''[browse...]'''. |
| 418 | | |
| 419 | | In each case an auxiliary GUI '''set_object.fig''' describing the object properties appears, see next [#a6.2Objectproperties sub-section] for their definitions. This GUI can be directly edited and object coordinates can be set by mouse drawing on the plot. In the latter case, refresh the plots by pressing''' [PLOT] ''' in '''set_object.fig''' . Objects can be saved as xml files with the button ''' [SAVE]''' of '''set_object.fig'''. |
| 420 | | |
| 421 | | The projection of fields on objects is performed by the function ''proj_field.m'', which can be used also in data processing. The projected field from a projection object drawn in the main plotting window of uvmat will be plotted in the secondary plotting GUI '''view_field.fig'''. The list of currently opened projection objects is displayed in the menus '''[!ListObject]''' and '''[!ListObject_1]''' at the bottom right of '''uvmat.fig'''. One object can be selected in each of these menus: the projection on the object selected in '''[!ListObject]''' is viewed in '''uvmat.fig''' while that of the object selected in '''[!ListObject_1]''' is viewed in '''view_field.fig'''. All the created objects are sketched in both views, except the one generating the currently plotted field (see [subsection 6.4->#sec6.4] for object representation). The active objects are plotted in magenta, while the inactive ones are in blue. |
| 422 | | |
| 423 | | Objects can be viewed, edited, deleted...Also extracted as a Matlab structure using the menu bar command '''[Export]'''. |
| | 417 | These are geometrical objects used to define cuts along lines or planes, to interpolate fields on a regular grid, to restrict the analysis or visualisation to field subregions. The projection of fields on objects is performed by the function ''proj_field.m'', which can be used as well in data processing outside the GUI '''uvmat''', using for instance [#a10-Processingfieldseries series.fig]). |
| | 418 | |
| | 419 | When a 2D or 3D field is opened by '''uvmat;fig''', a default projection object called 'plane' is created, so that all field plots (in 2D and 3D) are considered as the result of a projection. New objects are created by the menu bar command '''[Projection object]''' in '''uvmat.fig'''. The creation of a new object ('''points''', '''line'''....) can be initiated by selecting the corresponding item in the menu. Alternatively, an existing xml object file can be opened by selecting the menu option '''[browse...]'''. In each case an auxiliary GUI '''set_object.fig''' describing the object properties appears, see next [#a6.2Objectproperties sub-section] for their definitions. This GUI can be directly edited and object coordinates can be set by mouse drawing on the plot, see [#a6.4Objectrepresentation section 6.4]. To validate edition on the GUI '''set_object.fig''', refresh the plots by pressing '''[REFRESH]'''. Objects can be saved as xml files with the (upper right) button '''[SAVE]''' of '''set_object.fig'''. |
| | 420 | |
| | 421 | The names of the created objects are listed in the menu '''[!ListObject]'''. The properties of the object selected in this menu can be viewed by activating the check box '''[CheckViewObject]'''. Check '''[CheckEditObject]''' to allow object editing with '''set_object.fig'''. The selected object is plotted in magenta, while the inactive ones are in blue. The field plot resulting from projection can be viewed in the GUI view_field.fig by activating '''[CheckViewField]'''. This option is automatically selected when a new object is created. Then the projection object used for the main plotting window in uvmat can be selected by the menu '''[!ListObject_1]''' which reproduces the list of available objects. The active objects are plotted in magenta, while the inactive ones are in blue.The object can be deleted by pressing '''[DeleteObject]'''. |
| | 422 | |
| | 423 | The properties of the projection objects can be extracted as a Matlab structure using the menu bar command '''[Export/field in workspace]''' of '''uvmat.fig'''. Those are contained in the cell of structures ''Data_uvmat.ProjObject''. |
| 487 | | * 'line' , 'polyline' are plotted as lines, surrounded by two dashed lines showing the range of projection, when applicable (i.e. not in the case !ProjMode='interp |
| 488 | | * 'polygon', 'rectangle', 'ellipse' are drawn. In the case ProjMode ='inside' or 'outside' the corresponding area is painted in magenta (or blue when they are not selected). |
| 489 | | * 'plane' are shown by their axis. These axis are limited to their range of selection (RangeX and RangeY) when applicable. Otherwise they end at the edge of the figure with an arrow. ** |
| | 486 | * 'line' , 'polyline' are plotted as lines, surrounded by two dashed lines showing the range of projection, when applicable (i.e. not in the case !ProjMode='interp...'). |
| | 487 | * 'polygon', 'rectangle', 'ellipse' are drawn as lines. In the case !ProjMode ='inside' or 'outside' the corresponding area is painted in magenta (or blue when they are not selected). |
| | 488 | * 'plane' are shown by their axis ending with arrows. When the projection is limited to a sub-domain, by [RangeX] or [RangeY], the bounds are indicated by dashed lines. |
| 492 | | -''' {Creating and editing objects with the mouse:} ''' |
| 493 | | |
| 494 | | Object can be interactively drawn with the mouse on the GUI '''uvmat.fig ''' . First activate the creation mode by selecting the appropriate item in the menu bar Tools. |
| 495 | | |
| 496 | | * 'points': mark points with mouse left button. Use right click to end the series. The list of coordinates appear on the set_object interface. These can be then manually edited, use plot on the GUI '''set_object.fig''' to validate. The range of action can be set on the GUI '''set_object.fig''' by the edit box '''[YMax] ''' (only needed in the ProjMode 'projection'). This range is visualised by dashed circles around each point. The set of points can be determined from successive images (to track a feature for instance): for that purpose use the keyboard keys 'p' and 'm' to increament or decrement fields without the mouse. |
| 497 | | * 'line': just draw a line, keeping the mouse left button pressed, release to end. The range of action, set by '''[YMax]''', is visualised by two dashed lines (only if ProjMode='projection'). |
| 498 | | * 'polyline': draw a line with several segments, press and release the mouse left button to mark each summit, press the right button to end the line. |
| 499 | | * 'rectangle': defined by its center, half width and half height. |
| 500 | | * 'polygon': closed line made of n consecutive segments (defined by n points) |
| 501 | | * 'ellipse': defined by its center, half width and half height. |
| 502 | | * 'plane': plane with associated cartesian coordinates |
| 503 | | * 'volume': volume with associated cartesian coordinates |
| | 491 | Object can be interactively drawn with the mouse on the GUI '''uvmat.fig ''' . First activate the creation mode by selecting the appropriate item in the menu bar Tools, and possibly adjust parameters on the GUI '''set_object.fig'''. Then mark the set of point coordinates by pressing (then release) the left mouse button. Those appear in the table '''[Coord]''' of '''set_object.fig'''. For 'polyline' or 'polygon', press the right hand mouse button to end the line. 'Plane' and 'volume' cannot be created or modified with the mouse. |
| | 492 | |
| | 493 | In edit mode, the position of each defining point can be adjusted with the mouse: press the left button and maintain it to drag the point. The object can be similarly translated by selecting a defining line. |
| | 494 | |
| 534 | | When a NetCDF input file opened, its full name, including path, is displayed in the upper window '''[inputfile]'''. The names and value of the global attributes are listed in the left column '''[attributes]''', the list of variables in the central column '''[variables]''', and the list of dimension names and values in the right column '''[dimensions]'''. By selecting one of the variables in the central column, the corresponding variable attributes and dimensions are displayed in the left and right columns respectively. Note that the whole content of the Netcdf file can be obtained by the function ''nc2struct.m''. Input fields can be selected according to three options, chosen by the menu '''[ |
| | 525 | When a NetCDF input file opened, its full name, including path, is displayed in the upper window '''[inputfile]'''. The names and value of the global attributes are listed in the left column '''[attributes]''', the list of variables in the central column '''[variables]''', and the list of dimension names and values in the right column '''[dimensions]'''. By selecting one of the variables in the central column, the corresponding variable attributes and dimensions are displayed in the left and right columns respectively. Note that the whole content of the Netcdf file can be obtained by the function ''nc2struct.m''. Input fields can be selected according to three options, chosen by the menu '''[!FieldOption]'''. |
| 542 | | The attribute or variable considered as 'time' can be also chosen in the Panel '''[Time]'''. From the menu '''[SwitchVarIndexTime]''', the time can be considered as the ''file index'', a global ''attribute'', a dimension ''variable'', or a ''dimension index''. Selection of ''attribute'' gives way to a list of global attribute tags in the menu '''[TimeName]'''. Selection of variable gives way to a list of vartiables, while selection of ''dimension'' gives a list of dimension names. |
| | 533 | The attribute or variable considered as 'time' can be also chosen in the Panel '''[Time]'''. From the menu '''[!SwitchVarIndexTime]''', the time can be considered as the ''file index'', a global ''attribute'', a dimension ''variable'', or a ''dimension index''. Selection of ''attribute'' gives way to a list of global attribute tags in the menu '''[!TimeName]'''. Selection of variable gives way to a list of vartiables, while selection of ''dimension'' gives a list of dimension names. |
| 565 | | -''' {Opening the GUI:} ''' it is made visible from the GUI '''uvmat.fig''' by the menu bar command '''[Tools/Geometric calibration] '''. If calibration data already exist in the current file <code>ImaDoc </code>, the corresponding list of reference points is displayed in the central window '''[ListCoord] ''' of '''geometry_calib.fig'''. The three first columns indicate the physical coordinates and the two last ones the corresponding image coordinates. Calibration points can be alternatively introduced by opening any <code><ImaDoc></code> xml file with the menu bar command''' [Open] ''' of '''geometry_calib.fig'''. |
| 566 | | |
| 567 | | -''' {Plotting calibration points:} ''' press the menu bar command button '''[Plot] ''' to visualise the list of calibration points. The physical or image coordinates will be used in the list '''[ListCoord]''', depending on the option 'phys' or 'px' in the menu '''[transform_fct]''' of ''' uvmat.fig''' . |
| 568 | | |
| 569 | | -''' {Appending calibration points with the mouse:} ''' Calibration points can be manually picked out by the mouse (left button click) after a calibration image has been opened by '''uvmat.fig''' (with the option '' or 'px' in the popup menu '''[transform_fct]'''), and the option '''[mouse_active]''' (at the very bottom) has been selected. Zoom can be used to improve the precision, but must be desactivated for mouse selection (then move across the image by the key board directional arrows). The coordinates in pixel of the selected points get listed in the box '''[ListCoord]''' of '''geometry_calib.fig'''. A calibration point can be later adjusted by selecting it with the mouse and moving it while pressing the left mouse button. Points can be accumulated from several images (use the key board short cuts 'p' and 'm' to move in the image series without monopolising the mouse).'' |
| 570 | | |
| 571 | | -''' {Editing the coordinates:} ''' |
| | 556 | -''' Opening the GUI: ''' it is made visible from the GUI '''uvmat.fig''' by the menu bar command '''[Tools/Geometric calibation] '''. If calibration data already exist in the current file <code>ImaDoc </code>, the corresponding list of reference points is displayed in the central window '''[!ListCoord] ''' of '''geometry_calib.fig'''. The three first columns indicate the physical coordinates and the two last ones the corresponding image coordinates. Calibration points can be alternatively introduced by opening any <code><!ImaDoc></code> xml file with the menu bar command''' [Open] ''' of '''geometry_calib.fig'''. |
| | 557 | |
| | 558 | -''' Plotting calibration points: ''' press the menu bar command button '''[Plot] ''' to visualise the list of calibration points. The physical or image coordinates will be used in the list '''[!ListCoord]''', depending on the option 'phys' or 'px' in the menu '''[transform_fct]''' of ''' uvmat.fig''' . |
| | 559 | |
| | 560 | -''' Appending calibration points with the mouse: ''' Calibration points can be manually picked out by the mouse (left button click) after a calibration image has been opened by '''uvmat.fig''' (with the option 'blank' in the popup menu '''[transform_fct]'''), and the option '''[mouse_active]''' (at the very bottom) has been selected. Zoom can be used to improve the precision, but must be desactivated for mouse selection (then move across the image by the key board directional arrows). The coordinates in pixel of the selected points get listed in the box '''[!ListCoord]''' of '''geometry_calib.fig'''. A calibration point can be later adjusted by selecting it with the mouse and moving it while pressing the left mouse button. Points can be accumulated from several images (use the key board short cuts 'p' and 'm' to move in the image series without monopolising the mouse).'' |
| | 561 | |
| | 562 | -''' Editing the coordinates: ''' |
| 575 | | -''' {Creating a physical grid:} ''' This tool '''[Tools/Create grid]''' in the menu bar command provides the whole set of physical coordinates of a cartesian grid, after all their image coordinates have been picked out by the mouse. In the GUI '''Create_grid.fig''' which appears, set the first and last x and y values and the meshes for the physical grid corresponding to the points already selected by the mouse. The physical coordinates of all the grid points then appears on '''[ListCoord]'''. |
| 576 | | |
| 577 | | -''' {Detecting a physical grid:} ''' This tool '''[Tools/Detect grid]''' provides the same result as '''[Tools/Create grid]''', but it automatically recognises the grid points on the image, provided the four corners of the grid have been previously selected by the mouse. The calibration points are detected either as image maxima (option 'white markers'), or as black crosses (option 'black markers'). Their position can be adjusted by selection with the mouse. |
| 578 | | |
| 579 | | -''' {Translation and rotation of calibration points:} ''' |
| | 566 | -''' Creating a physical grid: ''' This tool '''[Tools/Create grid]''' in the menu bar command provides the whole set of physical coordinates of a cartesian grid, after all their image coordinates have been picked out by the mouse. In the GUI '''Create_grid.fig''' which appears, set the first and last x and y values and the meshes for the physical grid corresponding to the points already selected by the mouse. The physical coordinates of all the grid points then appears on '''[ListCoord]'''. |
| | 567 | |
| | 568 | -''' Detecting a physical grid: ''' This tool '''[Tools/Detect grid]''' provides the same result as '''[Tools/Create grid]''', but it automatically recognises the grid points on the image, provided the four corners of the grid have been previously selected by the mouse. The calibration points are detected either as image maxima (option 'white markers'), or as black crosses (option 'black markers'). Their position can be adjusted by selection with the mouse. |
| | 569 | |
| | 570 | -''' Translation and rotation of calibration points: ''' |
| 661 | | When input files are indexed by pairs i1-i2 or j1-j2, as resulting from PIV, the pair indexing is chosen by the panel '''[Set Pairs]'''. The popup menu [mode] provides the choice between 'bursts', 'Di','Dj'. In mode 'bursts' a single j index pair is selected in the menu '''[ListPairs]'''. In mode 'Di' and 'Dj' it selects a given index interval in i or j respectively. Then the first_i and last_i refer to the ''reference indices''. With the option '*-*' in '''[!ListPairs]''', available pairs are automatically chosen. In case of multiple input lines, the selection from '''[Set pairs]''' refers to the line number displayed in [ListView]. It is transfered to the corresponding line in the table '''[PairString]'''. |
| | 652 | When input files are indexed by pairs i1-i2 or j1-j2, as resulting from PIV, the pair indexing is chosen by the panel '''[Set Pairs]'''. The popup menu [mode] provides the choice between 'bursts', 'Di','Dj'. In mode 'bursts' a single j index pair is selected in the menu '''[!ListPairs]'''. In mode 'Di' and 'Dj' it selects a given index interval in i or j respectively. Then the first_i and last_i refer to the ''reference indices''. With the option '*-*' in '''[!ListPairs]''', available pairs are automatically chosen. In case of multiple input lines, the selection from '''[Set pairs]''' refers to the line number displayed in [ListView]. It is transfered to the corresponding line in the table '''[!PairString]'''. |
