Skip to content

Commit

Permalink
some doc strings. something is not correct with initializing positions
Browse files Browse the repository at this point in the history
  • Loading branch information
smribet committed Sep 1, 2024
1 parent 3088be2 commit bf2184c
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions py4DSTEM/tomography/tomography.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,10 @@ def __init__(
clear_fft_cache: bool = True,
name: str = "tomography",
):
""" """
"""
Nanobeam tomography!
"""

self._datacubes = datacubes
self._import_kwargs = import_kwargs
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit bf2184c

Please sign in to comment.