Skip to content

Commit

Permalink
finish doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjonesBSU committed Oct 13, 2023
1 parent 91af6e5 commit c330b54
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions cmeutils/structure.py
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,11 @@ def diffraction_pattern(
):
"""Uses freud's diffraction module to find 2D diffraction patterns.
Notes
-----
The diffraction pattern is averaged over both views and frames
set by the lenght of views and the range start - stop.
Parameters
----------
gsdfile : str, required
Expand All @@ -557,6 +562,10 @@ def diffraction_pattern(
ref_length : float, optional, default None
Set a reference length to convert from reduced units to real units.
If None, uses 1 by default.
grid_size : unsigned int, optional, default 1024
Resolution of the diffraction grid.
output_size : unsigned int, optional, default None
Resolution of the output diffraction image.
Returns
-------
Expand Down

0 comments on commit c330b54

Please sign in to comment.