smlmlp.associate_consecutive_frames_radius module

smlmlp.associate_consecutive_frames_radius(xx, yy, fr, *, log_bins=50, r_min=1.0, r_max=500.0, smooth=3, reference_frame_offset=100, reference_ratio=0.05, cuda=False, parallel=False)[source]

Estimate an xy association radius from frame-pair distance histograms.

Parameters:
  • xx (array-like) – Localization coordinates.

  • yy (array-like) – Localization coordinates.

  • fr (array-like) – Frame index.

  • log_bins (int, optional) – Number of bins used for the log-log histograms.

  • r_min (float, optional) – Minimum distance considered.

  • r_max (float, optional) – Maximum distance considered.

  • smooth (int, optional) – Moving-average window applied to linear 1 nm histograms.

  • reference_frame_offset (int, optional) – Frame offset used to build a reference nearest-neighbor histogram. A large offset should mostly capture localization density effects.

  • reference_ratio (float, optional) – Radius criterion on smoothed histograms. The returned radius is the first distance where hist_reference / hist_consecutive reaches this ratio.

  • cuda (bool, optional) – Execution options accepted by all analysis functions.

  • parallel (bool, optional) – Execution options accepted by all analysis functions.

Returns:

  • radius (float) – Estimated association radius.

  • info (dict) – Diagnostic information.