66
77def motion_correction_suite2p (ops , db ):
88 """Performs motion correction (i.e. registration) using the Suite2p package.
9-
109 Args:
1110 ops (dict): ops dictionary can be obtained by using `suite2p.default_ops()`
1211 function. It contains all options and default values used
1312 to perform preprocessing. ops['do_registration'] should be
1413 set to 1.
1514 db (dict): dictionary that includes paths pointing towards the input
1615 data, and path to store outputs
17-
1816 Returns:
1917 motion_correction_ops (dict): Returns a dictionary that includes x and y shifts.
2018 A subset of the ops dictionary returned from `suite2p.run_s2p()` that is required for the segmentation step.
@@ -79,7 +77,6 @@ def motion_correction_suite2p(ops, db):
7977
8078def segmentation_suite2p (motion_correction_ops , db ):
8179 """Performs cell segmentation (i.e. roi detection) using Suite2p package.
82-
8380 Args:
8481 motion_correction_ops (dict): options dictionary. Requirements:
8582 - x and y shifts
@@ -89,7 +86,6 @@ def segmentation_suite2p(motion_correction_ops, db):
8986 - spikedetect=False
9087 db (dict): dictionary that includes paths pointing towards the input
9188 data, and path to store outputs
92-
9389 Returns:
9490 segmentation_ops (dict): A subset of the ops dictionary returned from `suite2p.run_s2p()` that is required for the deconvolution step.
9591 data.bin: Binary file if the one created during motion correction is deleted. If delete_bin=True, the binary file is deleted after processing.
@@ -141,7 +137,6 @@ def deconvolution_suite2p(segmentation_ops, db):
141137 """Performs deconvolution using the Suite2p package for single plane tiff files.
142138 The code to run deconvolution separately can be found here
143139 </https://suite2p.readthedocs.io/en/latest/deconvolution.html>.
144-
145140 Args:
146141 segmentation_ops (dict): options dictionary. Requirements:
147142 - baseline - setting that describes how to compute the baseline of each trace
@@ -156,7 +151,6 @@ def deconvolution_suite2p(segmentation_ops, db):
156151 - two_step_registration=False
157152 - roidetect=False
158153 - spikedetect=True
159-
160154 Returns:
161155 spks.npy: Updates the file with an array of deconvolved traces
162156 """
0 commit comments