| 133 | | - '''Simple series:''' files in a series can be labeled by a single integer index i, with name obtained by concatenation of the full root ''!RootPath/RootFile''), an index string suffix, and the file extension ''!FileExt'' (example ''Exp01/aa_45.png''). A frame series can be alternatively read from a single movie file. Then the index ''i'' stands for the frame index within the file. |
| 134 | | |
| 135 | | - '''Double index series: ''' they are labeled by two integer indices i and j. This double index labeling is commonly used for bursts of images (index j or equivalently a letter appendix 'a', 'b') separated by longer time intervals (index i). It can be also used for successive volume scanning by a laser sheet, with index j representing the position in the volume and i the time. For a set of indexed movies (or multimage files), the index i labels the files while the index j labels the frames within a file. |
| 136 | | |
| 137 | | - '''Pair indexing:''' new file series can result from the processing of primary series. For a sequential processing limited to a single file, the output index naturally reproduces the input index. Other processing functions involve pairs of input files, for instance Particle Imaging Velocity from image pairs. In a simple series, the result from the two primary fields *_i1 and *_i2 is then labeled as *_i1-i2 with the file extension indicating the output format. More generally, the result from any processing involving a range of primary indices from i1 to i2 is labeled as _i1-i2. If i1=i2 or j1=j2, the two indices are merged in a single label i, or j respectively. |
| 138 | | |
| 139 | | - '''Nomenclature types:''' The ''nomenclature type'' is defined as the character string representing the index (or indices) for the first file in the series, for instance '_1' for a ''single indexing'' and '_1-2' for a ''pair indexing'', '_1_1' for a ''double index'' series. The second index j can be also represented as a letter suffix, for instance '01a'. For a field series in a single file, like a movie, the nomenclature type is defined as '*'. The functions ''fullfile_uvmat.m'' generates a file name from a root name, four numerical indices i1,i2,j1,j2 and the ''nomenclature type''. The reverse operation, splitting a name into a root and indices while detecting the ''nomenclature type'', is performed by the function ''fileparts_uvmat.m''. The function ''find_file_series.m'' is also needed to scan the whole file series, leading to a possible adjustement of the nomenclature type (for instance distinguishing '_001' from '_1' when the file with index 1000 has been opened). Once the nomenclature type has been detected by the browser of the GUI '''uvmat''', it is displayed in the edit box '''[!NomType]''' and used to generate all the file names when the series is scanned. |
| | 133 | * '''Simple series:''' files in a series can be labeled by a single integer index i, with name obtained by concatenation of the full root ''!RootPath/RootFile''), an index string suffix, and the file extension ''!FileExt'' (example ''Exp01/aa_45.png''). A frame series can be alternatively read from a single movie file. Then the index ''i'' stands for the frame index within the file. |
| | 134 | |
| | 135 | * '''Double index series: ''' they are labeled by two integer indices i and j. This double index labeling is commonly used for bursts of images (index j or equivalently a letter appendix 'a', 'b') separated by longer time intervals (index i). It can be also used for successive volume scanning by a laser sheet, with index j representing the position in the volume and i the time. For a set of indexed movies (or multimage files), the index i labels the files while the index j labels the frames within a file. |
| | 136 | |
| | 137 | * '''Pair indexing:''' new file series can result from the processing of primary series. For a sequential processing limited to a single file, the output index naturally reproduces the input index. Other processing functions involve pairs of input files, for instance Particle Imaging Velocity from image pairs. In a simple series, the result from the two primary fields *_i1 and *_i2 is then labeled as *_i1-i2 with the file extension indicating the output format. More generally, the result from any processing involving a range of primary indices from i1 to i2 is labeled as _i1-i2. If i1=i2 or j1=j2, the two indices are merged in a single label i, or j respectively. |
| | 138 | |
| | 139 | * '''Nomenclature types:''' The ''nomenclature type'' is defined as the character string representing the index (or indices) for the first file in the series, for instance '_1' for a ''single indexing'' and '_1-2' for a ''pair indexing'', '_1_1' for a ''double index'' series. The second index j can be also represented as a letter suffix, for instance '01a'. For a field series in a single file, like a movie, the nomenclature type is defined as '*'. The functions ''fullfile_uvmat.m'' generates a file name from a root name, four numerical indices i1,i2,j1,j2 and the ''nomenclature type''. The reverse operation, splitting a name into a root and indices while detecting the ''nomenclature type'', is performed by the function ''fileparts_uvmat.m''. The function ''find_file_series.m'' is also needed to scan the whole file series, leading to a possible adjustement of the nomenclature type (for instance distinguishing '_001' from '_1' when the file with index 1000 has been opened). Once the nomenclature type has been detected by the browser of the GUI '''uvmat''', it is displayed in the edit box '''[!NomType]''' and used to generate all the file names when the series is scanned. |
| 257 | | - '''Warning flags''': they indicate a vector resulting from a dubious image correlation process, but not removed from the data set. They are displayed in black by default. This feature can be desactivated by selecting the check box '''hide warn''' ('''[!CheckHideWarning]'''). |
| 258 | | |
| 259 | | - '''Error flags''': they mark vectors considered as false. These vectors are kept in the data set so that their elimination can be reversed, but they must not be taken into account for data processing. These false vectors are displayed in magenta. They can be also removed from the plot by selecting the check box '''hide false''' ([!CheckHideFalse]''').''' |
| 260 | | |
| 261 | | - '''Associated scalar: ''' for PIV velocity fields, the color represents by default the image correlation '''C''', ranging from 0 to 1. The red values correspond to poor correlations, green to fair values, and blue to good ones. The value range covered by each of the three colors is set by the pair of sliders '''[Slider1]''' and '''[Slider2]''', or equivalently by the edit boxes '''[num_ColCode1]''' and '''[num_ColCode2]'''. Other color representations can be specified. '''[!ColorScalar]''' sets the scalar used for color representation, for instance the vector norm 'norm_vec' or vorticity 'vort' (the list of available scalars is set by the function {calc_scal.m}). |
| 262 | | |
| 263 | | - '''[!ColorCode] ''' sets the kind of color representation: |
| | 257 | * '''Warning flags''': they indicate a vector resulting from a dubious image correlation process, but not removed from the data set. They are displayed in black by default. This feature can be desactivated by selecting the check box '''hide warn''' ('''[!CheckHideWarning]'''). |
| | 258 | |
| | 259 | * '''Error flags''': they mark vectors considered as false. These vectors are kept in the data set so that their elimination can be reversed, but they must not be taken into account for data processing. These false vectors are displayed in magenta. They can be also removed from the plot by selecting the check box '''hide false''' ([!CheckHideFalse]''').''' |
| | 260 | |
| | 261 | * '''Associated scalar: ''' for PIV velocity fields, the color represents by default the image correlation '''C''', ranging from 0 to 1. The red values correspond to poor correlations, green to fair values, and blue to good ones. The value range covered by each of the three colors is set by the pair of sliders '''[Slider1]''' and '''[Slider2]''', or equivalently by the edit boxes '''[num_ColCode1]''' and '''[num_ColCode2]'''. Other color representations can be specified. '''[!ColorScalar]''' sets the scalar used for color representation, for instance the vector norm 'norm_vec' or vorticity 'vort' (the list of available scalars is set by the function {calc_scal.m}). |
| | 262 | |
| | 263 | * '''[!ColorCode] ''' sets the kind of color representation: |
| 302 | | - '''File identification:''' the nomenclature type and file type (for instance image, movie, or NetCDF file) are identified from the opened file (using the function ''find_file_series.m''). |
| 303 | | |
| 304 | | - '''File Reading:''' the input field is first read from the input file by the Matlab function ''read_field.m''. |
| 305 | | |
| 306 | | - '''Second file reading:''' The second input field is similarly read if selected. Note that it is kept in memory, so it is not read again if the file is unchanged (this is useful in the case of substraction of a fixed background for instance). |
| 307 | | |
| 308 | | - '''Transform:''' by default the 'phys' option transforms each of the input fields from pixel to physical coordinates. This operation can also combine two input field structures into a single field structure. |
| 309 | | |
| 310 | | - '''Histogram:''' This is obtained from the input field in transformed coordinates, or if applicable from the fields resulting from the two input fields. |
| 311 | | |
| 312 | | - '''Projection:''' on the projection object selected in the menu '''[!ListObject_1]''', see [#ProjObject section 6]. A second projection, on the object selected by '''[!ListObject]''', can be plotted in the ancillary figure '''view_field.fig'''. Projection is performed by the function ''proj_field.m''. |
| 313 | | |
| 314 | | - '''Field calculation:''' a scalar can be calculated after projection, as selected by the menu '''[Fields]'''. |
| 315 | | |
| 316 | | - '''Field comparison''': when two fields of the same nature are introduced, the difference is taken. This is skipped if the transform function has already led to a single field. - '''Plotting:''' plot the results of projection, using the function ''plot_field.m''. |
| | 302 | * '''File identification:''' the nomenclature type and file type (for instance image, movie, or NetCDF file) are identified from the opened file (using the function ''find_file_series.m''). |
| | 303 | |
| | 304 | * '''File Reading:''' the input field is first read from the input file by the Matlab function ''read_field.m''. |
| | 305 | |
| | 306 | * '''Second file reading:''' The second input field is similarly read if selected. Note that it is kept in memory, so it is not read again if the file is unchanged (this is useful in the case of substraction of a fixed background for instance). |
| | 307 | |
| | 308 | * '''Transform:''' by default the 'phys' option transforms each of the input fields from pixel to physical coordinates. This operation can also combine two input field structures into a single field structure. |
| | 309 | |
| | 310 | * '''Histogram:''' This is obtained from the input field in transformed coordinates, or if applicable from the fields resulting from the two input fields. |
| | 311 | |
| | 312 | * '''Projection:''' on the projection object selected in the menu '''[!ListObject_1]''', see [#ProjObject section 6]. A second projection, on the object selected by '''[!ListObject]''', can be plotted in the ancillary figure '''view_field.fig'''. Projection is performed by the function ''proj_field.m''. |
| | 313 | |
| | 314 | * '''Field calculation:''' a scalar can be calculated after projection, as selected by the menu '''[Fields]'''. |
| | 315 | |
| | 316 | * '''Field comparison''': when two fields of the same nature are introduced, the difference is taken. This is skipped if the transform function has already led to a single field. - '''Plotting:''' plot the results of projection, using the function ''plot_field.m''. |
| 526 | | - '''Variables:''' N-dimensional arrays of data. Variables in NetCDF files can be one of six types (char, byte, short, int, float, double). Variables are used to store the bulk of the data in a NetCDF dataset. A variable represents an array of values of the same type and unit. A variable has a name, a data type, and a shape described by its list of dimensions specified when the variable is created. A variable may also have associated attributes, which may be added, deleted or changed after the variable is created. |
| 527 | | |
| 528 | | - '''Dimensions:''' describe the axes of the data arrays. A dimension has a name and a length. The naming can be useful to identify groups of variables with one to one correspondence, sharing the same dimensions. It is legal for a variable to have the same name as a dimension, it is then called a coordinate variable. Such variables have no special meaning to the NetCDF library, but they can be used in processing software to link the arrays of coordinate values to their corresponding field variables. |
| 529 | | |
| 530 | | - '''Attributes: ''' annotate variables or files (global attributes) with small notes or supplementary meta data. Attributes are always scalar values or 1D arrays, which can be associated with either a variable or the file as a whole. Although there is no enforced limit, the user is expected to keep attributes small. Attribute names with specific meaning are defined in http://www.unidata.ucar.edu/software/netcdf/docs_beta/netcdf.html#Attribute-Conventions. An attribute '.Conventions' can be used to refer to additional sets of conventions used in a particular community. |
| | 526 | * '''Variables:''' N-dimensional arrays of data. Variables in NetCDF files can be one of six types (char, byte, short, int, float, double). Variables are used to store the bulk of the data in a NetCDF dataset. A variable represents an array of values of the same type and unit. A variable has a name, a data type, and a shape described by its list of dimensions specified when the variable is created. A variable may also have associated attributes, which may be added, deleted or changed after the variable is created. |
| | 527 | |
| | 528 | * '''Dimensions:''' describe the axes of the data arrays. A dimension has a name and a length. The naming can be useful to identify groups of variables with one to one correspondence, sharing the same dimensions. It is legal for a variable to have the same name as a dimension, it is then called a coordinate variable. Such variables have no special meaning to the NetCDF library, but they can be used in processing software to link the arrays of coordinate values to their corresponding field variables. |
| | 529 | |
| | 530 | * '''Attributes: ''' annotate variables or files (global attributes) with small notes or supplementary meta data. Attributes are always scalar values or 1D arrays, which can be associated with either a variable or the file as a whole. Although there is no enforced limit, the user is expected to keep attributes small. Attribute names with specific meaning are defined in http://www.unidata.ucar.edu/software/netcdf/docs_beta/netcdf.html#Attribute-Conventions. An attribute '.Conventions' can be used to refer to additional sets of conventions used in a particular community. |
| 547 | | - '''1D plot:''' to plot a simple graph, ordinate versus abscissa. Select by the menu '''[ordinate]''' the variable(s) to plot as ordinate (use the key '''Ctrl''' for multiple selection). Then select the corresponding abscissa in the column '''[abscissa]'''. If the variable is indexed with more than one dimension, each component is plotted versus the first index (like with the plot Matlab function ''plot.m''). If the option '''[matrix index]''' ('''[!CheckDimensionX]''') is selected, the ordinate variable is plotted versus its index. |
| 548 | | |
| 549 | | - '''scalar:''' to plot scalar fields as images. The variable representing the scalar is selected in the first column '''[scalar]''', with coordinates respectively selected in '''[Coord_x] ''' and '''[Coord_y]'''. Alternatively, matrix index can be used as coordinate if the options '''[matrix index]'''('''[CheckDimensionX]''' and '''[CheckDimensionY]''') are selected. |
| 550 | | |
| 551 | | - '''vectors:''' to plot vector fields. The x and y vector components are selected in the first (...) and second columns, while the coordinates are selected in '''[coord_x_vector] ''' and '''[coord_y_vector]'''. If no variable is selected in '''[coord_x_scalar] ''' or '''[coord_y_scalar] ''' ( blank selected at first line), the index is used as coordinate. A scalar, set in ..., can be represented as vector color. |
| | 547 | * '''1D plot:''' to plot a simple graph, ordinate versus abscissa. Select by the menu '''[ordinate]''' the variable(s) to plot as ordinate (use the key '''Ctrl''' for multiple selection). Then select the corresponding abscissa in the column '''[abscissa]'''. If the variable is indexed with more than one dimension, each component is plotted versus the first index (like with the plot Matlab function ''plot.m''). If the option '''[matrix index]''' ('''[!CheckDimensionX]''') is selected, the ordinate variable is plotted versus its index. |
| | 548 | |
| | 549 | * '''scalar:''' to plot scalar fields as images. The variable representing the scalar is selected in the first column '''[scalar]''', with coordinates respectively selected in '''[Coord_x] ''' and '''[Coord_y]'''. Alternatively, matrix index can be used as coordinate if the options '''[matrix index]'''('''[CheckDimensionX]''' and '''[CheckDimensionY]''') are selected. |
| | 550 | |
| | 551 | * '''vectors:''' to plot vector fields. The x and y vector components are selected in the first (...) and second columns, while the coordinates are selected in '''[coord_x_vector] ''' and '''[coord_y_vector]'''. If no variable is selected in '''[coord_x_scalar] ''' or '''[coord_y_scalar] ''' ( blank selected at first line), the index is used as coordinate. A scalar, set in ..., can be represented as vector color. |
| 566 | | - '''rescale''': linear rescaling along ''x'' and ''y'' + translation (no rotation nor deformation). |
| 567 | | |
| 568 | | - '''linear''': general linear transform, including translation and rotation (but no projection effects). |
| 569 | | |
| 570 | | - '''3D_linear:''' this transform handles projection effects, needed if the observed plane is not perpendicular to the line of sight. It involves a 3D calibration needed to account for the depth effects occuring in volume scan. |
| 571 | | |
| 572 | | - '''3D_quadr:''' this is like 3D_linear, but takes also into account a quadratic deformation by the optics which occurs for wide fields of view (small focal lengths). |
| 573 | | |
| 574 | | - '''3D_extrinsic:''' this is like 3D_quadr, but uses intrinsic parameters of the camera, as explained below. |
| | 566 | * '''rescale''': linear rescaling along ''x'' and ''y'' + translation (no rotation nor deformation). |
| | 567 | |
| | 568 | * '''linear''': general linear transform, including translation and rotation (but no projection effects). |
| | 569 | |
| | 570 | * '''3D_linear:''' this transform handles projection effects, needed if the observed plane is not perpendicular to the line of sight. It involves a 3D calibration needed to account for the depth effects occuring in volume scan. |
| | 571 | |
| | 572 | * '''3D_quadr:''' this is like 3D_linear, but takes also into account a quadratic deformation by the optics which occurs for wide fields of view (small focal lengths). |
| | 573 | |
| | 574 | * '''3D_extrinsic:''' this is like 3D_quadr, but uses intrinsic parameters of the camera, as explained below. |
| 624 | | Deducing the physical coordinates from image coordinates requires information on the section plane. The default assumption is that the objects in the image are in the plane used for calibration, but '''uvmat''' can handle volume scanning by a laser plane. A set of section planes can be defined by their origin positions and rotation angle vectors. Theses planes are labelled by a ''z index'', assumed to be the frame index j (case of volume scan), or the index i modulo the number of slices !NbSlice (case of 'multilevel' scan). These settings are stored in the xml file <!ImaDoc> as part of the section <!GeometryCalib> and can be edited from '''uvmat.fig''' with the menu bar command '''[Tools/set slice]'''. A dialog box '''set_slices''' appears for entering the first and last section plane positions ''z'', as well as the number of slices and the option 'volume_scan' ('multilevel' otherwise). In the absence of 3D scan put twice the same value for first and last z. Finally a tilt angle of the laser sheet, around the ''x'' and ''y'' axis, can be introduced, with a possible angular scanning from first to last section planes. After introduction of the plane position information, the z-index is displayed in the frame '''[!FileIndices]''' of '''uvmat.fig'''. The local ''z'' position of the mouse pointer, assumed to lay on the current section plane, is then displayed in '''[text_display]'''. |
| | 624 | Deducing the physical coordinates from image coordinates requires information on the illumination plane. The default assumption is that the objects in the image are in the plane used for calibration (assumed horizontal with x,y coordinates), but '''uvmat''' can handle volume scanning by a laser plane. A set of section planes can be defined by their origin positions and rotation angle vectors. Theses planes are labelled by a ''z index'', assumed to be the frame index j (case of volume scan), or the index i modulo the number of slices !NbSlice (case of 'multilevel' scan). These settings are stored in the xml file <!ImaDoc> as part of the section <!GeometryCalib> and can be edited from '''uvmat.fig''' with the menu bar command '''[Tools/set slice]'''. A dialog box '''set_slices''' appears for entering the first and last section plane positions ''z'', as well as the number of slices and the option 'volume_scan' ('multilevel' otherwise). In the absence of 3D scan put twice the same value for first and last z. Finally a tilt angle of the laser sheet, around the ''x'' and ''y'' axis, can be introduced, with a possible angular scanning from first to last section planes. After introduction of the plane position information, the z-index is displayed in the frame '''[!FileIndices]''' of '''uvmat.fig'''. The local ''z'' position of the mouse pointer, assumed to lay on the current section plane, is then displayed in '''[text_display]'''. |
| 763 | | ||'''Name'''||'''Values'''||'''Default'''||'''Role'''|| |
| 764 | | ||.!WholeIndexRange||'off'/'on'||'off'||prescribes the file index ranges from min to max (the whole file series is needed)|| |
| 765 | | ||.!AllowInputSort||'off'/'on'||'off'||for multiple lines in the input file table, provides an automatic alphabetic sorting of the list of input files !SubDir (so that the order of intput file series used does not depend on the order of introduction)|| |
| 766 | | ||.!NbSlice||positive integer||1||nbre of slices for processing on field indices modulo !NbSlice|| |
| 767 | | ||.!VelType||'off'/'one'/'two'||'off'||allows to select one input velocity type (for PIV data), or two types (two menus)|| |
| 768 | | ||.!FieldName||'off'/'one'/'two'||||allows to select one input field name, or two (two menus)|| |
| 769 | | ||.!FieldTransform||'off'/'on'||'off'||allows the visibility of the menu 'transform function' (for instance phys transform)|| |
| 770 | | ||.!ProjObject||'off'/'on'||'off'||allows the introduction of a projection object|| |
| 771 | | ||.Mask||'off'/'on'||'off'||allows the introduction of mask images|| |
| 772 | | |||||||||| |
| 773 | | ||.!OutputDirExt||char string beginning with '.'||'.series'||set the output dir extension .ext which should characterize the processing function used|| |
| 774 | | ||!OutputSubDirMode||'auto'/'off'/'first'/'last'||'auto'||for multiple lines in the input file table:[[BR]]'auto': output in a folder named with 'subdir1-subdir2...' from all the input folders [[BR]]'off': no output file (only for run in the current Matlab session)[[BR]]'first': output in a folder named after the first input folder[[BR]]'last': output in a folder named after the last input folder|| |
| 775 | | ||!OutputFileMode||'!NbSlice'/'!NbInput'/'!NbInput_i'||'!NbSlice'||indicate the number of output files (used to manage the dispatching on a cluster)[[BR]]'!NbSlice': one output file per slice (single output file in the default case !NbSlice=1)[[BR]]'!NbInput_i': one output file expected per value of i index [[BR]]'!NbInput': one output file expected per input file|| |
| 776 | | ||!ActionInput||Matlab structure||||Matalb sub-structure containing input parameters specific to the current function|| |
| | 763 | || '''Name''' || '''Values''' || '''Default''' || '''Role''' || |
| | 764 | || .!WholeIndexRange || 'off'/'on' || 'off' || prescribes the file index ranges from min to max (the whole file series is needed) || |
| | 765 | || .!AllowInputSort || 'off'/'on' || 'off' || for multiple lines in the input file table, provides an automatic alphabetic sorting of the list of input files !SubDir (so that the order of intput file series used does not depend on the order of introduction) || |
| | 766 | || .!NbSlice || positive integer || 1 || nbre of slices for processing on field indices modulo !NbSlice || |
| | 767 | || .!VelType || 'off'/'one'/'two' || 'off' || allows to select one input velocity type (for PIV data), or two types (two menus) || |
| | 768 | || .!FieldName || 'off'/'one'/'two' |||| allows to select one input field name, or two (two menus) || |
| | 769 | || .!FieldTransform || 'off'/'on' || 'off' || allows the visibility of the menu 'transform function' (for instance phys transform) || |
| | 770 | || .!ProjObject || 'off'/'on' || 'off' || allows the introduction of a projection object || |
| | 771 | || .Mask || 'off'/'on' || 'off' || allows the introduction of mask images || |
| | 772 | || .!OutputDirExt || char string beginning with '.' || '.series' || set the output dir extension .ext which should characterize the processing function used || |
| | 773 | || !OutputSubDirMode || 'auto'/'off'/'first'/'last' || 'auto' || for multiple lines in the input file table:[[BR]]'auto': output in a folder named with 'subdir1-subdir2...' from all the input folders [[BR]]'off': no output file (only for run in the current Matlab session)[[BR]]'first': output in a folder named after the first input folder[[BR]]'last': output in a folder named after the last input folder || |
| | 774 | || !OutputFileMode || '!NbSlice'/'!NbInput'/'!NbInput_i' || '!NbSlice' || indicate the number of output files (used to manage the dispatching on a cluster)[[BR]]'!NbSlice': one output file per slice (single output file in the default case !NbSlice=1)[[BR]]'!NbInput_i': one output file expected per value of i index [[BR]]'!NbInput': one output file expected per input file || |
| | 775 | || !ActionInput || Matlab structure |||| Matalb sub-structure containing input parameters specific to the current function || |
| 906 | | ||'''tag'''||''' content'''|| |
| 907 | | ||Conventions||sets the conventions|| |
| 908 | | ||Program||name of the processing program|| |
| 909 | | ||!CivStage]||stage in the sequence civ1,fix1...|| |
| 910 | | ||Civ1(2)_ImageA||path and name of input image A|| |
| 911 | | ||Civ1(2)_ImageB||path and name of input image B|| |
| 912 | | ||Civ1(2)_Time||mean time for the image pair|| |
| 913 | | ||Civ1(2)_Dt||time interval for image pair|| |
| 914 | | ||Civ1(2)_CorrBoxSize||size x,y of the correlation box|| |
| 915 | | ||Civ1_SearchBoxSize||size x,y of the search box|| |
| 916 | | ||Civ1_SearchBoxShift||(optional) shift of the search box|| |
| 917 | | ||Civ1(2)_CorrSmooth||smooth parameter for the image corr|| |
| 918 | | ||Civ1(2)_Dx,Civ1(2)_Dy||grid mesh along x, y|| |
| 919 | | ||Civ1(2)_CheckGrid||=1 if a grid file is used, default=0|| |
| 920 | | ||Civ1(2)_CheckMask||=1 if a mask file is used, default=0|| |
| 921 | | ||Civ1(2)_CheckThreshold||=0/1 image luminosity threshold used|| |
| 922 | | ||Civ1_ImageBitDepth||nbre of grey level bits|| |
| 923 | | ||Civ1_ImageWidth||nbre of pixels along x|| |
| 924 | | ||Civ1_ImageHeight||nbre of pixels along y|| |
| 925 | | ||Civ1(2)_FrameIndexA||frame index of image A in the series|| |
| 926 | | ||Civ1(2)_FrameIndexB||frame index of image B in the series|| |
| 927 | | ||Patch1(2)_Rho||smoothing parameter for thin plate shell|| |
| 928 | | ||Patch1(2)_Threshold||threshold for the elimination of aberrant vectors|| |
| 929 | | ||Patch1(2)_SubDomain||estimated nbre of vectors in a subdomain|| |
| 930 | | ||Civ2_CheckDecimal||=1 if decimal shift option is used (reduced peaklocking)|| |
| 931 | | ||Civ2_CheckDeformation||=1 if image deformation option is used|| |
| 932 | | |
| 933 | | - '''List of variables:''' |
| | 905 | || '''tag''' || ''' content''' || |
| | 906 | || Conventions || sets the conventions || |
| | 907 | || Program || name of the processing program || |
| | 908 | || !CivStage] || stage in the sequence civ1,fix1... || |
| | 909 | || Civ1(2)_ImageA || path and name of input image A || |
| | 910 | || Civ1(2)_ImageB || path and name of input image B || |
| | 911 | || Civ1(2)_Time || mean time for the image pair || |
| | 912 | || Civ1(2)_Dt || time interval for image pair || |
| | 913 | || Civ1(2)_CorrBoxSize || size x,y of the correlation box || |
| | 914 | || Civ1_SearchBoxSize || size x,y of the search box || |
| | 915 | || Civ1_SearchBoxShift || (optional) shift of the search box || |
| | 916 | || Civ1(2)_CorrSmooth || smooth parameter for the image corr || |
| | 917 | || Civ1(2)_Dx,Civ1(2)_Dy || grid mesh along x, y || |
| | 918 | || Civ1(2)_CheckGrid ||= 1 if a grid file is used, default=0 =|| |
| | 919 | || Civ1(2)_CheckMask ||= 1 if a mask file is used, default=0 =|| |
| | 920 | || Civ1(2)_CheckThreshold ||= 0/1 image luminosity threshold used =|| |
| | 921 | || Civ1_ImageBitDepth || nbre of grey level bits || |
| | 922 | || Civ1_ImageWidth || nbre of pixels along x || |
| | 923 | || Civ1_ImageHeight || nbre of pixels along y || |
| | 924 | || Civ1(2)_FrameIndexA || frame index of image A in the series || |
| | 925 | || Civ1(2)_FrameIndexB || frame index of image B in the series || |
| | 926 | || Patch1(2)_Rho || smoothing parameter for thin plate shell || |
| | 927 | || Patch1(2)_Threshold || threshold for the elimination of aberrant vectors || |
| | 928 | || Patch1(2)_SubDomain || estimated nbre of vectors in a subdomain || |
| | 929 | || Civ2_CheckDecimal ||= 1 if decimal shift option is used (reduced peaklocking) =|| |
| | 930 | || Civ2_CheckDeformation ||= 1 if image deformation option is used =|| |
| | 931 | |
| | 932 | * '''List of variables:''' |
| 937 | | ||'''tag'''||'''dimensions'''||''' content'''|| |
| 938 | | ||Civ1_X||nb_vec_1||x coordinates|| |
| 939 | | ||Civ1_Y||nb_vec_1||y coordinates|| |
| 940 | | ||Civ1_Z||nb_vec_1||z coordinates (for PIV in volume)|| |
| 941 | | ||Civ1_U||nb_vec_1||x velocity component|| |
| 942 | | ||Civ1_V||nb_vec_1||y velocity component|| |
| 943 | | ||Civ1_W||nb_vec_1||z velocity component (if relevant)|| |
| 944 | | ||Civ1_F||nb_vec_1||warning flag|| |
| 945 | | ||Civ1_C||nb_vec_1||image correlation|| |
| 946 | | ||Civ1_FF||nb_vec_1||error flag|| |
| 947 | | ||Civ1_U_smooth||nb_vec_1||smoothed x velocity component|| |
| 948 | | ||Civ1_V_smooth||nb_vec_1||smoothed y velocity component|| |
| 949 | | ||Civ1_W_smooth||nb_vec_1||smoothed z velocity component|| |
| 950 | | ||Civ1_SubRange||(nb_coord,nb_bounds,nb_subdomain_1)||subdomain bounds|| |
| 951 | | ||Civ1_NbCentres||nb_subdomain_1||nbre of tps centres (valid vectors) in each subdomain|| |
| 952 | | ||Civ1_Coord_tps||(nb_tps_1,nb_coord,nb_subdomain_1)||coordinates of tps centres for each subdomain|| |
| 953 | | ||Civ1_U_tps||(nb_tps_1,nb_subdomain_1)||tps weights for x vel component|| |
| 954 | | ||Civ1_V_tps||(nb_tps_1,nb_subdomain_1)||tps weights for y vel component|| |
| 955 | | ||Civ1_W_tps||(nb_tps_1,nb_subdomain_1)||tps weights for z vel component|| |
| | 936 | || '''tag''' || '''dimensions''' || ''' content''' || |
| | 937 | || Civ1_X || nb_vec_1 || x coordinates || |
| | 938 | || Civ1_Y || nb_vec_1 || y coordinates || |
| | 939 | || Civ1_Z || nb_vec_1 || z coordinates (for PIV in volume) || |
| | 940 | || Civ1_U || nb_vec_1 || x velocity component || |
| | 941 | || Civ1_V || nb_vec_1 || y velocity component || |
| | 942 | || Civ1_W || nb_vec_1 || z velocity component (if relevant) || |
| | 943 | || Civ1_F || nb_vec_1 || warning flag || |
| | 944 | || Civ1_C || nb_vec_1 || image correlation || |
| | 945 | || Civ1_FF || nb_vec_1 || error flag || |
| | 946 | || Civ1_U_smooth || nb_vec_1 || smoothed x velocity component || |
| | 947 | || Civ1_V_smooth || nb_vec_1 || smoothed y velocity component || |
| | 948 | || Civ1_W_smooth || nb_vec_1 || smoothed z velocity component || |
| | 949 | || Civ1_SubRange || (nb_coord,nb_bounds,nb_subdomain_1) || subdomain bounds || |
| | 950 | || Civ1_NbCentres || nb_subdomain_1 || nbre of tps centres (valid vectors) in each subdomain || |
| | 951 | || Civ1_Coord_tps || (nb_tps_1,nb_coord,nb_subdomain_1) || coordinates of tps centres for each subdomain || |
| | 952 | || Civ1_U_tps || (nb_tps_1,nb_subdomain_1) || tps weights for x vel component || |
| | 953 | || Civ1_V_tps || (nb_tps_1,nb_subdomain_1) || tps weights for y vel component || |
| | 954 | || Civ1_W_tps || (nb_tps_1,nb_subdomain_1) || tps weights for z vel component || |
| 995 | | - '''Names of field variables for civ1 and patch1''' |
| 996 | | |
| 997 | | ||''' '''||civ1||'''interp1'''||'''filter1 '''|| |
| 998 | | ||dim.||nb_vectors||nb_vec_patch||nb_vec_patch|| |
| 999 | | ||x||vec_X||vec_patch_X||vec_patch_X|| |
| 1000 | | ||y||vec_Y||vec_patch_Y||vec_patch_Y|| |
| 1001 | | ||z||vec_Z||vec_patch_Z||vec_patch_Z|| |
| 1002 | | ||u||vec_U||vec_patch0_U||vec_patch_U|| |
| 1003 | | ||v||vec_V||vec_patch0_V||vec_patch_V|| |
| 1004 | | ||w||vec_W||vec_patch0_W||vec_patch_W|| |
| 1005 | | ||correlation||vec_C|||||| |
| 1006 | | ||warning flag||vec_F|||||| |
| 1007 | | ||false flag||vec_FixFlag|||||| |
| 1008 | | ||du/dx||||vec_patch0_DUDX||vec_patch_DUDX|| |
| 1009 | | ||du/dy||||vec_patch0_DUDY||vec_patch_DUDY|| |
| 1010 | | ||dv/dx||||vec_patch0_DVDX||vec_patch_DVDX|| |
| 1011 | | ||dv/dy||||vec_patch0_DVDY||vec_patch_DVDY|| |
| 1012 | | |
| 1013 | | - '''Names of field variables for civ2 and patch2''' |
| | 994 | * '''Names of field variables for civ1 and patch1''' |
| | 995 | |
| | 996 | || ''' ''' || civ1 || '''interp1''' || '''filter1 ''' || |
| | 997 | || dim. || nb_vectors || nb_vec_patch || nb_vec_patch || |
| | 998 | || x || vec_X || vec_patch_X || vec_patch_X || |
| | 999 | || y || vec_Y || vec_patch_Y || vec_patch_Y || |
| | 1000 | || z || vec_Z || vec_patch_Z || vec_patch_Z || |
| | 1001 | || u || vec_U || vec_patch0_U || vec_patch_U || |
| | 1002 | || v || vec_V || vec_patch0_V || vec_patch_V || |
| | 1003 | || w || vec_W || vec_patch0_W || vec_patch_W || |
| | 1004 | || correlation || vec_C || |
| | 1005 | || warning flag || vec_F || |
| | 1006 | || false flag || vec_FixFlag || |
| | 1007 | || du/dx |||| vec_patch0_DUDX || vec_patch_DUDX || |
| | 1008 | || du/dy |||| vec_patch0_DUDY || vec_patch_DUDY || |
| | 1009 | || dv/dx |||| vec_patch0_DVDX || vec_patch_DVDX || |
| | 1010 | || dv/dy |||| vec_patch0_DVDY || vec_patch_DVDY || |
| | 1011 | |
| | 1012 | * '''Names of field variables for civ2 and patch2''' |
