Changes between Version 73 and Version 74 of UvmatHelp


Ignore:
Timestamp:
Jun 27, 2013, 10:44:43 AM (7 years ago)
Author:
sommeria
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • UvmatHelp

    v73 v74  
    4040UVMAT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See theGNU General Public License (file {COPYING.txt}) for more details.
    4141
    42 -------
     42----
    4343== 2 - Overview of the GUI uvmat.fig ==
    4444=== 2.1 Opening the GUI ===
     
    8181 * '''[Help] ''': displays this help file using the Matlab browser.
    8282
    83 <doc58|center>
    84 
    8583=== 2.3 Displaying the input file name ===
    8684After 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.
     
    105103 * '''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.
    106104
    107 --------------------
     105[[Image(help_coordiantes_titres.jpg)]]
     106
     107----
    108108== 3 - Input files and navigation with uvmat ==
    109109=== 3.1  Input data formats ===
     
    215215
    216216'''Mirror data trees''' can be created to process a source data set in read only mode, to preserve the safety of the data source, and to allow several users to work in parallel without interference. This is done by opening the source Campaign with the menu bar option Open/browse campaign from uvmat. Select the source campaign directory with the browser. Then the GUI 'browse_data' appears. Then press 'create_mirror' and select the directory which must contain the mirror Campaign. A set of directory is then created for each experiment, in which are created symbolic  links to the !DataSeries directories. Data processing then results in real !DataSeries directories created in the Experiment directory.  An xml mirror.xml is created inside the directory mirror to mark its role; This xml file contains  the path and name of the source directory under the label <!SourceDir>. The mirror directory can be regularly updated by pressing the button 'update_mirror'.
    217 ----------------------------
     217
     218----
    218219== 4 - Scalar and vector display ==
    219220The uvmat interface primarily reads and visualises two-dimensional fields, which can be images or scalars, or vector fields.
     
    224225True color images are described by a matrix A(npy,npx,3) of integers between 0 and 255, the last index labeling the color component red, green or blue. They are displayed directly as color images.
    225226
    226 <doc64|center>
     227[[Image(help_scalar_titres.jpg)]]
    227228
    228229The greyscale images are described by a matrix A(npy,npx) of integers, whose range depends on the camera dynamics (0 to 255 for 8 bit images, 0 to 65535 for 16 bit images). They are represented with gray levels, according to the colorbar displayed on the right. The luminosity and contrast can be adjusted using the edit boxes '''[num_MinA]''' and '''[num_MaxA]''' on the right of the interface: the luminosity level set by '''[num_MinA]''' (and levels below) is represented as black, and the luminosity level set by '''[num_MaxA]''' (or levels above) as white. When the check box '''[!CheckFixScalar]''' is not selected, these bounds are set automatically to the image minimum and maximum respectively. Then the image may appear dark if a single point is very bright, in that case a lower value must be set by '''[num_MaxA]'''. Greyscale images can be displayed with false colors, from blue to red, by unselecting the check box '''[CheckBW]'''.
     
    243244Each vector has a color, ranging from blue to red, which can represent an associated  scalar value. In addition, black and magenta colors represent warning and error flags respectively. This color system is primarily designed for PIV data but can be used in other contexts as well.
    244245
    245 <doc63|center>
     246[[Image(help_vectors_titres.jpg)]]
    246247
    247248-'''Warning flags''': they indicate a vector resulting from a dubious  image correlation process, but not removed from the data set. Their display in black can be desactivated by selecting the check box '''[!CheckHideWarning]'''.
     
    301302
    302303-'''Plotting:''' plot the results of projection, using the function ''plot_field.m''.
    303 ----------------------------
     304
     305----
    304306== 5 - Field structures ==
    305307=== 5.1 Griding of data ===
     
    335337In summary, the ''field structure'' is specified by the following elements:
    336338
    337  * (optional) '''ListGlobalAttribute:''' list (cell array of character strings) of the names of global attributes  Att_1, Att_2...
    338  * (mandatory) '''ListVarName:''' list of the variable names Var_1, Var_2....(cell array of character strings).
    339  * (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.
    340  * (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]).
     339 * (optional) '''!ListGlobalAttribute:''' list (cell array of character strings) of the names of global attributes  Att_1, Att_2...
     340 * (mandatory) '''!ListVarName:''' list of the variable names Var_1, Var_2....(cell array of character strings).
     341 * (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.
     342 * (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]).
    341343 * .Att_1, Att_2... : values of the listed global attributes.
    342344 * .Var_1, .Var_2...: variables arrays whose names are listed in !ListVarName.
     
    344346In some cases, it is useful to define the field object independently from its data content. Then the variables .Var1... are replaced by the lists of dimension names and values.
    345347
    346  * '''ListDimName:''' list of dimension names (cell array of character strings)
    347  * '''DimValue:''' array of dimension values corresponding to !LisDimName.
     348 * '''!ListDimName:''' list of dimension names (cell array of character strings)
     349 * '''!DimValue:''' array of dimension values corresponding to !LisDimName.
    348350
    349351The following temporary information is added to manage projection and field substraction oerations, which must be done in general after projection:
     
    415417 * 'nb_tps': dimension of the index for the tps centres
    416418 * 'nb_subdomain' denotes the dimension for the subdomain index for tps coefficients
    417 ----------------------------
     419
     420----
    418421== 6 - Projection objects == #ProjObject
    419422=== 6.1 Definition and editing with the uvmat interface ===
    420 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]). 
     423These 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]).
    421424
    422425When 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'''.
    423426
    424 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]'''. 
    425 
    426 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''.
     427The 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]'''.
     428
     429The 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.[wiki:ProjObject]''.
    427430
    428431=== 6.2 Object properties ===
     
    485488
    486489=== 6.4 Object representation ===
    487 
    488490 * 'points' are represented by dots surrounded by a dashed circle showing the range of projection.
    489491 * '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...').
     
    494496Object 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.
    495497
    496 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. 
    497 
    498 -----------------
     498In 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.
     499
     500----
    499501== 7 - Netcdf files and the GUI get_field ==
    500502=== 7.1 The NetCDF format ===
     
    537539
    538540In the case of a 3D input field, the fig is set to uvmat. A middle plane of cut is automatically selected. This can be moved then with the slider on the interface set_object (see section 5). The default cuts are made at constant z coordiante, but any of the three initial coordiantes can be used as z coordinate, using the menu coord_z.
    539 ----------------------------
     541
     542----
    540543== 8 - Geometric calibration ==
    541544=== 8.1 Generalities ===
     
    561564-''' 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''' .
    562565
    563 -''' 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).''
     566-''' 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).''''
    564567
    565568-''' Editing the  coordinates: '''
     
    636639
    637640The grid will be limited to an  image , or to the common region of two images, depending whether one or two image names are indicated in the edit boxes image_1 and image_2. Press save to save the corresponding grid file (s). A dialog box appears to edit the name of the output grid file, and a second one in case of two images.
    638 ----------------------------
     641
     642----
    639643== 10 - Processing field series ==
    640644=== 10.1 The GUI series.fig ===
     
    695699
    696700By selecting the press button 'peaklocking' on the 'plotgraph' interface, you smooth the current velocity histograms while preserving its integral over each unity (in pixels). This appears in red. Then an estimate of the peaklocking error is obtained by comparing the initial histogram to the smooth one.
    697 ----------------------------
     701
     702----
    698703== 11 - PIV: Particle Imaging Velocimetry ==
    699704=== 11.1 Overview ===
    700705PIV can be performed by selecting the Matlab function ''civ_series'' as '''[!ActionName]''' in the GUI '''series.fig''': then the '''GUI civ_input''' appears to enter the processing parameters. An image file series must have been entered as input of '''series.fig''', or alternatively a Netcdf file resulting form a previous PIV processing (with conventions 'civdata').
    701706
    702 An alternative possibility is to use the older Fortran program ''CivX'' from the GUI '''civ.fig'''. This can be called directly on the Matlab prompt, by typing  ''>>civ'', or from uvmat by the menu bar command '''[RUN/PIV (old civ)]'''.
    703  
    704 '''-Modes of frame pair indexing'''
    705 A first menu '''[ListCompareMode]''' selects one among four modes of operation:
     707An alternative possibility is to use the older Fortran program ''CivX'' from the GUI '''civ.fig'''. This can be called directly on the Matlab prompt, by typing  ''>>civ'', or from uvmat by the menu bar command '''[RUN/PIV (old civ)]'''.    '''-Modes of frame pair indexing''' A first menu '''[ListCompareMode]''' selects one among four modes of operation:
     708
    706709 * '''PIV''': makes image comparisons on sliding index pairs, as usual for measuring velocities by particle displacements. A second menu '''[ListPairMode]''' in the panel '''[PairIndices]''' then selects one among three possibilities (not always available depending on the file indexing):
    707    * ''pair j1-j2:'' selects a given j index pair (sometimes denoted by letter index) for the whole time series. This is the most common case for PIV. Pair selection is performed in the menu '''[ListPairCiv1]''' and '''[ListPairCiv2]''' for the second iteration Civ2, see below. If timing from an xml file [#a3.5Imagedocumentationfiles.xml ImaDoc] has been detected, this is indicated in the edit box '''[ImaDoc]''' and the corresponding time intervals are indicated (in ms). For some applications, this time interval may evolve in time, so that reference indices ref_i and ref_j are chosen for the display. 
     710   * ''pair j1-j2:'' selects a given j index pair (sometimes denoted by letter index) for the whole time series. This is the most common case for PIV. Pair selection is performed in the menu '''[ListPairCiv1]''' and '''[ListPairCiv2]''' for the second iteration Civ2, see below. If timing from an xml file [#a3.5Imagedocumentationfiles.xml ImaDoc] has been detected, this is indicated in the edit box '''[ImaDoc]''' and the corresponding time intervals are indicated (in ms). For some applications, this time interval may evolve in time, so that reference indices ref_i and ref_j are chosen for the display.
    708711   * series (Di): selects a given  index interval for the i index, around a set of reference i indices. The intervals are denoted Di=0|1, -1|1, -1|2, -2|2 ... , corresponding to the index pairs i|i+1, i-1|i+1, i-1|i+2, i-2|i+2 ...around each reference index i. Pair selection is then performed in the menu '''[ListPairCiv1]''' and '''[ListPairCiv2]''' like for 'pair j1-j2'.
    709    * series (Dj): same as series (Di) but with the j index. 
     712   * series (Dj): same as series (Di) but with the j index.
    710713 * '''displacement''': compare the current image to a fixed reference frame, as needed to measure the displacement with respect to this reference. The reference index (i index) is set by an edit box '''[num_OriginIndex]'''.
    711714 * '''shift''': compares the corresponding images in two separate series, as need for stereographic views. The opening of a second file series is proposed by a browser when this option is selected.
     
    718721-''' Succession of operations: '''
    719722
    720 The CIV process involves a succession of iterative operations: 
    721  * civ1: the initial image correlation process.
    722  * fix1: detection of 'false' velocity vectors according to different criteria.
    723  * patch1: interpolation and filtering on a regular grid, providing access to spatial derivatives of the velocity (diverrgence, curl, strain).
    724  * civ2: advanced image correlation algorithm using the result of civ1 as a first approximation.
    725  * fix2 and patch2: similar as fix1 and patch1, but applied to the civ2 results.
     723The CIV process involves a succession of iterative operations:
     724
     725 * civ1: the initial image correlation process.
     726 * fix1: detection of 'false' velocity vectors according to different criteria.
     727 * patch1: interpolation and filtering on a regular grid, providing access to spatial derivatives of the velocity (diverrgence, curl, strain).
     728 * civ2: advanced image correlation algorithm using the result of civ1 as a first approximation.
     729 * fix2 and patch2: similar as fix1 and patch1, but applied to the civ2 results.
    726730
    727731This series of operations is chosen by selecting the corresponding  check boxes on the left of the GUI '''civ_series''', which give access to the corresponding parameter input panels. Note that the result of each of these operations is stored in the output netcdf file, so the process can be split in several runs. When an existing netcdf velocity file has been initially opened, the GUI '''civ.fig''' is automaticaly configured to perform the next operation (fix1, patch1, civ2...) needed in the process.
     
    730734The time interval of the image pair (selected by '''[ListPairCiv1]''', see above) must be chosen sufficiently small to provide a good image correlation, and sufficiently large to provide good measurement precision: a displacement of 5-10 pixels is generally optimum.
    731735
    732  Examples of xml files are provides in /XML_SCHEMAS/ImaDoc_templates.
     736  Examples of xml files are provides in /XML_SCHEMAS/ImaDoc_templates.
    733737
    734738('''[num_CorrBoxSize_1,_2,_3], [iby])''' set the size (in pixels) of the 'correlation box', the sliding window used to get image correlations. '''[num_SearchBoxSize_1,_2,_3]''' set the size of the 'search box' in which image correlation is calculated, see figure.  This search box can be shifted with respect to the correlation box by parameters  ([num_SearchBoxShift_1,_2,_3]). This is useful in the presence of a known mean flow. The default value SearchBoxSize=(25,25) is generally good, use a larger size for images with few particles, use an elongated box , e.g. (11,41), to optimise the resolution in one direction (for instance in a boundary layer).
     
    829833Conventions 'uvmat/civdata'.
    830834
    831 ||  '''tag''' ||  '''        content'''  ||
    832 ||     Civ1_X|| x coordinates||   
    833 || Civ1_Y || y coordinates||
    834 ||  Civ1_Z || z coordinates (for PIV in volume)||
    835 ||  Civ1_U || x velocity component||
    836 || Civ1_V || y velocity component || 
    837 ||  Civ1_W|| z velocity component (if relevant)||
    838 ||   Civ1_F|| warning flag||
    839 || Civ1_C|| image correlation|| 
    840 ||              Civ1_FF|| error flag||
    841 ||                Civ1_U_smooth|| smoothed x velocity component||
    842 ||               Civ1_V_smooth || smoothed y velocity component||   
    843 ||             Civ1_W_smooth || smoothed z velocity component ||     
    844 ||          Civ1_SubRange || sub range bounds||     
    845 ||          Civ1_NbSites || nbre of tps sites in each sub-range||
    846 ||               Civ1_Coord_tps || tps coordinates || 
    847 ||              Civ1_U_tps || tps weights for x vel component || 
    848 ||              Civ1_V_tps || tps weights for y vel component ||   
    849 ||             Civ1_W_tps|| tps weights for z vel component||
    850 
    851 -'''List of constants, old CIVx conventions):'''
    852  * nb_coord: =2 for PIV in a plane, =3 for PIV in a volume.
    853  * nb_dim: =2 for the usual 2 component PIV, =3 for 3 component PIV (stereoscopic or volume).
    854  * constant_pixcm: =1 for a simple linear calibration provided by the scaling factors pixcmx and pixcmy, =0 otherwise.
    855  * pixcmx: scale pixel/space unit (cm by default) along the x direction (only if constant_pixcm=1).
    856  * pixcmy: scale pixel/space unit (cm by default) along the y direction (only if constant_pixcm=1)
    857  * absolut_time_T0: time elapsed since the time origin of the series (the mean time for the two images of the pair is taken).
    858  * dt: time interval between the two images of the pair.
    859  * absolut_time_T0_2: same as absolute_time_T0 for the fields obtained by the second iteration (civ2), using a possibly different image pair.
    860  * dt2: same as dt for the fields obtained by the second iteration (civ2).
    861  * hart: =1 if the Hart option has been used for processing (see ref.???), =0 otherwise.
    862  * civ: =1 if a civ1 operation has been performed (=0 if the field is not obtained from an image pair)
    863  * fix: =1 if a fix1 operation has been performed,
    864  * patch: =1 if a patch1 operation has been performed.
    865  * civ2: =1 if a civ2 operation has been performed.
    866  * fix2:=1 if a fix2 operation has been performed.
    867  * patch2: =1 if a Patch2 operation has been performed.
    868  * patch_nx: number of grid points in the x direction for the patch field
    869  * patch_ny: number of grid points in the y direction for the patch field
    870  * ro_patch: smoothing coefficient rho used for patch
    871  * patch2_nx: number of grid points in the x direction for the patch2 field
    872  * patch2_ny: number of grid points in the y direction for the patch2 field
     835||'''tag'''||'''        content'''||
     836||Civ1_X||x coordinates||
     837||Civ1_Y||y coordinates||
     838||Civ1_Z||z coordinates (for PIV in volume)||
     839||Civ1_U||x velocity component||
     840||Civ1_V||y velocity component||
     841||Civ1_W||z velocity component (if relevant)||
     842||Civ1_F||warning flag||
     843||Civ1_C||image correlation||
     844||Civ1_FF||error flag||
     845||Civ1_U_smooth||smoothed x velocity component||
     846||Civ1_V_smooth||smoothed y velocity component||
     847||Civ1_W_smooth||smoothed z velocity component||
     848||Civ1_SubRange||sub range bounds||
     849||Civ1_NbSites||nbre of tps sites in each sub-range||
     850||Civ1_Coord_tps||tps coordinates||
     851||Civ1_U_tps||tps weights for x vel component||
     852||Civ1_V_tps||tps weights for y vel component||
     853||Civ1_W_tps||tps weights for z vel component||
     854
     855-'''List of constants, old CIVx conventions):'''
     856
     857 * nb_coord: =2 for PIV in a plane, =3 for PIV in a volume.
     858 * nb_dim: =2 for the usual 2 component PIV, =3 for 3 component PIV (stereoscopic or volume).
     859 * constant_pixcm: =1 for a simple linear calibration provided by the scaling factors pixcmx and pixcmy, =0 otherwise.
     860 * pixcmx: scale pixel/space unit (cm by default) along the x direction (only if constant_pixcm=1).
     861 * pixcmy: scale pixel/space unit (cm by default) along the y direction (only if constant_pixcm=1)
     862 * absolut_time_T0: time elapsed since the time origin of the series (the mean time for the two images of the pair is taken).
     863 * dt: time interval between the two images of the pair.
     864 * absolut_time_T0_2: same as absolute_time_T0 for the fields obtained by the second iteration (civ2), using a possibly different image pair.
     865 * dt2: same as dt for the fields obtained by the second iteration (civ2).
     866 * hart: =1 if the Hart option has been used for processing (see ref.???), =0 otherwise.
     867 * civ: =1 if a civ1 operation has been performed (=0 if the field is not obtained from an image pair)
     868 * fix: =1 if a fix1 operation has been performed,
     869 * patch: =1 if a patch1 operation has been performed.
     870 * civ2: =1 if a civ2 operation has been performed.
     871 * fix2:=1 if a fix2 operation has been performed.
     872 * patch2: =1 if a Patch2 operation has been performed.
     873 * patch_nx: number of grid points in the x direction for the patch field
     874 * patch_ny: number of grid points in the y direction for the patch field
     875 * ro_patch: smoothing coefficient rho used for patch
     876 * patch2_nx: number of grid points in the x direction for the patch2 field
     877 * patch2_ny: number of grid points in the y direction for the patch2 field
    873878 * ro2_patch: smoothing coefficient rho used for patch2
    874879
     
    879884-*Names of field variables for civ1 and patch1
    880885
    881 ||  '''   ||     civ1'''          || '''interp1'''  ||        '''filter1 '''   
    882 || dim.  ||        nb_vectors  ||        nb_vec_patch  ||        nb_vec_patch 
    883 ||x   ||vec_X          ||vec_patch_X  ||        vec_patch_X ||
    884 || y          ||         vec_Y  ||        vec_patch_Y ||         vec_patch_Y ||
    885 ||z          ||        vec_Z ||         vec_patch_Z  ||        vec_patch_Z ||
    886 ||u                  ||vec_U ||         vec_patch0_U  ||        vec_patch_U ||
    887 ||v                   ||vec_V          ||vec_patch0_V  ||        vec_patch_V ||
    888 ||w           ||       vec_W          || vec_patch0_W||          vec_patch_W ||
    889 ||correlation  ||        vec_C  ||          ||          ||
    890 ||warning flag  ||        vec_F ||          ||          ||
    891 ||false flag  ||        vec_FixFlag ||          ||    ||         
    892 ||du/dx  ||         ||vec_patch0_DUDX          ||vec_patch_DUDX          ||
    893 ||du/dy  ||         ||vec_patch0_DUDY          ||vec_patch_DUDY          ||
    894 ||dv/dx  ||         ||vec_patch0_DVDX          ||vec_patch_DVDX          ||
    895 ||dv/dy  ||         ||vec_patch0_DVDY          ||vec_patch_DVDY          ||
     886||'''   '''||civ1||'''interp1'''||'''filter1 '''||
     887||dim.||nb_vectors||nb_vec_patch||nb_vec_patch||
     888||x||vec_X||vec_patch_X||vec_patch_X||
     889||y||vec_Y||vec_patch_Y||vec_patch_Y||
     890||z||vec_Z||vec_patch_Z||vec_patch_Z||
     891||u||vec_U||vec_patch0_U||vec_patch_U||
     892||v||vec_V||vec_patch0_V||vec_patch_V||
     893||w||vec_W||vec_patch0_W||vec_patch_W||
     894||correlation||vec_C||||||
     895||warning flag||vec_F||||||
     896||false flag||vec_FixFlag||||||
     897||du/dx||||vec_patch0_DUDX||vec_patch_DUDX||
     898||du/dy||||vec_patch0_DUDY||vec_patch_DUDY||
     899||dv/dx||||vec_patch0_DVDX||vec_patch_DVDX||
     900||dv/dy||||vec_patch0_DVDY||vec_patch_DVDY||
    896901
    897902-*Names of field variables for civ2 and patch2
     
    899904same as previous, replacing 'vec' by 'vec2'.
    900905
    901 ---------------
     906----
    902907== 12 - Tridimensional features:(to update **) ==
    903908=== 12-1 Multilevel image scanning ===
     
    907912=== 12-3 3D3C PIV ** ===
    908913This is performed by the GUI '''civ_3D.fig'''. The program requires input volume images .vol. These are images in the  png format, where  npz slices are concatenated along the y direction, forming a composite image of dimension (npy x npz, npx) from the images (npy x npx). These volume images can be created by the function {ima2vol.m} in {/series}.
    909 ----------------------------
     914
     915----
    910916== 13 - Editing xml files with the GUI editxml ==
    911917  This GUI '''editxml.fig''' visualises and edits xml files. It is automatically called by the browser of '''uvmat.fig''' when a file with extension .xml is opened.
     
    916922
    917923  Manual editing of element value is possible. Select the element and use the lower edit box. This edit box transforms in a menu when a preselected list of allowed input values has been set by the schema.
    918 ----------------------------
     924
     925----
    919926== 14 - Appendix: overview of the package functions ==
    920927=== Master GUI ===