Changes between Version 112 and Version 113 of UvmatHelp

Timestamp:

Dec 6, 2014, 3:05:14 PM (9 years ago)

Author:

sommeria

Comment:

--

UvmatHelp

@@ -720 +720 @@
 
 === 10.8 Other functions Action... ===
-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'''''. A few more examples (less reliable) are in the subfolder ''{/series/usr_fct }'', a good place to put your own functions. 
+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'''''. A few more examples (less reliable) are in the subfolder ''{/series/usr_fct }'', a good place to put your own functions.
 
  * ''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).
@@ -729 +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_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).
 
-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 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:
--Data.AllowInputSort='off'/'on' ('off' by default) provides an automatic alphabetic sorting of the list of input files SubDir. 
--Data.WholeIndexRange='off';% prescribes the file index ranges from min to max (options 'off'/'on', 'off' by default)
--Data.NbSlice='off'; %nbre of slices ('off' by default)
--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='.stereo';%set the output dir extension
--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)
-
+
+ * Data.!AllowInputSort='off'/'on' ('off' by default) provides an automatic alphabetic sorting of the list of input files SubDir. 
+ * Data.!WholeIndexRange]='off';% prescribes the file index ranges from min to max (options 'off'/'on', 'off' by default) 
+ * Data.!NbSlice='off'; %nbre of slices ('off' by default) 
+ * 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)
 
 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.