1 |
# Copyright (c) 2003 by Intevation GmbH |
# -*- encoding: iso-8859-1 -*- |
2 |
|
# |
3 |
|
# Copyright (c) 2003-2004 by Intevation GmbH |
4 |
# Authors: |
# Authors: |
5 |
# Jonathan Coles <[email protected]> |
# Jan-Oliver Wagner <[email protected]> (2004) |
6 |
|
# Bernhard Herzog <[email protected]> (2003) |
7 |
|
# Thomas K�ster <[email protected]> (2003) |
8 |
|
# Jonathan Coles <[email protected]> (2003) |
9 |
# |
# |
10 |
# This program is free software under the GPL (>=v2) |
# This program is free software under the GPL (>=v2) |
11 |
# Read the file COPYING coming with Thuban for details. |
# Read the file COPYING coming with Thuban for details. |
25 |
from classification import Classification, ClassGroupSingleton, \ |
from classification import Classification, ClassGroupSingleton, \ |
26 |
ClassGroupRange, ClassGroupProperties |
ClassGroupRange, ClassGroupProperties |
27 |
|
|
28 |
def generate_singletons(_list, ramp, fixes=(None, None, None)): |
def generate_singletons(_list, ramp): |
29 |
"""Generate a new classification consisting solely of singletons. |
"""Generate a new classification consisting solely of singletons. |
30 |
|
|
31 |
The resulting classification will consist of one group for each |
The resulting classification will consist of one group for each |
34 |
_list -- a list of values for each singleton |
_list -- a list of values for each singleton |
35 |
|
|
36 |
ramp -- an object which implements the CustomRamp interface |
ramp -- an object which implements the CustomRamp interface |
|
|
|
|
fixes -- a tuple (lineColor, lineWidth, fillColor) such that |
|
|
if any item is not None, the appropriate property will |
|
|
be fixed to that item value. |
|
37 |
""" |
""" |
38 |
|
|
39 |
clazz = Classification() |
clazz = Classification() |
44 |
|
|
45 |
for value in _list: |
for value in _list: |
46 |
prop = ramp.GetProperties(i / maxValue) |
prop = ramp.GetProperties(i / maxValue) |
|
if fixes[0] is not None: prop.SetLineColor(fixes[0]) |
|
|
if fixes[1] is not None: prop.SetLineWidth(fixes[1]) |
|
|
if fixes[2] is not None: prop.SetFill(fixes[2]) |
|
47 |
clazz.AppendGroup(ClassGroupSingleton(value, prop)) |
clazz.AppendGroup(ClassGroupSingleton(value, prop)) |
48 |
i += 1 |
i += 1 |
49 |
|
|
50 |
return clazz |
return clazz |
51 |
|
|
52 |
def generate_uniform_distribution(min, max, numGroups, ramp, intStep = False, |
def generate_uniform_distribution(min, max, numGroups, ramp, intStep = False): |
|
fixes = (None, None, None)): |
|
53 |
"""Generate a classification with numGroups range groups |
"""Generate a classification with numGroups range groups |
54 |
each with the same interval. |
each with the same interval. |
55 |
|
|
57 |
Useful if the values are integers but the |
Useful if the values are integers but the |
58 |
number of groups specified doesn't evenly |
number of groups specified doesn't evenly |
59 |
divide (max - min). |
divide (max - min). |
|
|
|
|
fixes -- a tuple (lineColor, lineWidth, fillColor) such that |
|
|
if any item is not None, the appropriate property will |
|
|
be fixed to that item value. |
|
60 |
""" |
""" |
61 |
|
|
62 |
clazz = Classification() |
clazz = Classification() |
85 |
else: |
else: |
86 |
_range = Range(("[", cur_min, cur_max, end)) |
_range = Range(("[", cur_min, cur_max, end)) |
87 |
|
|
|
if fixes[0] is not None: prop.SetLineColor(fixes[0]) |
|
|
if fixes[1] is not None: prop.SetLineWidth(fixes[1]) |
|
|
if fixes[2] is not None: prop.SetFill(fixes[2]) |
|
|
|
|
88 |
clazz.AppendGroup(ClassGroupRange(_range, prop)) |
clazz.AppendGroup(ClassGroupRange(_range, prop)) |
89 |
|
|
90 |
cur_min = cur_max |
cur_min = cur_max |
91 |
|
|
92 |
return clazz |
return clazz |
93 |
|
|
94 |
def generate_quantiles(_list, percents, ramp, _range, fixes=(None, None, None)): |
def generate_quantiles(_list, percents, ramp, _range): |
95 |
"""Generates a Classification which has groups of ranges that |
"""Generates a Classification which has groups of ranges that |
96 |
represent quantiles of _list at the percentages given in percents. |
represent quantiles of _list at the percentages given in percents. |
97 |
Only the values that fall within _range are considered. |
Only the values that fall within _range are considered. |
111 |
|
|
112 |
_range -- a Range object |
_range -- a Range object |
113 |
|
|
|
fixes -- a tuple (lineColor, lineWidth, fillColor) such that |
|
|
if any item is not None, the appropriate property will |
|
|
be fixed to that item value. |
|
|
|
|
114 |
Raises a Value Error if 'percents' has fewer than two items, or |
Raises a Value Error if 'percents' has fewer than two items, or |
115 |
does not cover the entire range. |
does not cover the entire range. |
116 |
""" |
""" |
145 |
else: |
else: |
146 |
max = _list[q] |
max = _list[q] |
147 |
|
|
|
if fixes[0] is not None: prop.SetLineColor(fixes[0]) |
|
|
if fixes[1] is not None: prop.SetLineWidth(fixes[1]) |
|
|
if fixes[2] is not None: prop.SetFill(fixes[2]) |
|
|
|
|
148 |
group = ClassGroupRange(Range((start, min, max, end)), prop) |
group = ClassGroupRange(Range((start, min, max, end)), prop) |
|
|
|
|
group.SetLabel("%s%% - %s%%" % (round(oldp*100, 2), |
|
|
round(p*100, 2))) |
|
|
oldp = p |
|
|
start = "]" |
|
|
min = max |
|
|
clazz.AppendGroup(group) |
|
|
i += 1 |
|
|
|
|
|
return (adjusted, clazz) |
|
|
|
|
|
def GenQuantiles0(_list, percents, ramp, _range): |
|
|
"""Same as GenQuantiles, but the first class won't be added to |
|
|
the classification. |
|
|
|
|
|
Returns a tuple (adjusted, Classification, upper_class0) where |
|
|
upper_class0 is the highest value inside the first class. |
|
|
|
|
|
_list -- a sort list of values |
|
|
|
|
|
percents -- a sorted list of floats in the range 0.0-1.0 which |
|
|
represent the upper bound of each quantile. the |
|
|
union of all percentiles should be the entire |
|
|
range from 0.0-1.0 |
|
|
|
|
|
ramp -- an object which implements the CustomRamp interface |
|
|
|
|
|
_range -- a Range object |
|
|
|
|
|
Raises a Value Error if 'percents' has fewer than two items, or |
|
|
does not cover the entire range. |
|
|
""" |
|
|
|
|
|
clazz = Classification() |
|
|
quantiles = calculate_quantiles(_list, percents, _range) |
|
|
adjusted = True |
|
|
|
|
|
if quantiles is not None: |
|
|
|
|
|
numGroups = len(quantiles[3]) - 1 |
|
|
|
|
|
if numGroups > 0: |
|
|
adjusted = quantiles[0] |
|
|
|
|
|
start, min, endMax, right = _range.GetRange() |
|
|
|
|
|
class0 = quantiles[3][0] |
|
|
min = _list[class0[0]] |
|
|
oldp = class0[1] |
|
|
i = 1 |
|
|
end = "]" |
|
149 |
|
|
|
maxValue = float(numGroups - 1) |
|
|
if maxValue < 1: maxValue = 1 |
|
|
for (q, p) in quantiles[3][1:]: |
|
|
prop = ramp.GetProperties(float(i-1) / maxValue) |
|
|
|
|
|
if i == numGroups: |
|
|
max = endMax |
|
|
end = right |
|
|
else: |
|
|
max = _list[q] |
|
|
|
|
|
group = ClassGroupRange(Range((start, min, max, end)), prop) |
|
|
|
|
150 |
group.SetLabel("%s%% - %s%%" % (round(oldp*100, 2), |
group.SetLabel("%s%% - %s%%" % (round(oldp*100, 2), |
151 |
round(p*100, 2))) |
round(p*100, 2))) |
152 |
oldp = p |
oldp = p |
155 |
clazz.AppendGroup(group) |
clazz.AppendGroup(group) |
156 |
i += 1 |
i += 1 |
157 |
|
|
158 |
return (adjusted, clazz, _list[class0[0]]) |
return (adjusted, clazz) |
159 |
|
|
160 |
|
|
161 |
def calculate_quantiles(_list, percents, _range): |
def calculate_quantiles(_list, percents, _range): |
162 |
"""Calculate quantiles for the given _list of percents from the |
"""Calculate quantiles for the given _list of percents from the |
163 |
sorted list of values that are in range. |
sorted list of values that are in range. |
164 |
|
|
165 |
This may not actually generate len(percents) quantiles if |
This may not actually generate len(percents) quantiles if |
166 |
many of the values that fall on quantile borders are the same. |
many of the values that fall on quantile borders are the same. |
167 |
|
|
318 |
class CustomRamp: |
class CustomRamp: |
319 |
|
|
320 |
def __init__(self, prop1, prop2): |
def __init__(self, prop1, prop2): |
321 |
|
"""Create a ramp between prop1 and prop2.""" |
322 |
self.prop1 = prop1 |
self.prop1 = prop1 |
323 |
self.prop2 = prop2 |
self.prop2 = prop2 |
324 |
|
|
325 |
def GetRamp(self): |
def GetRamp(self): |
326 |
|
"""Return this ramp.""" |
327 |
return self |
return self |
328 |
|
|
329 |
def GetProperties(self, index): |
def GetProperties(self, index): |
350 |
+ self.prop1.GetLineWidth() |
+ self.prop1.GetLineWidth() |
351 |
newProps.SetLineWidth(int(round(w))) |
newProps.SetLineWidth(int(round(w))) |
352 |
|
|
353 |
|
s = (self.prop2.GetSize() - self.prop1.GetSize()) \ |
354 |
|
* index \ |
355 |
|
+ self.prop1.GetSize() |
356 |
|
newProps.SetSize(int(round(s))) |
357 |
|
|
358 |
return newProps |
return newProps |
359 |
|
|
360 |
def __SetProperty(self, color1, color2, index, setf): |
def __SetProperty(self, color1, color2, index, setf): |
361 |
|
"""Use setf to set the appropriate property for the point |
362 |
|
index percent between color1 and color2. setf is a function |
363 |
|
to call that accepts a Color object or Transparent. |
364 |
|
""" |
365 |
|
|
366 |
if color1 is Transparent and color2 is Transparent: |
if color1 is Transparent and color2 is Transparent: |
367 |
setf(Transparent) |
setf(Transparent) |
382 |
(color2.blue - color1.blue) * index + color1.blue)) |
(color2.blue - color1.blue) * index + color1.blue)) |
383 |
|
|
384 |
class MonochromaticRamp(CustomRamp): |
class MonochromaticRamp(CustomRamp): |
385 |
|
"""Helper class to make ramps between two colors.""" |
386 |
|
|
387 |
def __init__(self, start, end): |
def __init__(self, start, end): |
388 |
|
"""Create a Monochromatic Ramp. |
389 |
|
|
390 |
|
start -- starting Color |
391 |
|
|
392 |
|
end -- ending Color |
393 |
|
""" |
394 |
sp = ClassGroupProperties() |
sp = ClassGroupProperties() |
395 |
sp.SetLineColor(start) |
sp.SetLineColor(start) |
396 |
sp.SetFill(start) |
sp.SetFill(start) |
401 |
|
|
402 |
CustomRamp.__init__(self, sp, ep) |
CustomRamp.__init__(self, sp, ep) |
403 |
|
|
404 |
GreyRamp = MonochromaticRamp(Color(1, 1, 1), Color(0, 0, 0)) |
grey_ramp = MonochromaticRamp(Color(1, 1, 1), Color(0, 0, 0)) |
405 |
RedRamp = MonochromaticRamp(Color(1, 1, 1), Color(.8, 0, 0)) |
red_ramp = MonochromaticRamp(Color(1, 1, 1), Color(.8, 0, 0)) |
406 |
GreenRamp = MonochromaticRamp(Color(1, 1, 1), Color(0, .8, 0)) |
green_ramp = MonochromaticRamp(Color(1, 1, 1), Color(0, .8, 0)) |
407 |
BlueRamp = MonochromaticRamp(Color(1, 1, 1), Color(0, 0, .8)) |
blue_ramp = MonochromaticRamp(Color(1, 1, 1), Color(0, 0, .8)) |
408 |
GreenToRedRamp = MonochromaticRamp(Color(0, .8, 0), Color(1, 0, 0)) |
green_to_red_ramp = MonochromaticRamp(Color(0, .8, 0), Color(1, 0, 0)) |
409 |
|
|
410 |
class HotToColdRamp: |
class HotToColdRamp: |
411 |
|
"""A ramp that generates properties with colors ranging from |
412 |
|
'hot' colors (e.g. red, orange) to 'cold' colors (e.g. green, blue) |
413 |
|
""" |
414 |
|
|
415 |
def GetRamp(self): |
def GetRamp(self): |
416 |
|
"""Return this ramp.""" |
417 |
return self |
return self |
418 |
|
|
419 |
def GetProperties(self, index): |
def GetProperties(self, index): |
444 |
|
|
445 |
return prop |
return prop |
446 |
|
|
447 |
|
class FixedRamp: |
448 |
|
"""FixedRamp allows particular properties of a ramp to be |
449 |
|
held constant over the ramp. |
450 |
|
""" |
451 |
|
|
452 |
|
def __init__(self, ramp, fixes): |
453 |
|
""" |
454 |
|
ramp -- a source ramp to get the default properties |
455 |
|
|
456 |
|
fixes -- a tuple (lineColor, lineWidth, fillColor) such that |
457 |
|
if any item is not None, the appropriate property will |
458 |
|
be fixed to that item value. |
459 |
|
""" |
460 |
|
|
461 |
|
self.fixes = fixes |
462 |
|
self.ramp = ramp |
463 |
|
|
464 |
|
def GetRamp(self): |
465 |
|
"""Return this ramp.""" |
466 |
|
return self |
467 |
|
|
468 |
|
def GetProperties(self, index): |
469 |
|
"""Return a ClassGroupProperties object whose properties |
470 |
|
represent a point at 'index' between the properties in |
471 |
|
the ramp that initialized this FixedRamp. |
472 |
|
|
473 |
|
index -- a value such that 0 <= index <= 1 |
474 |
|
""" |
475 |
|
|
476 |
|
props = self.ramp.GetProperties(index) |
477 |
|
if self.fixes[0] is not None: props.SetLineColor(self.fixes[0]) |
478 |
|
if self.fixes[1] is not None: props.SetLineWidth(self.fixes[1]) |
479 |
|
if self.fixes[2] is not None: props.SetFill(self.fixes[2]) |
480 |
|
|
481 |
|
return props |