223031012
/
DAMASK_EICMD
mirror of https://github.com/achalhp/DAMASK_EICMD.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

eq. according to mypy recommendation 

note that raising 'NotImplemented' means that __eq__ of the 'other' is
evaluated
https://stackoverflow.com/questions/54801832
https://newbedev.com/why-does-defining-the-argument-types-for-eq-throw-a-mypy-type-error
This commit is contained in:
Martin Diehl 2021-12-03 12:33:27 +01:00
parent 99166a7ce2
commit 2a6b37a0e5
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
python/damask/_colormap.py
View File

@ -5,7 +5,6 @@ import colorsys
from pathlib import Path from pathlib import Path
from typing import Sequence, Union, TextIO from typing import Sequence, Union, TextIO
import numpy as np import numpy as np
import matplotlib as mpl import matplotlib as mpl
if os.name == 'posix' and 'DISPLAY' not in os.environ: if os.name == 'posix' and 'DISPLAY' not in os.environ:
@ -29,6 +28,10 @@ class Colormap(mpl.colors.ListedColormap):
""" """
Enhance matplotlib colormap functionality to be used within DAMASK. Enhance matplotlib colormap functionality to be used within DAMASK.
Colors are internally stored as R(ed) G(green) B(lue) values.
The colormap can be used in matplotlib, seaborn, etc., and can
exported to file for external use.
References References
---------- ----------
K. Moreland, Proceedings of the 5th International Symposium on Advances in Visual Computing, 2009 K. Moreland, Proceedings of the 5th International Symposium on Advances in Visual Computing, 2009
@ -42,8 +45,10 @@ class Colormap(mpl.colors.ListedColormap):
""" """
def __eq__(self, other) -> bool: def __eq__(self, other: object) -> bool:
"""Test equality of colormaps.""" """Test equality of colormaps."""
if not isinstance(other, Colormap):
return NotImplemented
return len(self.colors) == len(other.colors) \ return len(self.colors) == len(other.colors) \
and bool(np.all(self.colors == other.colors)) and bool(np.all(self.colors == other.colors))
@ -80,10 +85,6 @@ class Colormap(mpl.colors.ListedColormap):
""" """
Create a perceptually uniform colormap between given (inclusive) bounds. Create a perceptually uniform colormap between given (inclusive) bounds.
Colors are internally stored as R(ed) G(green) B(lue) values.
The colormap can be used in matplotlib/seaborn or exported to
file for external use.
Parameters Parameters
---------- ----------
low : iterable of float (3) low : iterable of float (3)
@ -91,7 +92,7 @@ class Colormap(mpl.colors.ListedColormap):
high : iterable of float (3) high : iterable of float (3)
Color definition for maximum value. Color definition for maximum value.
name : str, optional name : str, optional
Name of the colormap. Defaults to `DAMASK colormap`. Name of the colormap. Defaults to 'DAMASK colormap'.
N : int, optional N : int, optional
Number of color quantization levels. Defaults to 256. Number of color quantization levels. Defaults to 256.
model : {'rgb', 'hsv', 'hsl', 'xyz', 'lab', 'msh'} model : {'rgb', 'hsv', 'hsl', 'xyz', 'lab', 'msh'}
@ -242,7 +243,7 @@ class Colormap(mpl.colors.ListedColormap):
---------- ----------
name : str, optional name : str, optional
Name of the reversed colormap. Name of the reversed colormap.
If None, parent colormap name + "_r". Defaults to parent colormap name + '_r'.
Returns Returns
------- -------
@ -261,14 +262,14 @@ class Colormap(mpl.colors.ListedColormap):
def _get_file_handle(self, def _get_file_handle(self,
fname: Union[TextIO, str, Path, None], fname: Union[TextIO, str, Path, None],
dsuffix: str = '') -> TextIO: suffix: str = '') -> TextIO:
""" """
Provide file handle. Provide file handle.
Parameters Parameters
---------- ----------
fname : file, str, pathlib.Path, or None fname : file, str, pathlib.Path, or None
Filename or filehandle. Filename or file handle.
If None, colormap name + suffix. If None, colormap name + suffix.
suffix: str, optional suffix: str, optional
Extension to use for colormap filename. Extension to use for colormap filename.
@ -298,7 +299,7 @@ class Colormap(mpl.colors.ListedColormap):
consist of the name of the colormap with extension '.json'. consist of the name of the colormap with extension '.json'.
""" """
colors: List = [] colors = []
for i,c in enumerate(np.round(self.colors,6).tolist()): for i,c in enumerate(np.round(self.colors,6).tolist()):
colors+=[i]+c colors+=[i]+c