source: trunk/doc/FUNCTIONS_DOC/series.html @ 51

Last change on this file since 51 was 51, checked in by gostiaux, 11 years ago

added doc repository at the same level than src

File size: 6.1 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2                "http://www.w3.org/TR/REC-html40/loose.dtd">
3<html>
4<head>
5  <title>Description of series</title>
6  <meta name="keywords" content="series">
7  <meta name="description" content="'series': master function associated to the GUI series.m for analysis field series">
8  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
9  <meta name="generator" content="m2html &copy; 2003 Guillaume Flandin">
10  <meta name="robots" content="index, follow">
11  <link type="text/css" rel="stylesheet" href="../m2html.css">
12</head>
13<body>
14<a name="_top"></a>
15<div><a href="../index.html">Home</a> &gt;  <a href="index.html">.</a> &gt; series.m</div>
16
17<!--<table width="100%"><tr><td align="left"><a href="../index.html"><img alt="<" border="0" src="../left.png">&nbsp;Master index</a></td>
18<td align="right"><a href="index.html">Index for .&nbsp;<img alt=">" border="0" src="../right.png"></a></td></tr></table>-->
19
20<h1>series
21</h1>
22
23<h2><a name="_name"></a>PURPOSE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
24<div class="box"><strong>'series': master function associated to the GUI series.m for analysis field series</strong></div>
25
26<h2><a name="_synopsis"></a>SYNOPSIS <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
27<div class="box"><strong>function varargout = series(varargin) </strong></div>
28
29<h2><a name="_description"></a>DESCRIPTION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
30<div class="fragment"><pre class="comment">'series': master function associated to the GUI series.m for analysis field series 
31------------------------------------------------------------------------
32 function varargout = series(varargin)
33 associated with the GUI series.fig
34
35INPUT
36 param: structure with input parameters (link with the GUI uvmat)
37      .menu_coord_str: string for the transform_fct (menu for coordinate transforms)
38      .menu_coord_val: value for transform_fct (menu for coordinate transforms)
39      .FileName: input file name
40      .FileName_1: second input file name
41      .list_field: menu of input fields
42      .index_fields: chosen index
43      .civ1=0 or 1, .interp1,  ... : input civ field type
44
45AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
46  Copyright Joel Sommeria, 2008, LEGI / CNRS-UJF-INPG, sommeria@coriolis-legi.org.
47AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
48     This file is part of the toolbox UVMAT.
49 
50     UVMAT is free software; you can redistribute it and/or modify
51     it under the terms of the GNU General Public License as published by
52     the Free Software Foundation; either version 2 of the License, or
53     (at your option) any later version.
54 
55     UVMAT is distributed in the hope that it will be useful,
56     but WITHOUT ANY WARRANTY; without even the implied warranty of
57     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
58     GNU General Public License (file UVMAT/COPYING.txt) for more details.
59AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA</pre></div>
60
61<!-- crossreference -->
62<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
63This function calls:
64<ul style="list-style-image:url(../matlabicon.gif)">
65<li><a href="calc_field.html" class="code" title="function [DataOut,errormsg]=calc_field(FieldName,DataIn)">calc_field</a>      'calc_field': defines fields (velocity, vort, div...) from civx data and calculate them</li><li><a href="get_field.html" class="code" title="function varargout = get_field(varargin)">get_field</a>    'get_field': display variables and attributes from a Netcdf file, and RUN selected fields</li><li><a href="imadoc2struct.html" class="code" title="function [s,errormsg]=imadoc2struct(ImaDoc)">imadoc2struct</a>       'imadoc2struct': reads the xml file for image documentation</li><li><a href="msgbox_uvmat.html" class="code" title="function varargout = msgbox_uvmat(varargin)">msgbox_uvmat</a>       'msgbox_uvmat': associated with GUI msgbox_uvmat.fig to display message boxes, for error, warning or input calls</li><li><a href="name2display.html" class="code" title="function [RootPath,RootFile,field_count,str2,str_a,str_b,ext,nom_type,subdir]=name2display(fileinput)">name2display</a>        'name2display': extracts the root name and field numbers from an input filename</li><li><a href="name_generator.html" class="code" title="function [filename,num_i1_out,num_j1_out,num_i2_out,num_j2_out,subdir_out]=name_generator(filebase,num_i1,num_j1,ext,nom_type,comp_input,num_i2,num_j2,subdir);">name_generator</a>   'name_generator': creates a file name from a root name and indices.</li><li><a href="nc2struct.html" class="code" title="function [Data,var_detect,ichoice]=nc2struct(nc,varargin)">nc2struct</a>       'nc2struct': transform a netcdf file in a corresponding matlab structure</li><li><a href="num2stra.html" class="code" title="function str=num2stra(num,nom_type,index);">num2stra</a>   'num2stra': transform number to the corresponding character string depending on the nomenclature</li><li><a href="read_imatext.html" class="code" title="function [error,time,TimeUnit,mode,npx,npy,pxcmx,pxcmy]=read_imatext(fileinput);">read_imatext</a>     'read_imatext': reads the .civ file for image documentation (obsolete)</li><li><a href="set_object.html" class="code" title="function varargout = set_object(varargin)">set_object</a>  'set_object': GUI to edit a projection object</li><li><a href="update_menu.html" class="code" title="function menu_str=update_menu(handle,strinput)">update_menu</a>    'update_menu': find an input string in a menu, add it to the menu at the penultimate position if it does not exist</li></ul>
66This function is called by:
67<ul style="list-style-image:url(../matlabicon.gif)">
68<li><a href="uvmat.html" class="code" title="function varargout = uvmat(varargin)">uvmat</a>    'uvmat': function associated with the GUI 'uvmat.fig' for images and data field visualization</li></ul>
69<!-- crossreference -->
70
71
72
73<hr><address>Generated on Wed 10-Mar-2010 20:42:36 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
74</body>
75</html>
Note: See TracBrowser for help on using the repository browser.