source: trunk/src/uvmat_doc/FUNCTIONS_DOC/set_col_vec.html @ 37

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

create_grid.fig ,
uvmat_doc and all the included files added
File size: 9.8 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 set_col_vec</title>
6  <meta name="keywords" content="set_col_vec">
7  <meta name="description" content="'set_col_vec': sets the color code for vectors depending on a scalar vec_C and parameters given by the struct colcode">
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; set_col_vec.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>set_col_vec
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>'set_col_vec': sets the color code for vectors depending on a scalar vec_C and parameters given by the struct colcode</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 [colorlist,col_vec,colcode_out]=set_col_vec(colcode,vec_C) </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">'set_col_vec': sets the color code for vectors depending on a scalar vec_C and parameters given by the struct colcode
31function [colorlist,col_vec,minC,colcode1,colcode2,maxC]=colvec(colcode,vec_C)
32OUTPUT
33colorlist(nb,3); %list of nb colors
34col_vec, size=[length(vec_C),3)];%list of color indices corresponding to vec_C
35minC, maxC: min and max of vec_C
36colcode1, colcode2: absolute threshold in vec_C corresponding to colcode.colcode1 and colcode.colcode2
37INPUT
38 colcode: struture setting the colorcode for vectors
39 colcode.CName: 'ima_cor','black','white',...
40 colcode.ColorCode ='black', 'white', 'rgb','brg', '64 colors'
41 colcode.FixedCbounds =0; thresholds scaling relative to min and max, =1 fixed thresholds
42 colcode.MinC; min
43 colcode.MaxC; max
44 colcode.colcode1: first threshold for rgb, relative to min (0) and max (1)
45 colcode.colcode2: second threshold for rgb, relative to min (0) and max (1),
46 rmq: we need min &lt;= colcode1 &lt;= colcode2 &lt;= max, otherwise
47 colcode1 and colcode2 are adjusted to the bounds
48 vec_C: matlab vector representing the scalar setting the color</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="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>
58<!-- crossreference -->
59
60
61<h2><a name="_source"></a>SOURCE CODE <a href="#_top"><img alt="^" border="0" src="../up.png"></a></h2>
62<div class="fragment"><pre>0001 <span class="comment">%'set_col_vec': sets the color code for vectors depending on a scalar vec_C and parameters given by the struct colcode</span>
630002 <span class="comment">%function [colorlist,col_vec,minC,colcode1,colcode2,maxC]=colvec(colcode,vec_C)</span>
640003 <span class="comment">%OUTPUT</span>
650004 <span class="comment">%colorlist(nb,3); %list of nb colors</span>
660005 <span class="comment">%col_vec, size=[length(vec_C),3)];%list of color indices corresponding to vec_C</span>
670006 <span class="comment">%minC, maxC: min and max of vec_C</span>
680007 <span class="comment">%colcode1, colcode2: absolute threshold in vec_C corresponding to colcode.colcode1 and colcode.colcode2</span>
690008 <span class="comment">%INPUT</span>
700009 <span class="comment">% colcode: struture setting the colorcode for vectors</span>
710010             <span class="comment">% colcode.CName: 'ima_cor','black','white',...</span>
720011             <span class="comment">% colcode.ColorCode ='black', 'white', 'rgb','brg', '64 colors'</span>
730012             <span class="comment">% colcode.FixedCbounds =0; thresholds scaling relative to min and max, =1 fixed thresholds</span>
740013             <span class="comment">% colcode.MinC; min</span>
750014             <span class="comment">% colcode.MaxC; max</span>
760015             <span class="comment">% colcode.colcode1: first threshold for rgb, relative to min (0) and max (1)</span>
770016             <span class="comment">% colcode.colcode2: second threshold for rgb, relative to min (0) and max (1),</span>
780017             <span class="comment">% rmq: we need min &lt;= colcode1 &lt;= colcode2 &lt;= max, otherwise</span>
790018             <span class="comment">% colcode1 and colcode2 are adjusted to the bounds</span>
800019 <span class="comment">% vec_C: matlab vector representing the scalar setting the color</span>
810020 <a name="_sub0" href="#_subfunctions" class="code">function [colorlist,col_vec,colcode_out]=set_col_vec(colcode,vec_C)</a>
820021
830022 col_vec=[];
840023 colcode_out=colcode;<span class="comment">%default</span>
850024 <span class="keyword">if</span> isempty(vec_C) || ~isnumeric(vec_C)
860025     colorlist=[0 0 1]; <span class="comment">%blue</span>
870026     <span class="keyword">return</span>
880027 <span class="keyword">end</span>
890028 <span class="keyword">if</span> (isfield(colcode,<span class="string">'FixedCbounds'</span>) &amp;&amp; isequal(colcode.FixedCbounds,1))
900029     minC=colcode.MinC;
910030     maxC=colcode.MaxC;
920031 <span class="keyword">else</span>
930032     minC=min(vec_C);
940033     maxC=max(vec_C);
950034 <span class="keyword">end</span>
960035
970036 <span class="comment">%default input parameters</span>
980037 <span class="keyword">if</span> ~isstruct(colcode),colcode=[];<span class="keyword">end</span>;
990038 <span class="keyword">if</span> ~isfield(colcode,<span class="string">'ColorCode'</span>) || isempty(colcode.ColorCode)
1000039     colorlist=[0 0 1]; <span class="comment">%blue</span>
1010040     <span class="keyword">return</span>
1020041 <span class="keyword">end</span>
1030042 <span class="keyword">if</span>  isfield(colcode,<span class="string">'colcode1'</span>)
1040043     colcode1=minC+colcode.colcode1*(maxC-minC);
1050044 <span class="keyword">else</span>
1060045     colcode1=minC+(maxC-minC)/3;<span class="comment">%default</span>
1070046 <span class="keyword">end</span>
1080047 <span class="keyword">if</span> isfield(colcode,<span class="string">'colcode2'</span>)
1090048     colcode2=minC+colcode.colcode2*(maxC-minC);
1100049 <span class="keyword">else</span>
1110050     colcode2=minC+2*(maxC-minC)/3;<span class="comment">%default</span>
1120051 <span class="keyword">end</span>
1130052 colcode_out.MinC=minC;
1140053 colcode_out.MaxC=maxC;
1150054
1160055 <span class="keyword">if</span> strcmp(colcode.ColorCode,<span class="string">'black'</span>)
1170056     colorlist(1,:)=[0 0 0];<span class="comment">%black</span>
1180057     col_vec=ones(size(vec_C));<span class="comment">%all vectors at color#1</span>
1190058 <span class="keyword">elseif</span> strcmp(colcode.ColorCode,<span class="string">'white'</span>)
1200059     colorlist(1,:)=[1 1 1];<span class="comment">%white</span>
1210060     col_vec=ones(size(vec_C));<span class="comment">%all vectors at color#1</span>
1220061 <span class="keyword">elseif</span> strcmp(colcode.ColorCode,<span class="string">'rgb'</span>)|| strcmp(colcode.ColorCode,<span class="string">'bgr'</span>)<span class="comment">% 3 color representation</span>
1230062     ind1=find(vec_C &lt; colcode1); <span class="comment">% =1 for red vectors</span>
1240063     ind_green=find((vec_C &gt;= colcode1) &amp; (vec_C &lt; colcode2));<span class="comment">% =1 for green vectors</span>
1250064     ind3=find(vec_C &gt;= colcode2);<span class="comment">% =1 for blue vectors</span>
1260065     colorlist(2,:)=[0 1 0];<span class="comment">%green</span>
1270066     col_vec(ind1)=1;
1280067     col_vec(ind_green)=2;
1290068     col_vec(ind3)=3;
1300069     <span class="keyword">if</span> strcmp(colcode.ColorCode,<span class="string">'rgb'</span>)
1310070         colorlist(1,:)=[1 0 0];<span class="comment">%red</span>
1320071         colorlist(3,:)=[0 0 1];<span class="comment">%blue</span>
1330072     <span class="keyword">else</span>
1340073         colorlist(1,:)=[0 0 1];<span class="comment">%blue</span>
1350074         colorlist(3,:)=[1 0 0];<span class="comment">%red</span>
1360075     <span class="keyword">end</span>
1370076 <span class="keyword">else</span>
1380077     colorjet=jet;<span class="comment">% ususal colormap from blue to red</span>
1390078     sizlist=size(colorjet);
1400079     indsel=ceil((sizlist(1)/64)*(1:64));
1410080     colorlist(:,1)=colorjet(indsel,1);
1420081     colorlist(:,2)=colorjet(indsel,2);
1430082     colorlist(:,3)=colorjet(indsel,3);
1440083     sizlist=size(colorlist);
1450084     nblevel=sizlist(1);
1460085     col2_1=maxC-minC;
1470086     col_vec=1+floor(nblevel*(vec_C-minC)/col2_1);
1480087     col_vec=col_vec.*(col_vec&lt;= nblevel)+nblevel*(col_vec &gt;nblevel);<span class="comment">% take color #nblevel at saturation</span>
1490088     col_vec=col_vec.*(col_vec&gt;= 1)+  (col_vec &lt;1);<span class="comment">% take color #1 for values below 1</span>
1500089 <span class="keyword">end</span></pre></div>
151<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>
152</body>
153</html>
Note: See TracBrowser for help on using the repository browser.