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

help polish

This commit is contained in:
Philip Eisenlohr 2022-12-05 18:29:03 -05:00
parent c7cb56fc18
commit 7b8fce8db0
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
python/damask/_orientation.py
View File

@ -627,7 +627,7 @@ class Orientation(Rotation,Crystal):
weights : numpy.ndarray, shape (self.shape), optional weights : numpy.ndarray, shape (self.shape), optional
Relative weights of orientations. Relative weights of orientations.
return_cloud : bool, optional return_cloud : bool, optional
Return the set of symmetrically equivalent orientations that was used in averaging. Return the specific (symmetrically equivalent) orientations that were averaged.
Defaults to False. Defaults to False.
Returns Returns
@ -635,7 +635,7 @@ class Orientation(Rotation,Crystal):
average : Orientation average : Orientation
Weighted average of original Orientation field. Weighted average of original Orientation field.
cloud : Orientations, conditional cloud : Orientations, conditional
Set of symmetrically equivalent orientations that were used in averaging. Symmetrically equivalent version of each orientation that were actually used in averaging.
References References
---------- ----------
@ -660,7 +660,7 @@ class Orientation(Rotation,Crystal):
proper: bool = False, proper: bool = False,
return_operators: bool = False) -> np.ndarray: return_operators: bool = False) -> np.ndarray:
""" """
Rotate vector to ensure it falls into (improper or proper) standard stereographic triangle of crystal symmetry. Rotate lab frame vector to ensure it falls into (improper or proper) standard stereographic triangle of crystal symmetry.
Parameters Parameters
---------- ----------
@ -679,7 +679,7 @@ class Orientation(Rotation,Crystal):
------- -------
vector_SST : numpy.ndarray, shape (...,3) vector_SST : numpy.ndarray, shape (...,3)
Rotated vector falling into SST. Rotated vector falling into SST.
operators : numpy.ndarray of int, shape (...), conditional operator : numpy.ndarray of int, shape (...), conditional
Index of symmetrically equivalent orientation that rotated vector to SST. Index of symmetrically equivalent orientation that rotated vector to SST.
""" """
@ -749,12 +749,12 @@ class Orientation(Rotation,Crystal):
in_SST: bool = True, in_SST: bool = True,
proper: bool = False) -> np.ndarray: proper: bool = False) -> np.ndarray:
""" """
Map vector to RGB color within standard stereographic triangle of own symmetry. Map lab frame vector to RGB color within standard stereographic triangle of own symmetry.
Parameters Parameters
---------- ----------
vector : numpy.ndarray, shape (...,3) vector : numpy.ndarray, shape (...,3)
Vector to colorize. Lab frame vector to colorize.
Shape of vector blends with shape of own rotation array. Shape of vector blends with shape of own rotation array.
For example, a rotation array of shape (3,2) and a vector array of shape (2,4) result in (3,2,4) outputs. For example, a rotation array of shape (3,2) and a vector array of shape (2,4) result in (3,2,4) outputs.
in_SST : bool, optional in_SST : bool, optional
@ -771,8 +771,8 @@ class Orientation(Rotation,Crystal):
Examples Examples
-------- --------
Inverse pole figure color of the e_3 direction for a crystal Inverse pole figure color of the e_3 lab direction for a
in "Cube" orientation with cubic symmetry: crystal in "Cube" orientation with cubic symmetry:
>>> import damask >>> import damask
>>> o = damask.Orientation(family='cubic') >>> o = damask.Orientation(family='cubic')
@ -783,9 +783,10 @@ class Orientation(Rotation,Crystal):
>>> import damask >>> import damask
>>> from matplotlib import pyplot as plt >>> from matplotlib import pyplot as plt
>>> lab = [0,0,1]
>>> o = damask.Orientation.from_random(shape=500000,family='hexagonal') >>> o = damask.Orientation.from_random(shape=500000,family='hexagonal')
>>> coord = damask.util.project_equal_area(o.to_SST([0,0,1])) >>> coord = damask.util.project_equal_area(o.to_SST(lab))
>>> color = o.IPF_color([0,0,1]) >>> color = o.IPF_color(lab)
>>> plt.scatter(coord[:,0],coord[:,1],color=color,s=.06) >>> plt.scatter(coord[:,0],coord[:,1],color=color,s=.06)
>>> plt.axis('scaled') >>> plt.axis('scaled')
>>> plt.show() >>> plt.show()