improved from_ODF documentation

This commit is contained in:
Philip Eisenlohr 2020-09-29 12:55:00 -04:00
parent 31f86c28f4
commit 350f5eb66a
1 changed files with 17 additions and 6 deletions

View File

@ -656,12 +656,7 @@ class Rotation:
@staticmethod @staticmethod
def from_ODF(weights,Eulers,N=500,degrees=True,fractions=True,seed=None): def from_ODF(weights,Eulers,N=500,degrees=True,fractions=True,seed=None):
""" """
Sample discrete orientations from a binned ODF. Sample discrete values from a binned ODF.
References
----------
P. Eisenlohr, F. Roters, Computational Materials Science 42(4), 670-678, 2008
https://doi.org/10.1016/j.commatsci.2007.09.015
Parameters Parameters
---------- ----------
@ -681,6 +676,22 @@ class Rotation:
A seed to initialize the BitGenerator. Defaults to None, i.e. unpredictable entropy A seed to initialize the BitGenerator. Defaults to None, i.e. unpredictable entropy
will be pulled from the OS. will be pulled from the OS.
Returns
-------
samples : damask.Rotation of shape (N)
Array of sampled rotations closely representing the input ODF.
Notes
-----
Due to the distortion of Euler space in the vicinity of ϕ = 0, probability densities, p, defined on
grid points with ϕ = 0 will never result in reconstructed orientations as their dV/V = p dγ = p × 0.
Hence, it is recommended to transform any such dataset to cell centers that avoid grid points at ϕ = 0.
References
----------
P. Eisenlohr, F. Roters, Computational Materials Science 42(4), 670-678, 2008
https://doi.org/10.1016/j.commatsci.2007.09.015
""" """
def _dg(eu,deg): def _dg(eu,deg):
"""Return infinitesimal Euler space volume of bin(s).""" """Return infinitesimal Euler space volume of bin(s)."""