revise colourscaleplot

- change name slightly
- add more options
- add linewidth changes

Author: wspr

colourscaleplot.m renamed to colourscale.m

@@ -1,11 +1,11 @@
 
-function [ RGBOUT ] = colourscaleplot( color , series , permute )
-%COLOURPLOT Make colourful, nice-looking plots
+function [ RGBOUT ] = colourscale( varargin )
+%COLOURSCALEPLOT Make colourful, nice-looking plots
 %  This function takes the current figure and applies a series of colours
 %  to each "line". These colours are a spectrum of saturations and intensities for
 %  a given colour hue. 
 %
-% COLOURPLOT(H)
+% COLOURSCALE('hue',H)
 %  Use hue H for colour scheme. Since H is a standard "HSV" hue, it varies
 %  from zero to one, where approximately:
 %      H=0.0  - red
@@ -18,15 +18,15 @@
 %      H=0.85 - magenta
 %      H=1.0  - red again
 %
-% COLOURPLOT(C,N)
+% COLOURSCALE(...,'repeat',N)
 %  An optional argument specifies the number of times to use the
 %  colour space: e.g., colourplot(2) will turn, in a graph with 6 data
 %  series, the first and fourth plot blue, the second and fifth
 %  green, and the third and six red. The divisor of the number of
 %  plots and the number of colour space repetitions must be an
 %  integer.
 %
-% COLOURPLOT(C,N,PERMUTE)
+% COLOURSCALE(...,'permute',P)
 %  By default the lines are coloured in the order in which they
 %  were plot. This order can be changed by specifying a permutation
 %  of the order in the second argument, such as in a four-plot graph:
@@ -35,7 +35,7 @@
 %  If the 'UserData' for a data line is 'colourplot:ignore', then
 %  it will not be included in the COLOURPLOT colouring.
 %
-%  RGBOUT = colourplot( ... ) will simply return the colours that
+%  RGBOUT = colourscale( ... ) will simply return the colours that
 %  would be used, but it will NOT attempt to colour the plot.
 %
 %
@@ -46,11 +46,26 @@
 % COLOURSCALEPLOT  v0.1  Will Robertson
 % Licence appended.
 
-if nargin < 2
-  series = 1;
-end
-if nargin < 1
-  color = 0.2;
+p = inputParser;
+p.addOptional('hue',0.2);
+p.addOptional('chroma',70);
+p.addOptional('repeat',1);
+p.addOptional('permute',[]);
+p.addOptional('lumin_min',[65 50 40 30]);
+p.addOptional('lumin_max',[65 80 80 90]);
+p.addOptional('linewidth',[1 2]);
+
+p.parse(varargin{:});
+
+hue     = p.Results.hue;
+chroma  = p.Results.chroma;
+series  = p.Results.repeat;
+permute = p.Results.permute;
+lumin_min = p.Results.lumin_min;
+lumin_max = p.Results.lumin_max;
+lw_range = p.Results.linewidth;
+if numel(lw_range) == 1
+  lw_range = lw_range([1 1]);
 end
 
 ch = findobj(gca,'Type','line','-not','UserData','colourplot:ignore');
@@ -71,18 +86,20 @@
   ncol1 = Ncol/2;
   ncol2 = Ncol/2;
 end
-v1 = color/2; v2 = 1;
-
-switch Ncol
-  case 1, lmin = 65; lmax = 65;
-  case 2, lmin = 50; lmax = 80;
-  case 3, lmin = 40; lmax = 80;
-  otherwise, 
-          lmin = 40; lmax = 85;
+v1 = hue/2; v2 = 1;
+
+Nlum = numel(lumin_max);
+if numel(lumin_min) ~= numel(lumin_max)
+  error('Min and max luminance vectors must be equal size.')
 end
 
-hcl(:,1) = color*360;
-hcl(:,2) = 80;
+lmin = lumin_min(min([Ncol,Nlum]));
+lmax = lumin_max(min([Ncol,Nlum]));
+
+lw = linspace(lw_range(1),lw_range(2),Ncol);
+
+hcl(:,1) = hue*360;
+hcl(:,2) = chroma;
 hcl(:,3) = linspace(lmin,lmax,Ncol)';
 
 rgb = nan(size(hcl));
@@ -91,7 +108,7 @@
 end
 rgb = rgb/255;
 
-if nargin < 2
+if isempty(permute)
   permute = 1:Nch;
 else
   if ~isequal(sort(permute),1:Nch)
@@ -101,14 +118,17 @@
 
 if nargout == 0
   for ii = 1:Nch
+    ind = mod(ii-1,Ncol)+1;
     if isequal(get(ch(ii),'type'),'line')
-      set(ch(permute(ii)),'Color',rgb(mod(ii-1,Ncol)+1,:),...
+      set(ch(permute(ii)),...
+        'Color',rgb(ind,:),...
+        'LineWidth',lw(ind),...
         'UserData','colourplot:ignore')
     end
     if isequal(get(ch(ii),'type'),'surface')
       set(ch(permute(ii)),...
-        'FaceColor',rgb(mod(ii-1,Ncol)+1,:),...
-        'EdgeColor',rgb(mod(ii-1,Ncol)+1,:),...
+        'FaceColor',rgb(ind,:),...
+        'EdgeColor',rgb(ind,:),...
         'UserData','colourplot:ignore')
     end
   end

colourscale_test.m

@@ -0,0 +1,59 @@
+%% Example of the COLOURSCALE function
+
+%% Example of different number of plots
+
+% number of plots to demo:
+M = 3;
+N = 3;
+
+% points per graph:
+p = 20;
+
+% colour: (0-1)
+H = 0.6;
+
+% linewidths:
+LW = [2 4]; % more exaggerated than default
+
+figure(1)
+for m = 1:M
+  for n = 1:N
+    c = N*(m-1)+n; % count from 1:N*M
+    subplot(M,N,c); cla;
+    xx = linspace(0,1,p);
+    yy = repmat(1:c,[p 1])+rand(p,c);
+    plot(xx,yy)
+    colourscale('hue',H,'linewidth',LW);
+    title(['Number of lines: ',num2str(c)])
+    axis tight
+  end
+end
+
+%% Example across colours
+
+% number of plots to demo:
+M = 4;
+N = 4;
+
+% lines per graph:
+l = 5;
+
+% points per line:
+p = 20;
+
+hrange = linspace(0,1,M*N+1);
+hrange(end) = [];
+
+figure(2)
+for m = 1:M
+  for n = 1:N
+    c = N*(m-1)+n; % count from 1:N*M
+    subplot(M,N,c); cla;
+    xx = linspace(0,1,p);
+    yy = repmat(1:l,[p 1])+rand(p,l);
+    plot(xx,yy,'linewidth',2)
+    colourscale('hue',hrange(c));
+    title(['H=',num2str(hrange(c))])
+    axis tight
+  end
+end