neuralib.suite2p.core.read_suite2p
- neuralib.suite2p.core.read_suite2p(directory, *, cell_prob_thres=0.5, red_cell_threshold=0.65, channel=0, runtime_check_frame_rate=30.0)[source]
Load suite2p result from directory
- Parameters:
directory (str | Path | PathLike[str]) – Directory contain all the s2p output files. e.g., */suite2p/plane[P]
cell_prob_thres (float | None) – Cell probability. If float type, mask for the value in
iscell[:, 1]. If None, use the binary criteria in GUI outputred_cell_threshold (float) – Red cell threshold
channel (int) – channel (PMT) Number for the functional channel. i.e., 0 if GCaMP, 1 if jRGECO in scanbox setting
runtime_check_frame_rate (float | None) – if not None, check frame rate lower-bound to make sure the s2p runconfig
- Returns:
- Return type: