arcfish.pl.background_model

arcfish.pl.background_model(i: int, j: int, outer_cut: int, TestClass: LoopTestAbstract, bin: int | ndarray, num_bins: int = 50, ax: Axes = None) → Axes

Cartoon visualization of background model.

Parameters:

• i (int) – Index of the first locus.

• j (int) – Index of the second locus.

• TestClass (LoopTestAbstract) – The TestClass whose background model will be visualized.

• bin (int | np.ndarray) – Either a number or an array. If a number, bin is resolution. Otherwise, need an array of 1D genomic locations (d1d).

• num_bins (int, optional) – Required if bin is an integer. Number of loci to plot, by default 50.

• ax (plt.Axes, optional) – plt.Axes object, by default None.

Returns:

plt.Axes object.

Return type:

plt.Axes