Skip to content

Commit 6a3e997

Browse files
committed
edit docstring
1 parent 5d1219f commit 6a3e997

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

src/aspire/source/relion.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ def __init__(
4343
:param data_folder: Path to folder w.r.t which all relative paths to .mrcs files are resolved.
4444
If None, the folder corresponding to filepath is used.
4545
:param pixel_size: The pixel size of the images in angstroms. By default, pixel size is
46-
populated from the STAR file if relevant metadata fields exist.
46+
populated from the STAR file if relevant metadata fields exist. If not found in metadata,
47+
pixel_size must be provided.
4748
:param B: the envelope decay of the CTF in inverse square angstrom (Default 0)
4849
:param n_workers: Number of threads to spawn to read referenced .mrcs files (Default -1 to auto detect)
4950
:param max_rows: Maximum number of rows in STAR file to read. If None, all rows are read.

0 commit comments

Comments
 (0)