FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

WIP: Add offset normalizer by phobson · Pull Request #3858 · matplotlib/matplotlib · GitHub

Repository navigation

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .png  (1) .py  (2) .rst  (1) All 3 file types selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
7 changes: 7 additions & 0 deletions doc/users/whats_new.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,13 @@ Added a :code:`pivot` kwarg to :func:`~mpl_toolkits.mplot3d.Axes3D.quiver`
that controls the pivot point around which the quiver line rotates. This also
determines the placement of the arrow head along the quiver line.

Offset Normalizers for Colormaps
````````````````````````````````
Paul Hobson/Geosyntec Consultants added a new :class:`matplotlib.colors.OffsetNorm`
class with the help of Till Stensitzki. This is particularly useful when using a
diverging colormap on data that are asymetrically centered around a logical value
(e.g., 0 when data range from -2 to 4).

New backend selection
---------------------

Expand Down
88 changes: 88 additions & 0 deletions lib/matplotlib/colors.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,7 @@ def rgb2hex(rgb):
a = '#%02x%02x%02x' % tuple([int(np.round(val * 255)) for val in rgb[:3]])
return a


hexColorPattern = re.compile("\A#[a-fA-F0-9]{6}\Z")


Expand Down Expand Up @@ -963,6 +964,93 @@ def scaled(self):
return (self.vmin is not None and self.vmax is not None)


class OffsetNorm(Normalize):
"""
A subclass of matplotlib.colors.Normalize.

Normalizes data into the ``[0.0, 1.0]`` interval.
"""
def __init__(self, vmin=None, vcenter=None, vmax=None, clip=False):
"""Normalize data with an offset midpoint

Useful when mapping data unequally centered around a conceptual
center, e.g., data that range from -2 to 4, with 0 as the midpoint.

Parameters
----------
vmin : float, optional
The data value that defines ``0.0`` in the normalized data.
Defaults to the min value of the dataset.

vcenter : float, optional
The data value that defines ``0.5`` in the normalized data.
Defaults to halfway between *vmin* and *vmax*.

vmax : float, optional
The data value that defines ``1.0`` in the normalized data.
Defaults to the the max value of the dataset.

clip : bool, optional (default is False)
If *clip* is True, values beyond *vmin* and *vmax* will be set
to ``0.0`` or ``1.0``, respectively. Otherwise, values outside
the ``[0.0, 1.0]`` will be returned.

Examples
--------
>>> import matplotlib.colors as mcolors
>>> offset = mcolors.OffsetNorm(vmin=-2., vcenter=0., vmax=4.)
>>> data = [-2., -1., 0., 1., 2., 3., 4.]
>>> offset(data)
array([0., 0.25, 0.5, 0.625, 0.75, 0.875, 1.0])

"""

self.vmin = vmin
self.vcenter = vcenter
self.vmax = vmax
self.clip = clip

def __call__(self, value, clip=None):
if clip is None:
clip = self.clip

result, is_scalar = self.process_value(value)

self.autoscale_None(result)
vmin, vcenter, vmax = self.vmin, self.vcenter, self.vmax
if vmin == vmax == vcenter:
result.fill(0)
elif not vmin <= vcenter <= vmax:
raise ValueError("minvalue must be less than or equal to "
"centervalue which must be less than or "
"equal to maxvalue")
else:
vmin = float(vmin)
vcenter = float(vcenter)
vmax = float(vmax)
if clip:
mask = ma.getmask(result)
result = ma.array(np.clip(result.filled(vmax), vmin, vmax),
mask=mask)

x, y = [vmin, vcenter, vmax], [0, 0.5, 1]
# returns a scalar if shape == (1,)
result = np.ma.masked_array(np.interp(value, x, y))

return result

def autoscale_None(self, A):
' autoscale only None-valued vmin or vmax'
if self.vmin is None and np.size(A) > 0:
self.vmin = ma.min(A)

if self.vmax is None and np.size(A) > 0:
self.vmax = ma.max(A)

if self.vcenter is None:
self.vcenter = (self.vmax + self.vmin) * 0.5


class LogNorm(Normalize):
"""
Normalize a given value to the 0-1 range on a log scale
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Viewer requires iframe.
211 changes: 208 additions & 3 deletions lib/matplotlib/tests/test_colors.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from distutils.version import LooseVersion as V

from nose.tools import assert_raises, assert_equal
import nose.tools as nt

import numpy as np
from numpy.testing.utils import assert_array_equal, assert_array_almost_equal
Expand Down Expand Up @@ -98,6 +99,205 @@ def test_Normalize():
_mask_tester(norm, vals)


class BaseNormMixin(object):
def test_call(self):
normed_vals = self.norm(self.vals)
assert_array_almost_equal(normed_vals, self.expected)

def test_inverse(self):
if self.test_inverse:
_inverse_tester(self.norm, self.vals)
else:
pass

def test_scalar(self):
_scalar_tester(self.norm, self.vals)

def test_mask(self):
_mask_tester(self.norm, self.vals)

def test_autoscale(self):
norm = self.normclass()
norm.autoscale([10, 20, 30, 40])
nt.assert_equal(norm.vmin, 10.)
nt.assert_equal(norm.vmax, 40.)

def test_autoscale_None_vmin(self):
norm = self.normclass(vmin=0, vmax=None)
norm.autoscale_None([1, 2, 3, 4, 5])
nt.assert_equal(norm.vmin, 0.)
nt.assert_equal(norm.vmax, 5.)

def test_autoscale_None_vmax(self):
norm = self.normclass(vmin=None, vmax=10)
norm.autoscale_None([1, 2, 3, 4, 5])
nt.assert_equal(norm.vmin, 1.)
nt.assert_equal(norm.vmax, 10.)

def test_scale(self):
norm = self.normclass()
nt.assert_false(norm.scaled())

norm([1, 2, 3, 4])
nt.assert_true(norm.scaled())

def test_process_value_scalar(self):
res, is_scalar = mcolors.Normalize.process_value(5)
nt.assert_true(is_scalar)
assert_array_equal(res, np.array([5.]))

def test_process_value_list(self):
res, is_scalar = mcolors.Normalize.process_value([5, 10])
nt.assert_false(is_scalar)
assert_array_equal(res, np.array([5., 10.]))

def test_process_value_tuple(self):
res, is_scalar = mcolors.Normalize.process_value((5, 10))
nt.assert_false(is_scalar)
assert_array_equal(res, np.array([5., 10.]))

def test_process_value_array(self):
res, is_scalar = mcolors.Normalize.process_value(np.array([5, 10]))
nt.assert_false(is_scalar)
assert_array_equal(res, np.array([5., 10.]))


class BaseOffsetNorm(BaseNormMixin):
normclass = mcolors.OffsetNorm
test_inverse = False

class test_OffsetNorm_Even(BaseOffsetNorm):
def setup(self):
self.norm = self.normclass(vmin=-1, vcenter=0, vmax=4)
self.vals = np.array([-1.0, -0.5, 0.0, 1.0, 2.0, 3.0, 4.0])
self.expected = np.array([0.0, 0.25, 0.5, 0.625, 0.75, 0.875, 1.0])


class test_OffsetNorm_Odd(BaseOffsetNorm):
def setup(self):
self.normclass = mcolors.OffsetNorm
self.norm = self.normclass(vmin=-2, vcenter=0, vmax=5)
self.vals = np.array([-2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0, 5.0])
self.expected = np.array([0.0, 0.25, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0])


class test_OffsetNorm_AllNegative(BaseOffsetNorm):
def setup(self):
self.normclass = mcolors.OffsetNorm
self.norm = self.normclass(vmin=-10, vcenter=-8, vmax=-2)
self.vals = np.array([-10., -9., -8., -6., -4., -2.])
self.expected = np.array([0.0, 0.25, 0.5, 0.666667, 0.833333, 1.0])


class test_OffsetNorm_AllPositive(BaseOffsetNorm):
def setup(self):
self.normclass = mcolors.OffsetNorm
self.norm = self.normclass(vmin=0, vcenter=3, vmax=9)
self.vals = np.array([0., 1.5, 3., 4.5, 6.0, 7.5, 9.])
self.expected = np.array([0.0, 0.25, 0.5, 0.625, 0.75, 0.875, 1.0])


class test_OffsetNorm_NoVs(BaseOffsetNorm):
def setup(self):
self.normclass = mcolors.OffsetNorm
self.norm = self.normclass(vmin=None, vcenter=None, vmax=None)
self.vals = np.array([-2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0])
self.expected = np.array([0., 0.16666667, 0.33333333,
0.5, 0.66666667, 0.83333333, 1.0])
self.expected_vmin = -2
self.expected_vcenter = 1
self.expected_vmax = 4

def test_vmin(self):
nt.assert_true(self.norm.vmin is None)
self.norm(self.vals)
nt.assert_equal(self.norm.vmin, self.expected_vmin)

def test_vcenter(self):
nt.assert_true(self.norm.vcenter is None)
self.norm(self.vals)
nt.assert_equal(self.norm.vcenter, self.expected_vcenter)

def test_vmax(self):
nt.assert_true(self.norm.vmax is None)
self.norm(self.vals)
nt.assert_equal(self.norm.vmax, self.expected_vmax)


class test_OffsetNorm_VminEqualsVcenter(BaseOffsetNorm):
def setup(self):
self.normclass = mcolors.OffsetNorm
self.norm = self.normclass(vmin=-2, vcenter=-2, vmax=2)
self.vals = np.array([-2.0, -1.0, 0.0, 1.0, 2.0])
self.expected = np.array([0.5, 0.625, 0.75, 0.875, 1.0])


class test_OffsetNorm_VmaxEqualsVcenter(BaseOffsetNorm):
def setup(self):
self.normclass = mcolors.OffsetNorm
self.norm = self.normclass(vmin=-2, vcenter=2, vmax=2)
self.vals = np.array([-2.0, -1.0, 0.0, 1.0, 2.0])
self.expected = np.array([0.0, 0.125, 0.25, 0.375, 0.5])


class test_OffsetNorm_VsAllEqual(BaseOffsetNorm):
def setup(self):
self.v = 10
self.normclass = mcolors.OffsetNorm
self.norm = self.normclass(vmin=self.v, vcenter=self.v, vmax=self.v)
self.vals = np.array([-2.0, -1.0, 0.0, 1.0, 2.0])
self.expected = np.array([0.0, 0.0, 0.0, 0.0, 0.0])
self.expected_inv = self.expected + self.v

def test_inverse(self):
assert_array_almost_equal(
self.norm.inverse(self.norm(self.vals)),
self.expected_inv
)


class test_OffsetNorm_Errors(object):
def setup(self):
self.vals = np.arange(50)

@nt.raises(ValueError)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

How are these passing on 2.6? I thought the decorator-style raise tests are not available until 2.7... nm, I was confused

def test_VminGTVcenter(self):
norm = mcolors.OffsetNorm(vmin=10, vcenter=0, vmax=20)
norm(self.vals)

@nt.raises(ValueError)
def test_VminGTVmax(self):
norm = mcolors.OffsetNorm(vmin=10, vcenter=0, vmax=5)
norm(self.vals)

@nt.raises(ValueError)
def test_VcenterGTVmax(self):
norm = mcolors.OffsetNorm(vmin=10, vcenter=25, vmax=20)
norm(self.vals)

@nt.raises(ValueError)
def test_premature_scaling(self):
norm = mcolors.OffsetNorm()
norm.inverse(np.array([0.1, 0.5, 0.9]))


@image_comparison(baseline_images=['test_offset_norm'], extensions=['png'])
def test_offset_norm_img():
x = np.linspace(-2, 7)
y = np.linspace(-1*np.pi, np.pi)
X, Y = np.meshgrid(x, y)
Z = x * np.sin(Y)**2

fig, (ax1, ax2) = plt.subplots(ncols=2)
cmap = plt.cm.coolwarm
norm = mcolors.OffsetNorm(vmin=-2, vcenter=0, vmax=7)

img1 = ax1.imshow(Z, cmap=cmap, norm=None)
cbar1 = fig.colorbar(img1, ax=ax1)

img2 = ax2.imshow(Z, cmap=cmap, norm=norm)
cbar2 = fig.colorbar(img2, ax=ax2)

def test_SymLogNorm():
"""
Test SymLogNorm behavior
Expand Down Expand Up @@ -216,7 +416,12 @@ def test_cmap_and_norm_from_levels_and_colors2():
'Wih extend={0!r} and data '
'value={1!r}'.format(extend, d_val))

assert_raises(ValueError, mcolors.from_levels_and_colors, levels, colors)
nt.assert_raises(
ValueError,
mcolors.from_levels_and_colors,
levels,
colors
)


def test_rgb_hsv_round_trip():
Expand Down Expand Up @@ -246,8 +451,8 @@ def gray_from_float_rgb():
def gray_from_float_rgba():
return mcolors.colorConverter.to_rgba(0.4)

assert_raises(ValueError, gray_from_float_rgb)
assert_raises(ValueError, gray_from_float_rgba)
nt.assert_raises(ValueError, gray_from_float_rgb)
nt.assert_raises(ValueError, gray_from_float_rgba)


@image_comparison(baseline_images=['light_source_shading_topo'],
Expand Down

Back | FazBrowse Home | New Git URL