smlmlp.Config module

class smlmlp.Config(*tif_paths, config=None, locs=None, **kwargs)[source]

Bases: object

Store configuration values in an object that can be saved and loaded.

Parameters:
  • *tif_paths – TIFF paths used to initialize frame and camera dimensions.

  • config (Config, dict, path-like, or None, default=None) – Existing configuration source.

  • locs (Locs or None, default=None) – Optional localization container used for data-dependent defaults.

  • **kwargs – Configuration metadata values to assign.

cameras

Camera metadata containers.

Type:

list[Camera]

locs

Optional localization container.

Type:

Locs or None

Examples

>>> from smlmlp import Config
>>> instance = Config()
property FOV_max_um

Return FOV max um.

property aim_frames_per_segment

Return getter.

property aim_kde_bandwidth_nm

Return getter.

property aim_lambda_smooth

Return getter.

property aim_learning_rate

Return getter.

property aim_max_iter

Return getter.

property aim_outlier_fraction

Return getter.

property aim_recompute

Return getter.

property aim_tol

Return getter.

property azimuth_method

Return getter.

property biplane_x_channels

Return getter.

property biplane_y_channels

Return getter.

Return getter.

Return getter.

property cameras_QE

Return getter.

property cameras_bboxes

Return camera property.

property cameras_bits

Return getter.

property cameras_camera_indices

Return camera property.

property cameras_constructor_gains

Return getter.

property cameras_experimental_gains

Return getter.

property cameras_gains

Return camera property.

property cameras_nchannels

Return getter.

property cameras_npixels

Return getter.

property cameras_pixels_nm

Return getter.

property cameras_read_noises

Return getter.

property channel_association_radius_nm

Return getter.

property channels

Return channels.

property channels_QE

Return channel property.

property channels_bboxes

Return channel property.

property channels_bits

Return channel property.

property channels_camera_indices

Return channel property.

property channels_channel_indices

Return channel property.

property channels_constructor_gains

Return channel property.

property channels_crops_pix

Return channel property.

property channels_default_crops_nm

Return channel property.

property channels_experimental_gains

Return channel property.

property channels_fit_inits

Return channel property.

property channels_fit_models

Return getter.

property channels_fit_thetas

Return getter.

property channels_flips

Return getter.

property channels_gains

Return channel property.

property channels_image_transform_matrices

Return channel property.

property channels_locs_transform_matrices

Return channel property.

property channels_nchannels

Return channel property.

property channels_npixels

Return channel property.

property channels_pixels_nm

Return channel property.

property channels_psf_3d_spline_coeffs

Return getter.

property channels_psf_3d_xtangents

Return getter.

property channels_psf_3d_ytangents

Return getter.

property channels_psf_3d_ztangents

Return getter.

property channels_psf_diameters_nm

Return channel property.

property channels_psf_fwhms_nm

Return channel property.

property channels_psf_kernels

Return channel property.

property channels_psf_radii_nm

Return channel property.

property channels_psf_sigmas_nm

Return channel property.

property channels_psf_spline_coeffs

Return getter.

property channels_psf_thetas_deg

Return getter.

property channels_psf_xsigmas_nm

Return getter.

property channels_psf_xtangents

Return getter.

property channels_psf_ysigmas_nm

Return getter.

property channels_psf_ytangents

Return getter.

property channels_read_noises

Return channel property.

property channels_rotations_deg

Return getter.

property channels_shapes

Return channels shapes.

property channels_spatial_kernel_shapes

Return channel property.

property channels_spatial_kernels

Return channel property.

property channels_weighted_integrations

Return getter.

property channels_wf_images

Return getter.

property channels_x_shears

Return getter.

property channels_x_shifts_nm

Return getter.

property channels_y_shears

Return getter.

property channels_y_shifts_nm

Return getter.

property chunk

Return chunk.

property comet_frames_per_segment

Return getter.

property comet_max_drift_nm

Return getter.

property comet_recompute

Return getter.

property comet_tol

Return getter.

property crop_nm

Return getter.

property crosscorr_frames_per_segment

Return getter.

property crosscorr_outlier_fraction

Return getter.

property crosscorr_recompute

Return getter.

property cuda

Return getter.

property dbscan_eps

Return getter.

property dbscan_min_points

Return getter.

property demix2d_method

Return getter.

property demix_method

Return getter.

property distribution

Return getter.

property do_spatial_filter

Return getter.

property do_spatial_mean

Return getter.

property do_spatial_opening

Return getter.

property do_temporal_filter

Return getter.

property do_temporal_median

Return getter.

property donald_x_channels

Return getter.

property donald_y_channels

Return getter.

property dpflim_x_channels

Return getter.

property dpflim_y_channels

Return getter.

property drift_method

Return getter.

property dyes

Return getter.

property estimator

Return getter.

property exposure_ms

Return getter.

property frame_bytes

Return frame bytes.

property frames_per_sequence

Return getter.

property glob_pixel_nm

Return glob pixel nm.

property globdet_groups

Return getter.

property globdet_mode

Return getter.

property globdet_use

Return getter.

property globloc_use

Return getter.

property iflim_x_channels

Return getter.

property iflim_y_channels

Return getter.

property intensity_channels

Return getter.

property irradiance_image

Return getter.

property lifetime_iflim_calibration

Return getter.

property lifetime_method

Return getter.

property loaded

Return getter.

property mean_radius_nm

Return getter.

property meanshift_frames_per_segment

Return getter.

property meanshift_max_drift_nm

Return getter.

property meanshift_max_iter

Return getter.

property meanshift_outlier_fraction

Return getter.

property meanshift_recompute

Return getter.

property meanshift_tol_nm

Return getter.

property median_window_fr

Return median window fr.

property median_window_ms

Return getter.

property metadata

Return explicitly stored metadata grouped by metadata section.

property modloc_axial_angle_deg

Return getter.

property modloc_channels_indices

Return getter.

property modloc_dephases_rad

Return getter.

property modloc_sequential_frames

Return getter.

property modloc_transverse_angle_deg

Return getter.

property ncameras

Return getter.

property nchannels

Return nchannels.

property ndyes

Return ndyes.

property nframes

Return getter.

property on_time_kernel

Return on time kernel.

property on_time_ms

Return getter.

property opening_radius_nm

Return getter.

property optimizer

Return getter.

property pad

Return pad.

property parallel

Return getter.

property phase_method

Return getter.

property pixel_sr_nm

Return getter.

save(path, file=None)[source]

Save metadata JSON and array data to disk.

property snr_thresh

Return getter.

property spatial_subtract_factor

Return getter.

property spectral_x_channels

Return getter.

property spectral_y_channels

Return getter.

property temporal_kernel
property temporal_kernel_shape

Return temporal kernel shape.

property temporal_subtract_factor

Return getter.

property temporal_subtract_kernel

Return temporal subtract kernel.

property tilt_method

Return getter.

property track_association_radius_nm

Return getter.

property x_channels

Return getter.

property x_method

Return getter.

property x_timeloc_calibration

Return getter.

property y_channels

Return getter.

property y_method

Return getter.

property y_timeloc_calibration

Return getter.

property z_astig_calibration

Return getter.

property z_biplane_calibration

Return getter.

property z_channels

Return getter.

property z_donald_calibration

Return getter.

property z_method

Return getter.

property z_miet_calibration

Return getter.

property z_qtirf_calibration

Return getter.

property z_timeloc_calibration

Return getter.

property zstack_speed

Return getter.