Changes between Version 91 and Version 92 of UvmatHelp

Timestamp:

May 3, 2014, 6:39:45 PM (10 years ago)

Author:

sommeria

Comment:

--

UvmatHelp

@@ -14 +14 @@
 
  * '''browse_data.fig:''' scans the data directory of a project
- * '''civ.fig:''' runs the software for Particle Imaging Velocimetry
  * '''editxml.fig:'''  displays and edits xml files according to an xml schema. xml reading and editing is performed by the toolbox [http://www.artefact.tk/software/matlab/xml/ xmltree], integrated in the package ''uvmat'' as a subdirectory /@xmltree.
  * '''geometry_calib.fig''': determines geometric calibration parameters for relating image to physical coordinates. The toolbox http://www.vision.caltech.edu/bouguetj/calib_doc/ is used, integrated in the package ''uvmat'' as a subdirectory /toolbox_calib.
@@ -27 +26 @@
 The present on-line document is the reference document for the version currently available on the svn server. Features not yet implemented or tested (in particular 3D features) are marked by **. The document is accessible within Matlab by help buttons in the GUIs.
 
-A short comment about  each GUI ''uicontrol'' (push buttons, edit boxes, menus..), as well as the tag name of this ''uicontrol'', is provided as a tool tip window by moving the mouse over it. In the present help document, the tag of a GUI uicontrol is quoted as '''[uicontrol tag]''', a file name in the package is quoted as ''fct name.m'', and commands on the Matlab workspace as  '>> command’.
+A short comment about  each GUI element, called ''uicontrol'' (push buttons, edit boxes, menus..), as well as the ''tag name'' of this ''uicontrol'', is provided as a tool tip window by moving the mouse over it. In the present help document, the tag of a GUI element is quoted as '''[ tag]''', a file name in the package is enhanced as ''fct name.m'', and commands on the Matlab workspace as  '>> command’. The tag name can be also obtained by pressing the right hand mouse button on the element. 
 
 Information is also provided as comments in each function. Type '>>help fct_name'  to get it, or open it with an editor.
@@ -245 +244 @@
 Scalars (or image intensity) can be also represented with contour plots, by switching the popup menu '''[Contours] ''' from the setting 'image' to the setting 'contours'. Contours for positive scalar values are in sold line while contours for negative values are dashed. The interval between contours can be set by the edit box '''[num_IncrA]'''. The interval is automatically determined if the box content is blank.
 
-By default, the  contours are further marked by jumps of color levels. This can be set to grey levels by selecting the check box '''[CheckBW]. '''To suppress these images, set '''[Opacity]''' to 0. ''''''
+By default, the  contours are further marked by jumps of color levels. This can be set to grey levels by selecting the check box '''[CheckBW]. '''To suppress these images, set '''[Opacity]''' to 0. '''''''''''
 
 === 4.3 Vectors ===
@@ -351 +350 @@
 In summary, the ''field structure'' is specified by the following elements:
 
- * (optional) '''!!!ListGlobalAttribute:''' list (cell array of character strings) of the names of global attributes  Att_1, Att_2...
- * (mandatory) '''!!!ListVarName:''' list of the variable names Var_1, Var_2....(cell array of character strings).
- * (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.
- * (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]).
+ * (optional) '''!!!!ListGlobalAttribute:''' list (cell array of character strings) of the names of global attributes  Att_1, Att_2...
+ * (mandatory) '''!!!!ListVarName:''' list of the variable names Var_1, Var_2....(cell array of character strings).
+ * (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.
+ * (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]).
  * .Att_1, Att_2... : values of the listed global attributes.
  * .Var_1, .Var_2...: variables arrays whose names are listed in !ListVarName.
@@ -360 +359 @@
 In 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.
 
- * '''!!!ListDimName:''' list of dimension names (cell array of character strings)
- * '''!!!DimValue:''' array of dimension values corresponding to !LisDimName.
+ * '''!!!!ListDimName:''' list of dimension names (cell array of character strings)
+ * '''!!!!DimValue:''' array of dimension values corresponding to !LisDimName.
 
 The following temporary information is added to manage projection and field substraction oerations, which must be done in general after projection: