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

Skip to content

2D Normalization & Colormapping for ScalerMappables #8738

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.

Sign up for GitHub

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
patniharshit wants to merge 35 commits into from
Closed

2D Normalization & Colormapping for ScalerMappables #8738

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
201dc2a
Initailize class 2D norm
patniharshit Jun 9, 2017
7217536
Change name of class to BivariateNorm, take normalizer instances sepa…
patniharshit Jun 9, 2017
0178730
Bivariate works with imshow, pcolor, pcolormesh, pcolorfast
patniharshit Jul 3, 2017
575a244
add blank line between bivariate classes
patniharshit Jul 9, 2017
8425637
Add support for bivariate in scatter
patniharshit Jul 9, 2017
4a5831d
Fix missing norm2 in BivaraiteNorm
patniharshit Jul 11, 2017
85df736
Fixed bug in if condition bivariate mapping
patniharshit Jul 12, 2017
8e1bc63
Add autoscale, autoscale_None, scaled methods for BivariateNorm
patniharshit Jul 13, 2017
a9aace3
trying to show ticks and labels on both x and y axis
patniharshit Jul 16, 2017
55a7a68
commented outline code, changed gridspace to show sqaure colorbar
patniharshit Jul 17, 2017
c2eb617
2d colorbar printing now
patniharshit Jul 17, 2017
daef751
Add code for Colorsquare
patniharshit Jul 22, 2017
96af3d3
Modify axis aspect and fraction for colorsquare
patniharshit Jul 22, 2017
9285372
fix failing commits
patniharshit Jul 22, 2017
01b5932
Change PEP8 violations
patniharshit Jul 27, 2017
28288e2
Revert isBivari, remove classic locator
patniharshit Jul 29, 2017
ca2b111
Subclass normalizers from Abstract Base Class
patniharshit Aug 2, 2017
75b4eba
move _ticker function inside update_ticks
patniharshit Aug 2, 2017
bf65847
move _ticker function inside update_ticks
patniharshit Aug 2, 2017
f9dc4b1
remove cmap in imshow and pcolorfast
patniharshit Aug 5, 2017
8a985f0
Defer call to norm and cmap in imshow
patniharshit Aug 7, 2017
8f6928d
Fix bivariate handling with pcolormesh
patniharshit Aug 15, 2017
d54cb44
Make pcolor work with bivariate
patniharshit Aug 16, 2017
4d03552
Do 2D->1D mapping in call method of colormap
patniharshit Aug 20, 2017
2573610
Use list comprehensions to ravel
patniharshit Aug 20, 2017
9228480
Reflect on reviews
patniharshit Aug 21, 2017
5c8dc65
Update docstrings
patniharshit Aug 25, 2017
21ea65f
Add bivariate example
patniharshit Aug 25, 2017
b8d43a9
Treat one as slightly less than one
patniharshit Aug 25, 2017
7681d14
Change conditions for bivar
patniharshit Aug 25, 2017
59f56af
Add image comparison test for bivariate
patniharshit Aug 25, 2017
f98978f
Update is_bivar condition to expect either BivariateNorm or Bivariate…
patniharshit Aug 26, 2017
75a289f
Add line continuation in docstrings
patniharshit Aug 27, 2017
7803974
Debug doc build fail
patniharshit Aug 28, 2017
e40c87b
Add missing symbols in docs
patniharshit Aug 28, 2017
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
Prev Previous commit
Next Next commit
Subclass normalizers from Abstract Base Class
  • Loading branch information
@patniharshit
patniharshit committed Aug 27, 2017
commit ca2b111084e35439c42b8d2c4e2934378085b513
10 changes: 4 additions & 6 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5146,8 +5146,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
if not self._hold:
self.cla()

isNorm = isinstance(norm, (mcolors.Normalize, mcolors.BivariateNorm))
if norm is not None and not isNorm:
if norm is not None and not isinstance(norm, mcolors.Norms):
msg = "'norm' must be an instance of 'mcolors.Normalize' " \
"or 'mcolors.BivariateNorm'"
Copy link
Copy Markdown
Member

@story645 story645 Jul 24, 2017

Choose a reason for hiding this comment

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

shouldn't BivariateNorm subclass Normalize? 'specially since now it's normalizing down to a 1d space?

Copy link
Copy Markdown
Contributor Author

@patniharshit patniharshit Jul 27, 2017

Choose a reason for hiding this comment

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

BivariateNorm does not inherit anything from Normalize so I thought it should not subclass it.

Copy link
Copy Markdown
Member

@story645 story645 Jul 27, 2017

Choose a reason for hiding this comment

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

With the new design, BivariateNorm should havel all the same classes as Normalize...and I think subclassing it so it's registered generically as a Norm is preferable to having to treat it as a special case when it doesn't need to be.

Copy link
Copy Markdown
Member

@tacaswell tacaswell Jul 27, 2017

Choose a reason for hiding this comment

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

This can be done with an ABC https://docs.python.org/3/library/abc.html#abc.ABCMeta.register which both Normalize and BivariateNorm register with.

Copy link
Copy Markdown
Member

@story645 story645 Jul 27, 2017

Choose a reason for hiding this comment

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

Sure, but I don't see a reason why BivariateNorm shouldn't be subclassing Norm as it has the same architecture as any other norm...take data (scaler or vector)->map to 1D lut value ->get color, and color ->lut->scaler/vector.

Copy link
Copy Markdown
Member

@tacaswell tacaswell Jul 27, 2017

Choose a reason for hiding this comment

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

If the code paths are completely different, why force the sub-class? In general, sub-classing is only worth it when you can share significant amounts of implementation details, otherwise duck-typing is better.

Copy link
Copy Markdown
Member

@story645 story645 Jul 28, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

My point is mostly that the code paths shouldn't end up being all that different and more to the point in mpl land there's probably a ton of code that checks if things are norms and if this code works in those instances it doesn't make sense to change all that code to cover both cases when this is still fundamentally a norm. But I think I'm on the same page as you on the solution maybe being a "Norm" metaclass.

raise ValueError(msg)
Expand Down Expand Up @@ -5483,8 +5482,7 @@ def pcolor(self, *args, **kwargs):
collection.set_alpha(alpha)
collection.set_array(C)

isNorm = isinstance(norm, (mcolors.Normalize, mcolors.BivariateNorm))
if norm is not None and not isNorm:
if norm is not None and not isinstance(norm, mcolors.Norms):
msg = "'norm' must be an instance of 'mcolors.Normalize' " \
Copy link
Copy Markdown
Member

@tacaswell tacaswell Aug 20, 2017

Choose a reason for hiding this comment

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

We have a style preference for using () for continuation rather than \ so

msg = ('...' +
       '...')

Copy link
Copy Markdown
Contributor

@anntzer anntzer Aug 20, 2017

Choose a reason for hiding this comment

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

The + is not needed.

Copy link
Copy Markdown
Contributor Author

@patniharshit patniharshit Aug 21, 2017

Choose a reason for hiding this comment

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

Done.

"or 'mcolors.BivariateNorm'"
raise ValueError(msg)
Expand Down Expand Up @@ -5764,8 +5762,8 @@ def pcolorfast(self, *args, **kwargs):
cmap = kwargs.pop('cmap', None)
vmin = kwargs.pop('vmin', None)
vmax = kwargs.pop('vmax', None)
isNorm = isinstance(norm, (mcolors.Normalize, mcolors.BivariateNorm))
if norm is not None and not isNorm:

if norm is not None and not isinstance(norm, mcolors.Norms):
msg = "'norm' must be an instance of 'mcolors.Normalize' " \
"or 'mcolors.BivariateNorm'"
raise ValueError(msg)
Expand Down
13 changes: 10 additions & 3 deletions lib/matplotlib/colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
import numpy as np
import matplotlib.cbook as cbook
from ._color_data import BASE_COLORS, TABLEAU_COLORS, CSS4_COLORS, XKCD_COLORS

from abc import ABCMeta

class _ColorMapping(dict):
def __init__(self, mapping):
Expand Down Expand Up @@ -885,7 +885,14 @@ def reversed(self, name=None):
raise NotImplementedError()
Copy link
Copy Markdown
Contributor

@anntzer anntzer Aug 20, 2017

Choose a reason for hiding this comment

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

No need for the parentheses.

Copy link
Copy Markdown
Contributor Author

@patniharshit patniharshit Aug 21, 2017

Choose a reason for hiding this comment

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

Done.



class Normalize(object):
class Norms:
"""
Abstract Base Class to group `Normalize` and `BivariateNorm`
"""
__metaclass__ = ABCMeta
Copy link
Copy Markdown
Contributor

@anntzer anntzer Aug 20, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

definitely wrong on Py3
use six
should have been caught by pycodestyle perhaps?

Copy link
Copy Markdown
Contributor Author

@patniharshit patniharshit Aug 21, 2017

Choose a reason for hiding this comment

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

Fixed now.

pass

class Normalize(Norms):
"""
A class which, when called, can normalize data into
the ``[0.0, 1.0]`` interval.
Expand Down Expand Up @@ -1377,7 +1384,7 @@ def inverse(self, value):
return value


class BivariateNorm:
class BivariateNorm(Norms):
"""
Normalize a list of two values corresponding to two 1D normalizers
"""
Expand Down
12 changes: 12 additions & 0 deletions lib/matplotlib/tests/test_colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -707,3 +707,15 @@ def __add__(self, other):
mcolors.SymLogNorm(3, vmax=5, linscale=1),
mcolors.PowerNorm(1)]:
assert_array_equal(norm(data.view(MyArray)), norm(data))


@pytest.mark.parametrize('norm', [
mcolors.Normalize(), mcolors.LogNorm(), mcolors.BivariateNorm()
]
)
def test_abstract_base_class_norms(norm):
"""
Test that all types of normalizers subclasses Abstract Base class
`colors.Norms`
"""
assert isinstance(norm, mcolors.Norms)