Changes between Version 101 and Version 102 of UvmatHelp


Ignore:
Timestamp:
May 10, 2014, 3:32:52 PM (11 years ago)
Author:
sommeria
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • UvmatHelp

    v101 v102  
    350350In summary, the ''field structure'' is specified by the following elements:
    351351
    352  * (optional) '''!!!!ListGlobalAttribute:''' list (cell array of character strings) of the names of global attributes  Att_1, Att_2...
    353  * (mandatory) '''!!!!ListVarName:''' list of the variable names Var_1, Var_2....(cell array of character strings).
    354  * (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.
    355  * (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]).
     352 * (optional) '''!!!!!ListGlobalAttribute:''' list (cell array of character strings) of the names of global attributes  Att_1, Att_2...
     353 * (mandatory) '''!!!!!ListVarName:''' list of the variable names Var_1, Var_2....(cell array of character strings).
     354 * (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.
     355 * (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]).
    356356 * .Att_1, Att_2... : values of the listed global attributes.
    357357 * .Var_1, .Var_2...: variables arrays whose names are listed in !ListVarName.
     
    359359In 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.
    360360
    361  * '''!!!!ListDimName:''' list of dimension names (cell array of character strings)
    362  * '''!!!!DimValue:''' array of dimension values corresponding to !LisDimName.
     361 * '''!!!!!ListDimName:''' list of dimension names (cell array of character strings)
     362 * '''!!!!!DimValue:''' array of dimension values corresponding to !LisDimName.
    363363
    364364The following temporary information is added to manage projection and field substraction oerations, which must be done in general after projection:
     
    673673The menu bar at the top of the GUI contains the following buttons:
    674674
    675  * '''[Open]''': Open or browse input files. It operates like for the GUI uvmat, except that there are now two possibilities: '''browse...'''  or '''browse_append...'.'' The latter appends a new input line to the table '''[!InputTable]''' while the former refreshes the table.
     675 * '''[Open]''': Open or browse input files. It operates like for the GUI uvmat, except that there are now two possibilities: '''browse...'''  or '''browse_append...'.'' '''''The latter appends a new input line to the table [!InputTable] while the former refreshes the table.
    676676
    677677 * '''[Open campaign] ''':  does the same as '''[Open]  but '''scan the data organised as a project/campaign, see [https://servforge.legi.grenoble-inp.fr/#a3.7Dataorganisationinaproject section 3.7].
     
    715715
    716716 * ''check_data_files:'' gives the series of files selected for processing and checks their existence. The oldest modified file is indicated, which is useful to detect whether any file in a civ processing is missing (then the oldest file is not updated). For NetCDF files, the last operation made (civ1, fix1, patch1, civ2, fix2, patch2) is indicated. The details of each NetCDF file can be dispalyed by selecting it with the mouse in the list.
    717  *  ''aver_stat'': this option provides any average over the processed files. If ['''!!NbSlice]''' is not equal to 1, the average is performed slice by slice, providing !!NbSlice results.   If a projection object is selected (check box '''[!CheckObject]'''), the field is projected before averaging. For unstructured coordinates varying for successive fields, the data is linearly interpolated on the coordinates of the first field in the series. It is then advised to project the fields on a regular grid, creating a projection object of type '''plane''' with projection mode '''interp_lin''' or '''interp_tps'.'' With a projection mode 'inside' or 'outside', the global histogram of field variables on the selected region will be obtained. In the case of two input files series, the field difference will be perfomed like with the interface '''uvmat.fig'''. It is not possible to use more than two input series for this function.
     717 * ''aver_stat'': this option provides any average over the processed files. If ['''!!NbSlice]''' is not equal to 1, the average is performed slice by slice, providing !!NbSlice results.   If a projection object is selected (check box '''[!CheckObject]'''), the field is projected before averaging. For unstructured coordinates varying for successive fields, the data is linearly interpolated on the coordinates of the first field in the series. It is then advised to project the fields on a regular grid, creating a projection object of type '''plane''' with projection mode '''interp_lin''' or ''interp_tps'''. With a projection mode 'inside' or 'outside', the global histogram of field variables on the selected region will be obtained. In the case of two input files series, the field difference will be performed like with the interface uvmat.fig. It is not possible to use more than two input series for this function.
    718718 * ''time_series:'' this action provides a time series of the input field, possibly projected . Thus projection on 'points' lead to time series of the projected variable(s) for each point, projection by interpolation on a line will (x,time) field, while projection on a plane gives a 3D matrix, whose first index corresponds to time. Note that for a vector field, projections on a tilted line or plane give the vector components longitudinal and normal to the object. To preserve the original x and y components, introduce them as ''scalar'', not ''vectors''. In the case of two input files series, the field difference will be perfomed like with the interface '''uvmat.fig'''. It is not possible to use more than two input series for this funtion.
    719719 * ''merge_proj'': this option allows to merge several field series in a single one. This is useful to merge fields obtained with different cameras. Select the different series, using the input option ''append''. In this case, it is generally useful to interpolate the fields on a single grid. For that purpose select a projection object of type 'plane' with projection mode 'interp_lin', or 'interp_tps' to get spatial derivative. Since the different views have their own calibration, it is important to use the option 'phys' (menu menu_coord), and to create the grid in phys coordinates.
    720720
    721721=== 10.8 Other functions Action... ===
    722 With the option '''more...' ''in !!ActionName, a browsers pops up to choose an Action function. Some examples of  functions are in the subdirectory ''{/series}'' of the folder containing '''''umat'''''.
     722With the option '''more...' ''in !!ActionName, a browsers pops up to choose an Action function. Some examples of  functions are in the subdirectory ''{/series}'' of the folder containing '''''umat'''''.'''''
    723723
    724724 * ''sub_background.m'': used to removed a mean background to the images. This is useful before CIV processing when some fiked features are visible in the background (when the laser sheet is close to the bottom).
    725  * ''ima_levels.m'': provides images with modified grey scale intensity to avoid blinking effects on particles.''''
     725 * ''ima_levels.m'': provides images with modified grey scale intensity to avoid blinking effects on particles.'''''''
    726726 * ''ima2vol.m'' produce volume images for 3D3C PIV.
    727727 * ''turb_stat.m'': produces turbulent statistics (Reynolds stress tensor)
    728728
    729 These can be used as template to create other functions. The general input of these functions in Matlab structure 'Param' which contains all the input parameters as given by the GUI series (see comments in the function for details). For batch operations, as needed for the cluster, this input is replaced by the name of an xml file which contains these parameters (this is the file produced in the floder '''/0_XM'L'' under the result directrory Output Subdir ). The first part of the function must give some options for the requested input information and may interactively introduce specific parameters needed for the function. The second part of the function, where the processing itself takes place, is then free from any input (so the operation can be easily dispatched to a remote computer).
     729These can be used as template to create other functions. The general input of these functions in Matlab structure 'Param' which contains all the input parameters as given by the GUI series (see comments in the function for details). For batch operations, as needed for the cluster, this input is replaced by the name of an xml file which contains these parameters (this is the file produced in the floder '''/0_XML''' under the result directrory Output Subdir ). The first part of the function must give some options for the requested input information and may interactively introduce specific parameters needed for the function. The second part of the function, where the processing itself takes place, is then free from any input (so the operation can be easily dispatched to a remote computer).
    730730
    731731To update (**): LIF_series: do LIF analysis, Stereo_PIV: combine two velicity series to yield the 3 components, part_stat: count particles and provides their density and luminosity histogramm, Peaklocking errors: estimate errors in PIV . By 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.
     
    734734== 11 - PIV: Particle Imaging Velocimetry == #Civ
    735735=== 11.1 Overview ===
    736 PIV 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').
     736PIV 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''').
    737737
    738738An 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:
     
    752752-''' Succession of operations: '''
    753753
    754 The CIV process involves a succession of iterative operations:
    755 
    756  * civ1: the initial image correlation process.
     754The CIV process involves a succession of iterative operations which can be used to improve the results.
     755
     756 * civ1: the initial image correlation process which by itself already provides a velocity field.
    757757 * fix1: detection of 'false' velocity vectors according to different criteria.
    758758 * patch1: interpolation and filtering on a regular grid, providing access to spatial derivatives of the velocity (diverrgence, curl, strain).