Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Implemented two helper functions lighter and darker which shade colors. #15596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 102 additions & 14 deletions lib/matplotlib/colors.py
Original file line number Diff line number Diff line change
Expand Up @@ -215,9 +215,9 @@ def _to_rgba_no_colorcycle(c, alpha=None):
if len(orig_c) == 1:
cbook.warn_deprecated(
"3.1", message="Support for uppercase "
"single-letter colors is deprecated since Matplotlib "
"%(since)s and will be removed %(removal)s; please "
"use lowercase instead.")
"single-letter colors is deprecated since Matplotlib "
"%(since)s and will be removed %(removal)s; please "
Copy link
Member

Choose a reason for hiding this comment

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

You seem tk have reformatted a lot of non relevant code.

"use lowercase instead.")
if isinstance(c, str):
# hex color in #rrggbb format.
match = re.match(r"\A#[a-fA-F0-9]{6}\Z", c)
Expand All @@ -229,7 +229,7 @@ def _to_rgba_no_colorcycle(c, alpha=None):
match = re.match(r"\A#[a-fA-F0-9]{3}\Z", c)
if match:
return (tuple(int(n, 16) / 255
for n in [c[1]*2, c[2]*2, c[3]*2])
for n in [c[1] * 2, c[2] * 2, c[3] * 2])
+ (alpha if alpha is not None else 1.,))
# hex color with alpha in #rrggbbaa format.
match = re.match(r"\A#[a-fA-F0-9]{8}\Z", c)
Expand All @@ -243,7 +243,7 @@ def _to_rgba_no_colorcycle(c, alpha=None):
match = re.match(r"\A#[a-fA-F0-9]{4}\Z", c)
if match:
color = [int(n, 16) / 255
for n in [c[1]*2, c[2]*2, c[3]*2, c[4]*2]]
for n in [c[1] * 2, c[2] * 2, c[3] * 2, c[4] * 2]]
if alpha is not None:
color[-1] = alpha
return tuple(color)
Expand Down Expand Up @@ -330,8 +330,8 @@ def to_rgba_array(c, alpha=None):
"'rgb'. Note also that the latter is deprecated." % c)
else:
cbook.warn_deprecated("3.2", message="Using a string of single "
"character colors as a color sequence is "
"deprecated. Use an explicit list instead.")
"character colors as a color sequence is "
"deprecated. Use an explicit list instead.")
return result

if len(c) == 0:
Expand Down Expand Up @@ -503,6 +503,7 @@ class Colormap:
``data->normalize->map-to-color`` processing chain.

"""

def __init__(self, name, N=256):
"""
Parameters
Expand Down Expand Up @@ -876,6 +877,7 @@ class ListedColormap(Colormap):

the list will be extended by repetition.
"""

def __init__(self, colors, name='from_list', N=None):
self.monochrome = False # Are all colors identical? (for contour.py)
if N is None:
Expand Down Expand Up @@ -941,6 +943,7 @@ class Normalize:
the ``[0.0, 1.0]`` interval.

"""

def __init__(self, vmin=None, vmax=None, clip=False):
"""
If *vmin* or *vmax* is not given, they are initialized from the
Expand Down Expand Up @@ -1012,7 +1015,7 @@ def __call__(self, value, clip=None):
(vmin,), _ = self.process_value(self.vmin)
(vmax,), _ = self.process_value(self.vmax)
if vmin == vmax:
result.fill(0) # Or should it be all masked? Or 0.5?
result.fill(0) # Or should it be all masked? Or 0.5?
elif vmin > vmax:
raise ValueError("minvalue must be less than or equal to maxvalue")
else:
Expand Down Expand Up @@ -1209,7 +1212,8 @@ class SymLogNorm(Normalize):
*linthresh* allows the user to specify the size of this range
(-*linthresh*, *linthresh*).
"""
def __init__(self, linthresh, linscale=1.0,

def __init__(self, linthresh, linscale=1.0,
vmin=None, vmax=None, clip=False):
"""
*linthresh*:
Expand Down Expand Up @@ -1307,6 +1311,7 @@ class PowerNorm(Normalize):
Linearly map a given value to the 0-1 range and then apply
a power-law normalization over that range.
"""

def __init__(self, gamma, vmin=None, vmax=None, clip=False):
Normalize.__init__(self, vmin, vmax, clip)
self.gamma = gamma
Expand Down Expand Up @@ -1364,6 +1369,7 @@ class BoundaryNorm(Normalize):
interpolation, but using integers seems simpler, and reduces the number of
conversions back and forth between integer and floating point.
"""

def __init__(self, boundaries, ncolors, clip=False):
"""
Parameters
Expand Down Expand Up @@ -1442,6 +1448,7 @@ class NoNorm(Normalize):
Dummy replacement for `Normalize`, for the case where we want to use
indices directly in a `~matplotlib.cm.ScalarMappable`.
"""

def __call__(self, value, clip=None):
return value

Expand Down Expand Up @@ -1608,6 +1615,7 @@ class LightSource:
The :meth:`shade_rgb`
The :meth:`hillshade` produces an illumination map of a surface.
"""

def __init__(self, azdeg=315, altdeg=45, hsv_min_val=0, hsv_max_val=1,
hsv_min_sat=1, hsv_max_sat=0):
"""
Expand Down Expand Up @@ -1878,10 +1886,10 @@ def shade_rgb(self, rgb, elevation, fraction=1., blend_mode='hsv',

# Blend the hillshade and rgb data using the specified mode
lookup = {
'hsv': self.blend_hsv,
'soft': self.blend_soft_light,
'overlay': self.blend_overlay,
}
'hsv': self.blend_hsv,
'soft': self.blend_soft_light,
'overlay': self.blend_overlay,
}
if blend_mode in lookup:
blend = lookup[blend_mode](rgb, intensity, **kwargs)
else:
Expand Down Expand Up @@ -1988,7 +1996,7 @@ def blend_soft_light(self, rgb, intensity):
rgb : ndarray
An MxNx3 RGB array representing the combined images.
"""
return 2 * intensity * rgb + (1 - 2 * intensity) * rgb**2
return 2 * intensity * rgb + (1 - 2 * intensity) * rgb ** 2

def blend_overlay(self, rgb, intensity):
"""
Expand Down Expand Up @@ -2066,3 +2074,83 @@ def from_levels_and_colors(levels, colors, extend='neither'):

norm = BoundaryNorm(levels, ncolors=n_data_colors)
return cmap, norm


def darker(color, factor):
"""
Copy link
Member

Choose a reason for hiding this comment

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

These don't appear in the rendered docs, that I can see....

Copy link
Member

Choose a reason for hiding this comment

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

A helper routine to to generate a darker shade of color.

Parameters
----------
color : color or color sequence
The colors to convert.
factor : float
any value above 1 means darkening the color,
any value in [0,1] means brightening the color

Returns
-------
result : (..., 3) ndarray
Colors converted to RGB values in range [0, 1]

Notes
-----
The algorithm is inspired by Qt ``QColor.darker()``.
"""
if factor <= 0:
raise ValueError("Cannot input value below 0.")
elif factor < 1:
return lighter(color, 1 / factor)
color = to_rgb(color)
hsv = rgb_to_hsv(color)
hsv[:][2] = hsv[:][2] / factor

return hsv_to_rgb(hsv)


def lighter(color, factor):
"""
A helper routine to to generate a lighter shade of color inspired by PyQt.

Parameters
----------
color : color or color sequence
The colors to convert.
factor : float
any value above 1 means brightening the color,
any value in [0,1] means darkening the color

Copy link
Member

Choose a reason for hiding this comment

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

Please explain exactly what factor does. Otherwise it’s hard to guess what values to use and what they are doing to the color.

Returns
-------
result : (..., 3) ndarray
Colors converted to RGB values in range [0, 1]
"""

if factor <= 0:
raise ValueError("Cannot input value below 0.")
elif factor < 1:
return darker(color, 1 / factor)
color = to_rgb(color)
hsv = rgb_to_hsv(color)
is_scalar = hsv.ndim <= 1
h, s, v = np.atleast_2d(hsv).T
s = s * 255
v = v * 255

v = (factor * v)

for i in range(len(v)):
if v[i] > 255:
s[i] -= v[i] - 255
if s[i] < 0:
Copy link
Member

Choose a reason for hiding this comment

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

This whole block on v should be vectorized and the redundant conversion from/to 255 removed.

s[i] = 0
v[i] = 255

s = s / 255
v = v / 255

result = hsv_to_rgb(np.array([h, s, v]).T)
result[result > 1] = 1
if is_scalar:
return result[0]
return result
32 changes: 31 additions & 1 deletion lib/matplotlib/tests/test_colors.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import numpy as np
import pytest

from numpy.testing import assert_array_equal, assert_array_almost_equal
from numpy.testing import assert_array_equal, assert_array_almost_equal, assert_allclose

from matplotlib import cycler
import matplotlib
Expand Down Expand Up @@ -848,6 +848,36 @@ def test_to_rgba_array_single_str():
"sequence"):
mcolors.to_rgba_array("rgbx")

@pytest.mark.parametrize("color,factor", [
([1, 0, 0], 1),
([1, 0, 0], 1.1),
([1, 1, 1], 3),
([0.4, 0.3, 0.1], 1.04),
([0.1, 0.1, 0.1], 1.03),
Copy link
Member

Choose a reason for hiding this comment

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

I don’t see that any of these explicitly test the saturation wrapping when value exceeds 1

([1,1,1], 0.5)
])
def test_darker(color, factor):
from PyQt5.QtGui import QColor
Copy link
Member

Choose a reason for hiding this comment

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

You don’t really need this dependency here, so I’d rewrite the test using numbers.

scaled_color = [c * 255 for c in color]
expected = QColor(*scaled_color).darker(factor * 100)
assert_allclose(mcolors.darker(color, factor), [expected.red()/255, expected.green()/255, expected.blue()/255], atol=1/256)

@pytest.mark.parametrize("color,factor", [
([1, 0, 0], 1),
([1, 0, 0], 1.1),
([1, 1, 1], 3),
([0.4, 0.3, 0.1], 1.04),
([1,1,1], 0.5),
("blue", 1.5),
])
def test_lighter(color, factor):
from PyQt5.QtGui import QColor
from matplotlib.colors import to_rgb
color = to_rgb(color)
scaled_color = [c * 255 for c in color]
expected = QColor(*scaled_color).lighter(factor * 100)
assert_allclose(mcolors.lighter(color, factor), [expected.red()/255, expected.green()/255, expected.blue()/255], atol=1/256)


def test_failed_conversions():
with pytest.raises(ValueError):
Expand Down