uchrom.strc.enrichment¶

Structural feature enrichment helpers for ChromData.

This module wraps existing structure callers and projects their interval outputs back onto the spot axis. It is deliberately independent of uchrom_discovery so browser, plotting, notebooks, and discovery can share the same structural feature layer.

uchrom.strc.enrichment.add_structural_features(cdata, *, tads: DataFrame | None = None, loops: DataFrame | None = None, compartments: DataFrame | None = None, tads_key: str | None = None, loops_key: str | None = None, compartments_key: str | None = None, prefix: str = 'strc', result_key: str = 'bin_features', project: bool = True, store: bool = True, overwrite: bool = False) → DataFrame[source]¶

Project TAD/loop/compartment outputs into cdata.bin_tracks (per bin).

*_key=None looks the result up under the 2.0 key first ("tads.arcfish", "loops.axiswise_f", "compartments.axes_pc"), then under the 1.x key ("tads", …).

uchrom.strc.enrichment.call_compartments_multi(cdata, *, chroms: Sequence[str] | None = None, params=None, device: str = 'auto', result_key: str = 'compartments', store: bool = True, verbose: bool = False) → DataFrame[source]¶: Deprecated: use call_compartments_axes_pc(cd, chrom=None).

uchrom.strc.enrichment.call_loops_multi(cdata, *, chroms: Sequence[str] | None = None, params=None, device: str = 'auto', result_key: str = 'loops', store: bool = True, verbose: bool = False) → DataFrame[source]¶: Deprecated: use call_loops_axiswise_f(cd, chrom=None).

uchrom.strc.enrichment.call_structures_multi(cdata, *, structures: Sequence[str] = ('tads', 'loops', 'compartments'), chroms: Sequence[str] | None = None, device: str = 'auto', store: bool = True, verbose: bool = False) → dict[str, DataFrame][source]¶

Deprecated: call each structure caller with chrom=None.

Stores under the 1.x keys "tads" / "loops" / "compartments".

uchrom.strc.enrichment.call_tads_multi(cdata, *, chroms: Sequence[str] | None = None, params=None, device: str = 'auto', result_key: str = 'tads', store: bool = True, verbose: bool = False) → DataFrame[source]¶: Deprecated: use call_tads_by_pval(cd, chrom=None).

uchrom.strc.enrichment.compute_structural_features(intervals: DataFrame, *, tads: DataFrame | None = None, loops: DataFrame | None = None, compartments: DataFrame | None = None) → DataFrame[source]¶: Compute spot-bin structural features from interval result tables.