Changes between Version 92 and Version 93 of UvmatHelp


Ignore:
Timestamp:
May 3, 2014, 6:42:35 PM (10 years ago)
Author:
sommeria
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • UvmatHelp

    v92 v93  
    2626The 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.
    2727
    28 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. 
     28A 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.
    2929
    3030Information is also provided as comments in each function. Type '>>help fct_name'  to get it, or open it with an editor.
    3131
    32 Finally a on-line [http://servforge.legi.grenoble-inp.fr/projects/soft-uvmat/wiki#Tutorial tutorial] is provided with test images and data files.
     32Finally a on-line [http://servforge.legi.grenoble-inp.fr/projects/soft-uvmat/wiki/Tutorial tutorial] is provided with test images and data files.
    3333
    3434=== 1.4 Copyright and licence ===
    … …  
    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: