source: trunk/doc/FUNCTIONS_DOC/proj_field.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.5 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 proj_field</title>
6  <meta name="keywords" content="proj_field">
7  <meta name="description" content="'proj_field': projects the field on a projection object">
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; proj_field.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>proj_field
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>'proj_field': projects the field on a projection object</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 [ProjData,errormsg]=proj_field(FieldData,ObjectData,IndexObj) </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">'proj_field': projects the field on a projection object
31--------------------------------------------------------------------------
32  function [ProjData,errormsg]=proj_field(FieldData,ObjectData,IndexObj)
33
34 OUTPUT:
35 ProjData structure containing the fields of the input field FieldData,
36 transmitted or projected on the object, plus the additional fields
37    .UMax, .UMin, .VMax, .VMin: min and max of velocity components in a domain
38    .UMean,VMean: mean of the velocity components in a domain
39    .AMin, AMax: min and max of a scalar
40    .AMean: mean of a scalar in a domain 
41  .NbPix;
42  .DimName=  names of the matrix dimensions (matlab cell)
43  .DimValue= values of the matricx dimensions (matlab vector, same length as .DimName);
44  .VarName= names of the variables [ProjData.VarName {'A','AMean','AMin','AMax'}];
45  .VarDimNameIndex= dimensions of the variables, indicated by indices in the list .DimName;
46
47INPUT
48 ObjectData: structure characterizing the projection object
49    .Style : style of projection object
50    .ProjMode=type of projection ;
51    .CoordType: 'px' or 'phys' type of coordinates defining the object position
52    .Phi  angle of rotation (=0 by default)
53    .ProjAngle=angle of projection;
54    .DX,.DY,.DZ=increments along each coordinate
55    .Coord(nbpoints,3): set of coordinates defining the object position;</pre></div>
56
57<!-- crossreference -->
58<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
59This function calls:
60<ul style="list-style-image:url(../matlabicon.gif)">
61<li><a href="find_field_indices.html" class="code" title="function [CellVarIndex,NbDim,VarType,errormsg]=find_field_indices(Data)">find_field_indices</a>       'find_file_indices': test field structure for input in proj_field and plot_field</li><li><a href="griddata_uvmat.html" class="code" title="function ZI = griddata_uvmat(X,Y,Z,XI,YI)">griddata_uvmat</a>        'griddata_uvmat': function griddata_uvmat(vec2_X,vec2_Y,vec2_U,vec_X,vec_Y,'linear')</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></ul>
62This function is called by:
63<ul style="list-style-image:url(../matlabicon.gif)">
64<li><a href="update_obj.html" class="code" title="function Object_out=update_obj(UvData,IndexObj,ObjectData,PlotHandles)">update_obj</a>        'update_obj': update the object graph representation and its projection field, record it in the uvmat interface</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>
65<!-- crossreference -->
66
67
68
69<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>
70</body>
71</html>
Note: See TracBrowser for help on using the repository browser.