photon_mosaic.s2p_options#

Functions

get_edited_options(input_path, save_folder)

This function generates a dictionary of options for Suite2P by loading the default options and then modifying them with user-provided options.
photon_mosaic.s2p_options.get_edited_options(input_path, save_folder, user_ops_dict=None)[source]#

This function generates a dictionary of options for Suite2P by loading the default options and then modifying them with user-provided options. The function also sets the required runtime paths for saving the results.

Parameters:

  • input_path (Path) – The path to the input data folder.

  • save_folder (Path) – The path to the folder where the results will be saved.

  • user_ops_dict (dict, optional) – A dictionary containing user-provided options to override the default options. The default is None.

Returns:

A dictionary containing the Suite2P options, including the user-provided options and the required runtime paths.

Return type:

dict

Raises:

ValueError – If a user-provided option is not valid for Suite2P.

On this page