locan.analysis.radial_distribution.RadialDistribution

class locan.analysis.radial_distribution.RadialDistribution(bins, pair_distances=None, meta=None)[source]

Bases: _Analysis

Compute the radial distribution function within data or between data and other_data.

The algorithm relies on sklearn.metrics.pairwise.

Parameters:

  • meta (AMetadata | None) – Metadata about the current analysis routine.

  • bins (int | Sequence[int | float] | str) – Bin specification (or radii) as used in numpy.histogram()

  • pair_distances (Union[_Buffer, _SupportsArray[dtype[Any]], _NestedSequence[_SupportsArray[dtype[Any]]], bool, int, float, complex, str, bytes, _NestedSequence[bool | int | float | complex | str | bytes], PairDistances, None]) – Precomputed pair distances if available.

Variables:

  • count (int) – A counter for counting instantiations.

  • parameter (dict) – A dictionary with all settings for the current computation.

  • meta (locan.analysis.metadata_analysis_pb2.AMetadata) – Metadata about the current analysis routine.

  • results (RadialDistributionResults) – Computed results.

See also

PairDistances

Methods

__init__(bins[, pair_distances, meta])

compute(locdata[, other_locdata])

Run the computation.

hist([ax])

Provide histogram as matplotlib.axes.Axes object showing results.

report(*args, **kwargs)

Show a report about analysis results.

Attributes

count

A counter for counting Analysis class instantiations (class attribute).
compute(locdata, other_locdata=None)[source]

Run the computation.

Parameters:

  • locdata (LocData) – Localization data.

  • other_locdata (LocData | None) – Other localization data to be taken as pairs.

Return type:

Self

count: int = 0

A counter for counting Analysis class instantiations (class attribute).

hist(ax=None, **kwargs)[source]

Provide histogram as matplotlib.axes.Axes object showing results.

Parameters:

  • ax (Axes | None) – The axes on which to show the image.

  • kwargs (Any) – Other parameters passed to matplotlib.bar().

Returns:

Axes object with the plot.

Return type:

matplotlib.axes.Axes