source: trunk/doc/FUNCTIONS_DOC/update_obj.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 update_obj</title>
6  <meta name="keywords" content="update_obj">
7  <meta name="description" content="'update_obj': update the object graph representation and its projection field, record it in the uvmat interface">
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; update_obj.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>update_obj
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>'update_obj': update the object graph representation and its projection field, record it in the uvmat interface</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 Object_out=update_obj(UvData,IndexObj,ObjectData,PlotHandles) </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">'update_obj': update the object graph representation and its projection field, record it in the uvmat interface
31-------------------------------------------------------------------
32Object=update_obj(UvData,IndexObj,ObjectData,PlotHandles);
33
34OUTPUT:
35UvData: data to be stored as 'Userdata' on the uvmat interface
36IndexObj: object index for a new object added to the list in UvData
37   the function updates UvData.Object{IndexObj}, and possibly adds a new plot (UvData.Plane or Line) in the list atached to the interface
38
39INPUT:
40UvIn: structure stored as 'Userdata' on the uvmat interface
41IndexObjIn: object index for an existing objects stored in UvData
42ObjectData: structure containing the input object properties
43PlotHandles: structure containing the handles of the plotting parameter buttons on the uvmat interface (obtained by get_plot_handles.m)
44-------------------------------------</pre></div>
45
46<!-- crossreference -->
47<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
48This function calls:
49<ul style="list-style-image:url(../matlabicon.gif)">
50<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="plot_object.html" class="code" title="function [hh]=plot_object(ObjectDataIn,ProjObject,hplot,col)">plot_object</a>       'plot_object': draws a projection object (points, line, plane...)</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="set_title.html" class="code" title="function TITLE=set_title(Style,ProjMode)">set_title</a>    'set_title': defines the 'TITLE' of a projection object</li></ul>
51This function is called by:
52<ul style="list-style-image:url(../matlabicon.gif)">
53<li><a href="mouse_up.html" class="code" title="function mouse_up(ggg,eventdata,handles)">mouse_up</a>  'mouse_up': function  activated when the mouse button is released</li><li><a href="set_grid.html" class="code" title="function varargout = set_grid(varargin)">set_grid</a>     'set_grid':produce grid for PIV with one or two images (stereo case)</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></ul>
54<!-- crossreference -->
55
56
57
58<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>
59</body>
60</html>
Note: See TracBrowser for help on using the repository browser.