source: trunk/src/uvmat_doc/FUNCTIONS_DOC/read_plot_param.html @ 48

Last change on this file since 48 was 37, checked in by sommeria, 15 years ago

create_grid.fig ,
uvmat_doc and all the included files added
File size: 7.0 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 read_plot_param</title>
6  <meta name="keywords" content="read_plot_param">
7  <meta name="description" content="'read_plot_param':  read plotting parameters from the interface uvmat">
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; read_plot_param.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>read_plot_param
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>'read_plot_param':  read plotting parameters from the interface uvmat</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 PlotParam=read_plot_param(handles) </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">'read_plot_param':  read plotting parameters from the interface uvmat
31------------------------------------------
32 function PlotParam=read_plot_param(handles)
33
34 OUTPUT:
35 PlotParam: structure containing the values of all the relevant plotting parameters
36
37 INPUT:
38 handles: structure containing the handles of the relevant uicontrols in the uvmat interface
39
40      -- TODO:   get the handles using get_plot_handles and findobj as  default input --</pre></div>
41
42<!-- crossreference -->
43<h2><a name="_cross"></a>CROSS-REFERENCE INFORMATION <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
44This function calls:
45<ul style="list-style-image:url(../matlabicon.gif)">
46</ul>
47This function is called by:
48<ul style="list-style-image:url(../matlabicon.gif)">
49<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="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>
50<!-- crossreference -->
51
52
53<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
54<div class="fragment"><pre>0001 <span class="comment">%'read_plot_param':  read plotting parameters from the interface uvmat</span>
550002 <span class="comment">%------------------------------------------</span>
560003 <span class="comment">% function PlotParam=read_plot_param(handles)</span>
570004 <span class="comment">%</span>
580005 <span class="comment">% OUTPUT:</span>
590006 <span class="comment">% PlotParam: structure containing the values of all the relevant plotting parameters</span>
600007 <span class="comment">%</span>
610008 <span class="comment">% INPUT:</span>
620009 <span class="comment">% handles: structure containing the handles of the relevant uicontrols in the uvmat interface</span>
630010 <span class="comment">%</span>
640011 <span class="comment">%      -- TODO:   get the handles using get_plot_handles and findobj as  default input --</span>
650012
660013 <a name="_sub0" href="#_subfunctions" class="code">function PlotParam=read_plot_param(handles)</a>
670014
680015 PlotParam.Auto_xy=get(handles.auto_xy,<span class="string">'Value'</span>);
690016
700017 <span class="comment">% scalars</span>
710018 Scalar.MaxA=str2double(get(handles.MaxA,<span class="string">'String'</span>));
720019 Scalar.MinA=str2double(get(handles.MinA,<span class="string">'String'</span>));
730020 Scalar.AutoScal=get(handles.AutoScal,<span class="string">'Value'</span>);
740021 Scalar.BW=get(handles.BW,<span class="string">'Value'</span>);
750022 Scalar.Contours=get(handles.Contours,<span class="string">'Value'</span>)==2;
760023 Scalar.IncrA=str2double(get(handles.IncrA,<span class="string">'String'</span>));
770024 PlotParam.Scalar=Scalar;
780025
790026 <span class="comment">%vectors</span>
800027 Vectors.VecScale=str2double(get(handles.VecScale,<span class="string">'String'</span>));
810028 Vectors.AutoVec=get(handles.AutoVec,<span class="string">'Value'</span>);<span class="comment">%automatic vector length</span>
820029 Vectors.HideFalse=get(handles.HideFalse,<span class="string">'Value'</span>);
830030 Vectors.HideWarning=get(handles.HideWarning,<span class="string">'Value'</span>);
840031 Vectors.decimate4=get(handles.decimate4,<span class="string">'Value'</span>);<span class="comment">% =1; for reducing the nbre of vectors</span>
850032
860033 <span class="comment">%vector color</span>
870034 code_list=get(handles.color_code,<span class="string">'String'</span>);
880035 val=get(handles.color_code,<span class="string">'Value'</span>);
890036 <span class="comment">% menu_col=get(handles.col_vec,'String');</span>
900037 <span class="comment">% menu_val=get(handles.col_vec,'Value');</span>
910038 colcode1=str2double(get(handles.colcode1,<span class="string">'String'</span>));<span class="comment">% first threshold for rgb, first value for'continuous'</span>
920039 colcode2=str2double(get(handles.colcode2,<span class="string">'String'</span>));<span class="comment">% second threshold for rgb, last value (saturation) for 'continuous'</span>
930040
940041 Vectors.ColorCode=code_list{val}; <span class="comment">% option of color code for vectors</span>
950042 Vectors.FixedCbounds=get(handles.AutoVecColor,<span class="string">'Value'</span>);<span class="comment">% =1; fixed scale for color vector, =0 otherwise (default)</span>
960043 Vectors.MinC=str2num(get(handles.min_vec,<span class="string">'String'</span>)); <span class="comment">% imposed min of C, (needed if .FixedCbounds=1)</span>
970044 Vectors.MaxC=str2num(get(handles.max_vec,<span class="string">'String'</span>)); <span class="comment">% imposed max of C, needed if .FixedCbounds=1</span>
980045 <span class="keyword">if</span> Vectors.MaxC &lt;= Vectors.MinC
990046     Vectors.ColorCode=<span class="string">'black'</span>;
1000047 <span class="keyword">else</span>
1010048     Vectors.colcode1=Vectors.MinC+(colcode1-Vectors.MinC)/(Vectors.MaxC-Vectors.MinC);<span class="comment">% relative thresholds</span>
1020049     Vectors.colcode2=Vectors.MinC+(colcode2-Vectors.MinC)/(Vectors.MaxC-Vectors.MinC);
1030050 <span class="keyword">end</span>
1040051 PlotParam.Vectors=Vectors;
1050052</pre></div>
106<hr><address>Generated on Fri 13-Nov-2009 11:17:03 by <strong><a href="http://www.artefact.tk/software/matlab/m2html/">m2html</a></strong> &copy; 2003</address>
107</body>
108</html>
Note: See TracBrowser for help on using the repository browser.