Changes between Version 115 and Version 116 of UvmatHelp

Timestamp:

Dec 6, 2014, 3:59:11 PM (9 years ago)

Author:

sommeria

Comment:

--

UvmatHelp

@@ -731 +731 @@
 The first part of the function is activated when the function is selected in the menu !ActionName of the GUI '''series''', which yields the input !Param.Action.RUN=0. It is aimed at setting the GUI configuration appropriate for the specific function, and to provide all the needed input parameters. The second part is activated by the action RUN and should not contain any interactive input to allow for batch mode outside the current Matlab session.
 
-The settings of the GUI ''' series''' are controlled by the following parameters:
+The settings of the GUI ''' series''' are controlled by the following parameters (fields of the Matlab structure 'Param'):
 
 ||'''name'''||'''values'''||'''default'''||'''role'''||
-||!WholeIndexRange||'off'/'on'||'off'||prescribes the file index ranges from min to max (the whole file series is needed)||
-||!AllowInputSort||'off'/'on'||'off'||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)]||
-||!NbSlice||||'off'||nbre of slices||
+||.!WholeIndexRange||'off'/'on'||'off'||prescribes the file index ranges from min to max (the whole file series is needed)||
+||.!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)||
+||.!NbSlice||positive integer||1||nbre of slices for processing on field indices modulo !NbSlice||
+||.!VelType||'off'/'one'/'two'||'off'||allows to select one input velocity type (for PIV data), or two types (two menus)||
+||.!FieldName||'off'/'one'/'two'||||allows to select one input field name, or two  (two menus)||
+||.!FieldTransform||'off'/'on'||'off'||allows the visibility of the menu 'transform function' (for instance phys transform)||
+||.!ProjObject||'off'/'on'||'off'||allows the introduction of a projection object||
+||.Mask||'off'/'on'||'off'||allows the introduction of mask images||
 ||||||||||
-||||||||||
-
- * Data.!VelType='off';% menu for selecting the velocity type (options 'off'/'one'/'two',  'off' by default)
- * Data.!FieldName='off';% menu for selecting the field (s) in the input file(options 'off'/'one'/'two', 'off' by default)
- * Data.!FieldTransform = 'off'/'on' (default 'off') controls the visibility of the menu 'transform function'.
- * Data.!ProjObject='off';%can use projection object(option 'off'/'on',
- * Data.Mask='off';%can use mask option   (option 'off'/'on', 'off' by default)
- * Data.!OutputDirExt='.ext';%set the output dir extension .ext
- * Data.!OutputSubDirMode='all'; %select the last subDir in the input table as root of the output subdir name (option 'all'/'first'/'last', 'all' by default)
- * Data.!OutputFileMode='NbInput_i';% one output file expected per value of i index (used for waitbar)
+||.!OutputDirExt||char string beginning with '.'||'.series'||set the output dir extension .ext which should characterize the processing function used||
+||!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||
+||!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||
+||!ActionInput||Matlab structure||||Matalb sub-structure containing input parameters specific to the current function||
 
 To 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.