From c330b545d7cc9788c0f30c965a31fe69cc505941 Mon Sep 17 00:00:00 2001 From: chrisjonesBSU Date: Fri, 13 Oct 2023 12:23:32 -0600 Subject: [PATCH] finish doc strings --- cmeutils/structure.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/cmeutils/structure.py b/cmeutils/structure.py index eddf993..31c9432 100644 --- a/cmeutils/structure.py +++ b/cmeutils/structure.py @@ -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 @@ -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 -------