Skip to content

Commit

Permalink
Update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
YagoMCastro committed Jul 12, 2024
1 parent f75a9da commit a92f140
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions magali/_synthetic.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@ def random_directions(
declination : float
Declination of the preferred direction in degrees.
dispersion_angle : float
Dispersion angle that defines a region on the surface of a sphere.
Dispersion angle that defines a region on the surface of a sphere.
Also corresponds to the variance of the generated directions.
size : int
Number of random directions to be generated.
random_state : numpy.random.RandomState or an int seed
Expand All @@ -47,8 +48,7 @@ def random_directions(
ranging from 0° to 360°, to represent the equal probability for each
value in a stereographic polar projection.
The distance to the pole (\psi) for each vector is obtained with a normal
distribution, in which the maximum distance corresponds to the
variance of the distribution.
distribution.
Given the values of azimuth (\alpha) and distance to the pole (\psi), we
calculate the catesian coordinates
Expand Down

0 comments on commit a92f140

Please sign in to comment.