source: trunk/doc/FUNCTIONS_DOC/find_field_indices.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: 4.3 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 find_field_indices</title>
6  <meta name="keywords" content="find_field_indices">
7  <meta name="description" content="'find_file_indices': test field structure for input in proj_field and plot_field">
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; find_field_indices.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>find_field_indices
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>'find_file_indices': test field structure for input in proj_field and plot_field</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 [CellVarIndex,NbDim,VarType,errormsg]=find_field_indices(Data) </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">'find_file_indices': test field structure for input in proj_field and plot_field
31group the variables  into 'fields' with common dimensions
32----------------------------------------------------------------------
33 function [DimVarIndex,CellVarIndex,NbDim,VarType]=find_field_indices(Data)
34
35OUTPUT:
36 CellVaxIndex: cell whose elements are arrays of indices in the list data.ListVarName 
37              CellvarIndex{i} represents a set of variables with the same dimensions
38 NbDim: array with the length of CellVarIndex, giving its  space dimension
39 VarType: cell array of structures with fields
40      .coord_x, y, z: indices (in .ListVarname) of variables representing  unstructured coordinates x, y, z
41      .vector_x,_y,_z: indices of variables giving the vector components x, y, z
42      .warnflag: index of warnflag
43      .errorflag: index of error flag
44      .ancillary: indices of ancillary variables
45      .image   : B/W image, (behaves like scalar)
46      .color : color image, the last index, which is not a coordinate variable, represent the 3 color components rgb
47      .discrete: like scalar, but set of data points without continuity, represented as dots in a usual plot, instead of continuous lines otherwise
48      .scalar: scalar field (default)</pre></div>
49
50<!-- crossreference -->
51<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
52This function calls:
53<ul style="list-style-image:url(../matlabicon.gif)">
54</ul>
55This function is called by:
56<ul style="list-style-image:url(../matlabicon.gif)">
57<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="plot_field.html" class="code" title="function [PlotType,PlotParamOut,haxes]= plot_field(Data,haxes,PlotParam,KeepLim,PosColorbar)">plot_field</a>    'plot_field': plot any field with the structure defined in the uvmat package</li><li><a href="proj_field.html" class="code" title="function [ProjData,errormsg]=proj_field(FieldData,ObjectData,IndexObj)">proj_field</a>       'proj_field': projects the field on a projection object</li><li><a href="sub_field.html" class="code" title="function [SubData,errormsg]=sub_field(Field,Field_1)">sub_field</a>        'sub_field': combines two input fields</li><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>
58<!-- crossreference -->
59
60
61
62<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>
63</body>
64</html>
Note: See TracBrowser for help on using the repository browser.