-
Notifications
You must be signed in to change notification settings - Fork 16
/
colourscale.m
331 lines (285 loc) · 10.3 KB
/
colourscale.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
function [ RGBOUT, LINEPROPOUT ] = colourscale( varargin )
%COLOURSCALE 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.
%
% COLOURSCALE(...,'ch',CH)
% Use CH to specify the mode of operation:
% CH is empty - apply colours to any lines present in the active axis
% except lines for which UserData = 'colourscale:ignore'
% CH is array of line handles - apply colours to specified lines
% CH is an integer - generate CH number of colours (RBGOUT) and line
% properties (LINEPROPOUT) to be used later
%
% COLOURSCALE(...,'hue',H)
% Use hue H for colour scheme (default 20).
% H is a standard "HSV" hue, from 0 to 100, where approx.:
% H = 0 - red
% H = 10 - orange
% H = 15 - yellow
% H = 35 - green
% H = 55 - light blue
% H = 60 - dark blue
% H = 75 - purple
% H = 85 - magenta
% H = 100 - red again
%
% COLOURSCALE(...,'chroma',C)
% Use chroma C for colour scheme (default 70).
% Chroma appears to be a nonlinear parameter with sensible maximum; values
% around 40 (dull) to 100 (bright) appear to be best, although higher than
% this produces brighter colours they also start clipping what is possible
% represent in RGB.
%
% COLOURSCALE(...,'lumin',[l_N L_N])
% Use [l_N L_N] as the range for lumin values to vary over. Lumin values
% can range from 0 (dark/black) to 100 (light).
%
% COLOURSCALE(...,'lumin',{[l_1 L_1] [l_2 L_2] ... [l_M L_M]})
% For N colours, use [l_N L_N] as the range for lumin values to vary over.
% This approach isn't the most convenient for the user but allows the most
% flexibility, as different lumin ranges appears best for different values
% of N, and for different chroma/hue combinations.
% If N>M then [l_M L_M] is used as the range.
%
% COLOURSCALE(...,'linewidth',[LW1 LW2])
% If not specified, the plots take on their "natural" linewidth as default
% or as specified by the user. If set to a two-element vector, the
% linewidths of the lines will be set to vary linearly from LW1 to LW2 as
% the plots change colour from dark to light. (This is useful as lighter
% lines often need to be slightly thicker to remain visible compared to
% darker lines.)
%
% COLOURSCALE(...,'repeat',N)
% An optional argument specifies the number of times to use the
% colour space: e.g., colourscale(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.
%
% 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 using
% indexing, such as in a four-plot graph:
% colourscale(...,'permute',[1 3 2 4])
%
% RGBOUT = COLOURSCALE(...)
% As above, and also returns the colours in a CH x 3 array.
%
% [RGBOUT,LINEPROPSOUT] = COLOURSCALE(...)
% As above, and also returns the line properties in a CH x 2 or CH x 4
% cell array. Example:
% [RGBOUT,LINEPROPSOUT] = COLOURSCALE(...,'ch',2);
% plot(x1,y1,LINEPROPSOUT{1,:});
% plot(x2,y2,LINEPROPSOUT{2,:});
%% COLOURSCALE v0.1
%
% Copyright (c) 2017-2018 Will Robertson
% All rights reserved.
% Licence (BSD) appended.
%
% Please report bugs and feature requests for
% this package at the development repository:
% <http://github.com/wspr/matlab-plot-tools/>
%% Option parsing
p = inputParser;
p.addOptional('ch',findobj(gca,'Type','line','-not','UserData','colourscale:ignore'),@(x) all(isgraphics(x,'line')) || (isscalar(x)&&isnumeric(x)));
p.addOptional('hue',20,@isnumeric);
p.addOptional('chroma',70,@isnumeric);
p.addOptional('repeat',1,@isnumeric);
p.addOptional('permute',[],@isnumeric);
p.addOptional('lumin',{[65 65] [50 80] [40 80] [30 90]},@(x) iscell(x) || isnumeric(x));
p.addOptional('linewidth',[],@isnumeric);
p.parse(varargin{:});
ch = p.Results.ch;
hue = p.Results.hue;
chroma = p.Results.chroma;
Nseries = p.Results.repeat;
permute = p.Results.permute;
lumin = p.Results.lumin;
lw_range = p.Results.linewidth;
%% Option massaging
if ~isempty(lw_range)
if numel(lw_range) == 1
lw_range = lw_range([1 1]);
end
end
if isnumeric(lumin)
lumin = {lumin};
end
if isscalar(ch) && isnumeric(ch)
do_apply_colours = false;
Nch = ch;
else
do_apply_colours = true;
Nch = numel(ch);
end
Ncol = Nch/Nseries;
Nlum = numel(lumin);
if round(Ncol) ~= Ncol
% Each set of data series must be the same length to avoid rounding problems!!
disp(['There are ',num2str(Nch),' data series'])
error('There must be an integer multiple of specified data series in the figure.')
end
if isempty(permute)
permute = 1:Nch;
else
if ~isequal(sort(permute),1:Nch)
error('2nd argument must be a permutation of 1:N where N is the number of colours.');
end
end
%% Calculate colours
% indexing into lumin values needs a trick.
% let's say we have lumin values of [65 50 40 30];
% for n=1, lumin=65; n=3, lumin=40; etc.
% for n=6, the index is too high, so we want n=4, which is min([n,Nlum]):
lumin_index = min([Ncol,Nlum]);
lmin = lumin{lumin_index}(1);
lmax = lumin{lumin_index}(2);
% for linewidths we just do linear interpolation, no need for the indexing
% as in the above:
if ~isempty(lw_range)
lw = linspace(lw_range(1),lw_range(2),Ncol);
end
hcl = nan(Ncol,3);
hcl(:,1) = hue*3.6;
hcl(:,2) = chroma;
hcl(:,3) = linspace(lmin,lmax,Ncol)';
rgb = nan(size(hcl));
for ii = 1:Ncol
rgb(ii,:) = hcl2rgb(hcl(ii,1),hcl(ii,2),hcl(ii,3))';
end
rgb = rgb/255;
%% Assign colours
for ii = 1:Nch
ind = mod(ii-1,Ncol)+1;
if isempty(lw_range)
lineprop(permute(ii),:) = {
'Color',rgb(ind,:),...
};
else
lineprop(permute(ii),:) = {
'Color',rgb(ind,:),...
'LineWidth',lw(ind),...
};
end
if do_apply_colours
set(ch(permute(ii)), lineprop{permute(ii),:});
end
end
%% Fin
if nargout > 0
RGBOUT = rgb;
end
if nargout > 1
LINEPROPOUT = lineprop;
end
return
%% Licence
%
% Distributed under the BSD licence in accordance with the wishes of the
% Matlab File Exchange.
%
% Redistribution and use in source and binary forms, with or without
% modification, are permitted provided that the following conditions are met:
% * Redistributions of source code must retain the above copyright
% notice, this list of conditions and the following disclaimer.
% * Redistributions in binary form must reproduce the above copyright
% notice, this list of conditions and the following disclaimer in the
% documentation and/or other materials provided with the distribution.
%
% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ''AS IS'' AND ANY
% EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
% WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
% DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
% DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
% (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
% LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
% ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
% (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
% THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
function rgb = hcl2rgb(h, c, l)
%HCL2RGB Convert a HCL (i.e., CIELUV) color space value to one
% in sRGB space.
% RGB = HCL2RGB(H, C, L) will convert the color (H, C, L) in
% HCL color space to RGB = [R, G, B] in sRGB color space.
% Values that lie outside sRGB space will be silently corrected.
% Code written by Nicholas J. Hughes, 2014, released under the following
% licence.
%
% Some minor alternations by Will Robertson, 2018.
%
% The MIT License (MIT)
%
% Copyright (c) 2014 Nicholas J. Hughes
%
% Permission is hereby granted, free of charge, to any person obtaining a copy
% of this software and associated documentation files (the "Software"), to deal
% in the Software without restriction, including without limitation the rights
% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
% copies of the Software, and to permit persons to whom the Software is
% furnished to do so, subject to the following conditions:
%
% The above copyright notice and this permission notice shall be included in
% all copies or substantial portions of the Software.
%
% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
% THE SOFTWARE.
% D65 White Point
WHITE_Y = 100.000;
WHITE_u = 0.1978398;
WHITE_v = 0.4683363;
if l < 0 || l > WHITE_Y || c < 0
error('Invalid CIE-HCL color.');
end
% First convert to CIELUV (just a polar to Cartesian coordinate transformation)
L = l;
U = c * cosd(h);
V = c * sind(h);
% Now convert to CIEXYZ
if L <= 0 && U == 0 && V == 0
X = 0;
Y = 0;
Z = 0;
else
Y = WHITE_Y;
if L > 7.999592
Y = Y*((L + 16)/116)^3;
else
Y = Y*L/903.3;
end
u = U/(13*L) + WHITE_u;
v = V/(13*L) + WHITE_v;
X = (9.0*Y*u)/(4*v);
Z = -X/3 - 5*Y + 3*Y/v;
end
% Now convert to sRGB
r = gamma_correct((3.240479*X - 1.537150*Y - 0.498535*Z)/WHITE_Y);
g = gamma_correct((-0.969256*X + 1.875992*Y + 0.041556*Z)/WHITE_Y);
b = gamma_correct((0.055648*X - 0.204043*Y + 1.057311*Z)/WHITE_Y);
% Round to integers and correct
rgb = [r, g, b];
rgb = round(255 * rgb);
% if any(rgb(:) > 255)
% warning('Colour outside RGB range; clipping.')
% end
% if any(rgb(:) < 0)
% warning('Colour less than zero in RGB; clipping.')
% end
rgb(rgb(:) > 255) = 255;
rgb(rgb(:) < 0) = 0;
function u = gamma_correct(u)
% Standard CRT Gamma
GAMMA = 2.4;
if u > 0.00304
u = 1.055*u^(1/GAMMA) - 0.055;
else
u = 12.92*u;
end