Skip to content

ENH: Added FuncNorm and PiecewiseNorm classes in colors #7294

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

ENH: Added FuncNorm and PiecewiseNorm classes in colors #7294

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
2d90c5a
Added ArbitaryNorm and RootNorm classes in colors, as well as example…
Oct 17, 2016
57aad3d
PEP8 formatting on examples, plotting using the object oriented appro…
Oct 18, 2016
f818aff
Added title/description to the examples
Oct 18, 2016
ffe1b9d
Class attributes are now hidden
Oct 18, 2016
1d22b90
Major update: complete refactorization of code. A much more powerful …
Oct 19, 2016
b5801ea
Corrected lambda function syntax that was not compatible with python …
Oct 19, 2016
e93d82d
Added FuncNorm: now everything inherits from this. Changed the name o…
Oct 20, 2016
3749b0a
Forgot to uncomment an import
Oct 20, 2016
de62491
Improved the auto-tick feature, and corrected some pep8 issues
Oct 20, 2016
d148756
Improved examples, created a new file for generating sample data.'
alvarosg Oct 22, 2016
5373a98
Corrected a double line, and removed a comment
alvarosg Oct 22, 2016
13edeab
Tests for FuncNorm added, and bug corrected in FuncNorm
alvarosg Oct 22, 2016
21d5cd0
Added compatibility for python 3 string check, added tests for Piecew…
alvarosg Oct 22, 2016
d359a4e
Added tests on all classes, including all public methods
alvarosg Oct 22, 2016
4622829
Change type of arrays in tests from int to float
alvarosg Oct 22, 2016
30ff404
Corrected wrong `super()` for RootNorm
alvarosg Oct 22, 2016
df835cb
Solve problem with implicit int to float casting that was not working…
alvarosg Oct 22, 2016
dfaa0f8
Added documentation in the numpydoc format
alvarosg Oct 23, 2016
a386395
Improve style in the examples. Corrected intending problem in the doc…
alvarosg Oct 23, 2016
b9dafb0
Added example in `FuncNorm` docstring
alvarosg Oct 23, 2016
d10be73
Finished with the examples in the docstrings
alvarosg Oct 24, 2016
c85a14c
Implemented clipping behavoir. Refactored _func_parser
alvarosg Oct 26, 2016
7597ddd
It now allows some string functions with parameters. Added a test for…
alvarosg Oct 28, 2016
7fce503
Forgot to add a file...
alvarosg Oct 28, 2016
bcd7dd0
Forgot to add another file...
alvarosg Oct 28, 2016
a71e1e9
Improved tests, documentation, and exceptions
alvarosg Oct 31, 2016
33f57d1
Removed test_colors.py from __init__.py after including parametrize
alvarosg Oct 31, 2016
9687173
Moved the string function parser to its own class in cbook. Added tes…
alvarosg Nov 1, 2016
46395aa
Improved documentation
Nov 2, 2016
63dab61
Added new example
Nov 2, 2016
8abf2c2
Added example for PiecewiseNorm, and MirrorPiecewiseNorm. String in t…
alvarosg Nov 3, 2016
b4ecdb2
Removed sampledata.py no longer necessary, and changed examples in do…
alvarosg Nov 3, 2016
42007ee
Added examples for MirrorRootNorm and RootNorm
alvarosg Nov 3, 2016
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
Solve problem with implicit int to float casting that was not working… 
… for numpy 1.6
  • Loading branch information
@alvarosg
alvarosg committed Oct 23, 2016
commit df835cb38e077c656d2c8ed270869846abbfcc66
8 changes: 6 additions & 2 deletions lib/matplotlib/colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -973,6 +973,10 @@ def __init__(self, f, finv=None,

self._f = f
self._finv = finv
if vmin is not None:
vmin = float(vmin)
if vmax is not None:
vmax = float(vmax)

super(FuncNorm, self).__init__(vmin, vmax, clip)

Expand Down Expand Up @@ -1059,9 +1063,9 @@ def autoscale_None(self, A):
if self.vmin is not None and self.vmax is not None:
return
if self.vmin is None:
self.vmin = np.ma.min(A)
self.vmin = float(np.ma.min(A))
if self.vmax is None:
self.vmax = np.ma.max(A)
self.vmax = float(np.ma.max(A))

@staticmethod
def _round_ticks(ticks, permanenttick):
Expand Down
22 changes: 11 additions & 11 deletions lib/matplotlib/tests/test_colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,20 +158,20 @@ def test_LogNorm():

def test_FuncNorm():
Copy link
Member

Choose a reason for hiding this comment

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

These should probably either be broken into separate tests or parameterized cause if one of the tests fails, it would likely require going back to the source to figure which subcategories failed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess the line of the assert is always shown, but in any case, could you show me an example of parameterized, please?

Copy link
Member

Choose a reason for hiding this comment

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

But assert doesn't spit error messages, so you're kind of left guessing what specific thing that assert was trying to test.
http://doc.pytest.org/en/latest/parametrize.html and test_category.py has lots of mpl examples.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have now included a test class for each of the implemented classes, and each assert in a separate name method. It also includes a parametric test to replace the loop I had before.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

However, the parametric test is not working, for some reason. Do you know, if apart from using the decorator, I have to do anything else? All other tests in the file are single method very basic tests (which is why I did it like that originally)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @QuLogic, it should build now!

# Testing limits using a string
norm = mcolors.FuncNorm(f='log', vmin=0.01, vmax=2)
norm = mcolors.FuncNorm(f='log', vmin=0.01, vmax=2.)
assert_array_equal(norm([0.01, 2]), [0, 1.0])

# Testing limits using a string
norm = mcolors.FuncNorm(f=lambda x: np.log10(x),
finv=lambda x: 10.**(x), vmin=0.01, vmax=2)
finv=lambda x: 10.**(x), vmin=0.01, vmax=2.)
assert_array_equal(norm([0.01, 2]), [0, 1.0])

# Testing limits without vmin, vmax
norm = mcolors.FuncNorm(f='log')
assert_array_equal(norm([0.01, 2]), [0, 1.0])

# Testing limits without vmin
norm = mcolors.FuncNorm(f='log', vmax=2)
norm = mcolors.FuncNorm(f='log', vmax=2.)
assert_array_equal(norm([0.01, 2]), [0, 1.0])

# Testing limits without vmin
Expand All @@ -183,12 +183,12 @@ def test_FuncNorm():
assert_array_almost_equal(norm([0.01, 0.5, 2]), [0, 0.73835195870437, 1.0])

# Checking inverse
norm = mcolors.FuncNorm(f='log', vmin=0.01, vmax=2)
norm = mcolors.FuncNorm(f='log', vmin=0.01, vmax=2.)
x = np.linspace(0.01, 2, 10)
assert_array_almost_equal(x, norm.inverse(norm(x)))

# Checking ticks
norm = mcolors.FuncNorm(f='log', vmin=0.01, vmax=2)
norm = mcolors.FuncNorm(f='log', vmin=0.01, vmax=2.)
expected = [0.01, 0.016, 0.024, 0.04, 0.06,
0.09, 0.14, 0.22, 0.3, 0.5,
0.8, 1.3, 2.]
Expand All @@ -214,28 +214,28 @@ def test_PiecewiseNorm():
norm = mcolors.PiecewiseNorm(flist=['cubic', 'crt', 'cubic', 'crt'],
refpoints_cm=[0.2, 0.5, 0.7],
refpoints_data=[-1, 1, 3],
vmin=-2, vmax=4)
vmin=-2., vmax=4.)
assert_array_equal(norm([-2., -1, 1, 3, 4]), [0., 0.2, 0.5, 0.7, 1.0])

# Testing with vmin
norm = mcolors.PiecewiseNorm(flist=['cubic', 'crt', 'cubic', 'crt'],
refpoints_cm=[0.2, 0.5, 0.7],
refpoints_data=[-1, 1, 3],
vmin=-2)
vmin=-2.)
assert_array_equal(norm([-2., -1, 1, 3, 4]), [0., 0.2, 0.5, 0.7, 1.0])

# Testing with vmax
norm = mcolors.PiecewiseNorm(flist=['cubic', 'crt', 'cubic', 'crt'],
refpoints_cm=[0.2, 0.5, 0.7],
refpoints_data=[-1, 1, 3],
vmax=4)
vmax=4.)
assert_array_equal(norm([-2., -1, 1, 3, 4]), [0., 0.2, 0.5, 0.7, 1.0])

# Testing intermediate values
norm = mcolors.PiecewiseNorm(flist=['cubic', 'crt', 'cubic', 'crt'],
refpoints_cm=[0.2, 0.5, 0.7],
refpoints_data=[-1, 1, 3],
vmin=-2, vmax=4)
vmin=-2., vmax=4.)
expected = [0.38898816,
0.47256809,
0.503125,
Expand All @@ -247,15 +247,15 @@ def test_PiecewiseNorm():
norm = mcolors.PiecewiseNorm(flist=['cubic', 'crt', 'cubic', 'crt'],
refpoints_cm=[0.2, 0.5, 0.7],
refpoints_data=[-1, 1, 3],
vmin=-2, vmax=4)
vmin=-2., vmax=4.)
x = np.linspace(-2, 4, 10)
assert_array_almost_equal(x, norm.inverse(norm(x)))

# Checking ticks
norm = mcolors.PiecewiseNorm(flist=['cubic', 'crt', 'cubic', 'crt'],
refpoints_cm=[0.2, 0.5, 0.7],
refpoints_data=[-1, 1, 3],
vmin=-2, vmax=4)
vmin=-2., vmax=4.)
expected = [-2., -1.3, -1.1, -1., -0.93,
-0.4, 1., 2.4, 2.7, 3.,
3.04, 3.3, 4.]
Expand Down