From bf2184ca89f2cd5f58c3cb738351c7f3ce490b11 Mon Sep 17 00:00:00 2001 From: Stephanie Ribet Date: Sun, 1 Sep 2024 16:25:29 -0700 Subject: [PATCH] some doc strings. something is not correct with initializing positions --- py4DSTEM/tomography/tomography.py | 36 ++++++++++++++++++++++++++++--- 1 file changed, 33 insertions(+), 3 deletions(-) diff --git a/py4DSTEM/tomography/tomography.py b/py4DSTEM/tomography/tomography.py index a100a0fb6..6ded10784 100644 --- a/py4DSTEM/tomography/tomography.py +++ b/py4DSTEM/tomography/tomography.py @@ -48,7 +48,10 @@ def __init__( clear_fft_cache: bool = True, name: str = "tomography", ): - """ """ + """ + Nanobeam tomography! + + """ self._datacubes = datacubes self._import_kwargs = import_kwargs @@ -232,7 +235,26 @@ def reconstruct( progress_bar: bool = True, zero_edges: bool = True, ): - """ """ + """ + Main loop for reconstruct + + Parameters + ---------- + num_iter: int + Number of iterations + store_iterations: bool + if True, stores number of iterations + reset: bool + if True, resets object + step_size: float + from 0 to 1, step size for update + num_points: int + number of points for bilinear interpolation in real space + progres_bar: bool + if True, shows progress bar + zero_edges: bool + If True, zero edges along y and z + """ device = self._device if reset is True: @@ -1321,7 +1343,15 @@ def _constraints( self, zero_edges: bool, ): - """ """ + """ + Constrains for object + TODO: add constrains and break into multiple functions possibly + + Parameters + ---------- + zero_edges: bool + If True, zero edges along y and z + """ if zero_edges: s = self._object_shape_6D