documented return type for from_fiber/spherical_component

This commit is contained in:
Philip Eisenlohr 2022-03-14 16:32:52 -04:00
parent 378b8b2396
commit 4f09bbc715
1 changed files with 10 additions and 0 deletions

View File

@ -1091,6 +1091,11 @@ class Rotation:
A seed to initialize the BitGenerator.
Defaults to None, i.e. unpredictable entropy will be pulled from the OS.
Returns
-------
samples : damask.Rotation
Array of rotations sampled from the spherical component.
"""
rng = np.random.default_rng(rng_seed)
sigma = np.radians(sigma) if degrees else sigma
@ -1132,6 +1137,11 @@ class Rotation:
A seed to initialize the BitGenerator.
Defaults to None, i.e. unpredictable entropy will be pulled from the OS.
Returns
-------
samples : damask.Rotation
Array of rotations sampled from the fiber component.
"""
rng = np.random.default_rng(rng_seed)
sigma_,alpha_,beta_ = (np.radians(coordinate) for coordinate in (sigma,alpha,beta)) if degrees else \