photon_mosaic.preprocessing.suite2p_registration#

Classes

RegisterSuite2PImaging(imaging, motion[, method])

Apply pre-computed Suite2P motion correction on-the-fly.

RegisterSuite2PImagingEpoch(...)

Epoch-level preprocessor that applies stored Suite2P displacements.

Suite2PMotion(imaging, displacements, ops[, ...])

Motion artifacts produced by Suite2P registration.

Suite2pRegistrationSettings([...])

Settings for Suite2P motion correction.

class photon_mosaic.preprocessing.suite2p_registration.Suite2pRegistrationSettings(_case_sensitive=None, _nested_model_default_partial_update=None, _env_prefix=None, _env_prefix_target=None, _env_file=PosixPath('.'), _env_file_encoding=None, _env_file_depth=None, _env_ignore_empty=None, _env_nested_delimiter=None, _env_nested_max_split=None, _env_parse_none_str=None, _env_parse_enums=None, _cli_prog_name=None, _cli_parse_args=None, _cli_settings_source=None, _cli_parse_none_str=None, _cli_hide_none_type=None, _cli_avoid_json=None, _cli_enforce_required=None, _cli_use_class_docs_for_groups=None, _cli_show_env_vars=None, _cli_exit_on_error=None, _cli_prefix=None, _cli_flag_prefix_char=None, _cli_implicit_flags=None, _cli_ignore_unknown_args=None, _cli_kebab_case=None, _cli_shortcuts=None, _secrets_dir=None, _build_sources=None, *, debug=False, tmp_dir=PosixPath('/scratch'), batch_size=500, device='cpu', nonrigid=True, max_nonrigid_shift=5, bounds=None, data_type='h5', do_registration=True, align_by_chan=1, maxregshift=0.1, force_refImg=True, block_size=<factory>, snr_thresh=1.2, outlier_detrend_window=3.0, outlier_maxregshift=0.05, clip_negative=False, max_reference_iterations=8, auto_remove_empty_frames=True, trim_frames_start=0, trim_frames_end=0, do_optimize_motion_params=False, smooth_sigma_time=0, smooth_sigma=1.15, use_ave_image_as_reference=False, movie_lower_quantile=0.1, movie_upper_quantile=0.999, preview_frame_bin_seconds=2.0, preview_playback_factor=10.0, n_batches=20, smooth_sigma_min=0.65, smooth_sigma_max=2.15, smooth_sigma_steps=4, smooth_sigma_time_min=0, smooth_sigma_time_max=6, smooth_sigma_time_steps=7)[source]#

Settings for Suite2P motion correction.

Adds the Suite2P specific parameters on top of the shared photon_mosaic.preprocessing.registration.RegistrationSettings (debug, tmp_dir, batch_size, device). Values can be provided via constructor, environment variables, or .env file.

data_type: str#
do_registration: bool#
align_by_chan: int#
maxregshift: float#
force_refImg: bool#
block_size: list#
snr_thresh: float#
outlier_detrend_window: float#
outlier_maxregshift: float#
clip_negative: bool#
max_reference_iterations: int#
auto_remove_empty_frames: bool#
trim_frames_start: int#
trim_frames_end: int#
do_optimize_motion_params: bool#
smooth_sigma_time: int#
smooth_sigma: float#
use_ave_image_as_reference: bool#
movie_lower_quantile: float#
movie_upper_quantile: float#
preview_frame_bin_seconds: float#
preview_playback_factor: float#
n_batches: int#
smooth_sigma_min: float#
smooth_sigma_max: float#
smooth_sigma_steps: int#
smooth_sigma_time_min: float#
smooth_sigma_time_max: float#
smooth_sigma_time_steps: int#
model_config = {'arbitrary_types_allowed': True, 'case_sensitive': False, 'cli_avoid_json': False, 'cli_enforce_required': False, 'cli_exit_on_error': True, 'cli_flag_prefix_char': '-', 'cli_hide_none_type': False, 'cli_ignore_unknown_args': False, 'cli_implicit_flags': False, 'cli_kebab_case': False, 'cli_parse_args': None, 'cli_parse_none_str': None, 'cli_prefix': '', 'cli_prog_name': None, 'cli_shortcuts': None, 'cli_show_env_vars': False, 'cli_use_class_docs_for_groups': False, 'enable_decoding': True, 'env_file': '.env', 'env_file_depth': 0, 'env_file_encoding': None, 'env_ignore_empty': False, 'env_nested_delimiter': None, 'env_nested_max_split': None, 'env_parse_enums': None, 'env_parse_none_str': None, 'env_prefix': 'SUITE2P_REGISTRATION_', 'env_prefix_target': 'variable', 'extra': 'forbid', 'json_file': None, 'json_file_encoding': None, 'nested_model_default_partial_update': False, 'protected_namespaces': ('model_validate', 'model_dump', 'settings_cached', 'settings_clear_cache', 'settings_customise_sources'), 'secrets_case_sensitive': None, 'secrets_dir': None, 'secrets_dir_max_size': None, 'secrets_dir_missing': None, 'secrets_nested_delimiter': None, 'secrets_nested_subdir': None, 'secrets_prefix': None, 'toml_file': None, 'validate_default': True, 'yaml_config_section': None, 'yaml_file': None, 'yaml_file_encoding': None}#

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class photon_mosaic.preprocessing.suite2p_registration.Suite2PMotion(imaging, displacements, ops, reference=None, nonrigid_offsets=None, blocks=None, yranges=None, xranges=None, corrected_badframes=None, metadata=None)[source]#

Motion artifacts produced by Suite2P registration.

Adds Suite2P-specific fields (ops, block coordinates, non-rigid offsets) on top of the algorithm-agnostic Motion container.

Methods

method_name: str | None = 'suite2p'#
settings_class#

alias of Suite2pRegistrationSettings

class photon_mosaic.preprocessing.suite2p_registration.RegisterSuite2PImaging(imaging, motion, method='suite2p', **kwargs)[source]#

Apply pre-computed Suite2P motion correction on-the-fly.

Thin alias of photon_mosaic.preprocessing.registration.RegisterImaging, kept for discoverability and backwards compatibility; the generic class already dispatches on method.

class photon_mosaic.preprocessing.suite2p_registration.RegisterSuite2PImagingEpoch(parent_imaging_epoch, motion, epoch_index, **kwargs)[source]#

Epoch-level preprocessor that applies stored Suite2P displacements.

Frame bounds, plane selection and output allocation come from RegisterImagingEpoch; this class only shifts one plane’s frames with Suite2P’s shift_frames.

motion: Suite2PMotion#