Changeset 811 for trunk


Ignore:
Timestamp:
Aug 13, 2014, 3:08:49 AM (7 years ago)
Author:
g7moreau
Message:
  • Update header OUPUT -> OUTPUT and so on...
Location:
trunk/src
Files:
11 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/fill_GUI.m

    r809 r811  
    22% -----------------------------------------------------------------------
    33% function errormsg=fill_GUI(Param,GUI_handle)
    4 % OUPUT:
     4% OUTPUT:
    55% errormsg: error message, ='' by default
    66%
  • trunk/src/fullfile_uvmat.m

    r809 r811  
    77%------------------------------------------------------------------------
    88% OUTPUT:
    9 % filename: string representing the full file name (including path)
    10 %------------------------------------------------------------------------
     9%  filename: string representing the full file name (including path)
     10%
    1111% INPUT:
    12 %RootPath: path to the base file
    13 %SubDir: name of the SubDirectory for netcdf files (relevant for NomTypes with index pairs 1-2 or ab )
    14 %RootFile: FileName without appendix
    15 %FileExt: file extension
    16 %NomType: char chain characterizing the file nomenclature, made as
     12%  RootPath: path to the base file
     13%  SubDir: name of the SubDirectory for netcdf files (relevant for NomTypes with index pairs 1-2 or ab )
     14%  RootFile: FileName without appendix
     15%  FileExt: file extension
     16%  NomType: char chain characterizing the file nomenclature, made as
    1717%   nom_type='': constant name [filebase ext] (default output if 'nom_type' is undefined)
    1818%   nom_type='*':constant name for a file representing a series (e.g. avi movie)
     
    2727%   nom_type='_1_ab','1_ab','01_ab'..., from pairs of '#' images
    2828%   (e.g.'aa045bc.nc'), ext='.nc'
    29 %i1: first number i
    30 %i2: second number i (only for .nc files)
    31 %j1: first number j
    32 %j2: second number j (only for .nc files)
    33 %------------------------------------------------------------------------
    34 %related functions:
    35 % fileparts_uvmat, num2stra, stra2num.
     29%  i1: first number i
     30%  i2: second number i (only for .nc files)
     31%  j1: first number j
     32%  j2: second number j (only for .nc files)
     33%
     34% RELATED FUNCTIONS:
     35%  fileparts_uvmat, num2stra, stra2num.
    3636
    3737%=======================================================================
  • trunk/src/get_field.m

    r809 r811  
    44% associated with the GUI get_field.fig
    55%
    6 % OUPUT:
     6% OUTPUT:
    77% GetFieldData: structure containing the information on the selected
    88%      fields, obtained by applying the fct red_GUI to the GUI get_field
  • trunk/src/phys_XYZ.m

    r809 r811  
    136136%'px_XYZ': transform phys coordinates to image coordinates (px)
    137137%
    138 % OUPUT:
     138% OUTPUT:
    139139% X,Y: array of coordinates in the image cooresponding to the input physical positions
    140140%                    (origin at lower leftcorner, unit=pixel)
  • trunk/src/plot_field.m

    r809 r811  
    1414% function [PlotType,PlotParamOut,haxes]= plot_field(Data,haxes,PlotParam,PosColorbar)
    1515%
    16 % OUPUT:
     16% OUTPUT:
    1717% PlotType: type of plot: 'text','line'(curve plot),'plane':2D view,'volume'
    1818% PlotParamOut: structure, representing the updated  plotting parameters, in case of automatic scaling
    1919% haxes: handle of the plotting axis, when a new figure is created.
    2020%
    21 %INPUT
     21% INPUT:
    2222%    Data:   structure describing the field to plot
    2323%         (optional) .ListGlobalAttribute: cell listing the names of the global attributes
  • trunk/src/struct2nc.m

    r809 r811  
    33% errormsg=struct2nc(flname,Data)
    44%
    5 % OUPUT:
     5% OUTPUT:
    66% errormsg=error message, =[]: default, no error
    77%
  • trunk/src/struct2nc_toolbox.m

    r809 r811  
    33% errormsg=struct2nc_toolbox(flname,Data)
    44%
    5 %OUPUT:
    6 %errormsg=error message, =[]: default, no error
     5% OUTPUT:
     6% errormsg=error message, =[]: default, no error
    77%
    8 %INPUT:
    9 %flname: name of the netcdf file to create (must end with the extension '.nc')
     8% INPUT:
     9% flname: name of the netcdf file to create (must end with the extension '.nc')
    1010%  Data: structure containing all the information of the netcdf file (or netcdf object)
    1111%           with fields:
  • trunk/src/sub_field.m

    r809 r811  
    99% function SubData=sub_field(Field,XmlData,Field_1)
    1010%
    11 % OUPUT:
     11% OUTPUT:
    1212% SubData: structure representing the resulting field
    1313%
  • trunk/src/tps_coeff.m

    r809 r811  
    1414% [U_smooth,U_tps]=tps_coeff(ctrs,U,Smoothing)
    1515%------------------------------------------------------------------------
    16 % OUPUT:
    17 % U_smooth: values of the quantity U at the N centres after smoothing
    18 % U_tps: tps weights of the centres and columns of the linear
     16% OUTPUT:
     17%  U_smooth: values of the quantity U at the N centres after smoothing
     18%  U_tps: tps weights of the centres and columns of the linear
    1919
    20 %INPUT:
    21 % ctrs: NxNbDim matrix  representing the positions of the N centers, sources of the tps (NbDim=space dimension)
    22 % U: Nx1 column vector representing the values of the considered scalar measured at the centres ctrs
    23 % Smoothing: smoothing parameter: the result is smoother for larger Smoothing.
     20% INPUT:
     21%  ctrs: NxNbDim matrix  representing the positions of the N centers, sources of the tps (NbDim=space dimension)
     22%  U: Nx1 column vector representing the values of the considered scalar measured at the centres ctrs
     23%  Smoothing: smoothing parameter: the result is smoother for larger Smoothing.
    2424%
    25 %related functions:
    26 % tps_eval, tps_eval_dxy
    27 % tps_coeff_field, set_subdomains, filter_tps, calc_field
     25% RELATED FUNCTIONS:
     26%  tps_eval, tps_eval_dxy
     27%  tps_coeff_field, set_subdomains, filter_tps, calc_field
    2828
    2929%=======================================================================
  • trunk/src/tps_eval.m

    r809 r811  
    44% function EM = tps_eval(dsites,ctrs)
    55%------------------------------------------------------------------------
    6 % OUPUT:
    7 % EM:  Mx(N+s) matrix representing the contributions at the M sites
     6% OUTPUT:
     7%  EM:  Mx(N+s) matrix representing the contributions at the M sites
    88%   from unit sources located at each of the N centers, + (s+1) columns
    99%   representing the contribution of the linear gradient part.
    1010%  use : U_interp=EM*U_tps
    1111%
    12 %INPUT:
    13 %dsites:  Mxs matrix representing the postions of the M 'observation' sites, with s the space dimension
    14 %ctrs: Nxs matrix  representing the postions of the N centers, sources of the tps,
     12% INPUT:
     13%  dsites:  Mxs matrix representing the postions of the M 'observation' sites, with s the space dimension
     14%  ctrs: Nxs matrix  representing the postions of the N centers, sources of the tps,
    1515%
    16 % related functions:
    17 % tps_coeff, tps_eval_dxy
    18 % tps_coeff_field, set_subdomains, filter_tps, calc_field
     16% RELATED FUNCTIONS:
     17%  tps_coeff, tps_eval_dxy
     18%  tps_coeff_field, set_subdomains, filter_tps, calc_field
    1919
    2020%=======================================================================
  • trunk/src/tps_eval_dxy.m

    r809 r811  
    44%------------------------------------------------------------------------
    55% OUTPUT:
    6    DMX: Mx(N+3) matrix representing the contributions to the X
    7    derivatives at the M sites from unit sources located at each of the N
    8    centers, + 3 columns representing the contribution of the linear gradient part.
    9    DMY: idem for Y derivatives
     6DMX: Mx(N+3) matrix representing the contributions to the X
     7derivatives at the M sites from unit sources located at each of the N
     8centers, + 3 columns representing the contribution of the linear gradient part.
     9DMY: idem for Y derivatives
    1010%
    1111% INPUT:
    12  dsites: M x s matrix of interpolation site coordinates (s=space dimension=2 here)
    13  ctrs: N x s matrix of centre coordinates (initial data)
     12dsites: M x s matrix of interpolation site coordinates (s=space dimension=2 here)
     13ctrs: N x s matrix of centre coordinates (initial data)
    1414%
    15 % related functions:
    16 % tps_coeff, tps_eval
    17 % tps_coeff_field, set_subdomains, filter_tps, calc_field
     15% RELATED FUNCTIONS:
     16%  tps_coeff, tps_eval
     17%  tps_coeff_field, set_subdomains, filter_tps, calc_field
    1818
    1919%=======================================================================
Note: See TracChangeset for help on using the changeset viewer.