mythos.observables.persistence_length
Persistence length observable.
Attributes
Classes
Computes the persistence length (Lp) from a trajectory. |
Functions
|
Computes the Lp given correlations in alignment decay and average distance between base pairs. |
|
Computes the average correlations in alignment decay between a list of vector. |
|
Computes (i) average correlations in alignment decay and (ii) average distance between base pairs. |
Module Contents
- mythos.observables.persistence_length.TARGETS
- mythos.observables.persistence_length.persistence_length_fit(correlations: jax.numpy.ndarray, l0_av: float) tuple[float, float][source]
Computes the Lp given correlations in alignment decay and average distance between base pairs.
Lp obeys the following equality: <l_n * l_0> = exp(-n<l_0> / Lp), where <l_n * l_0> represents the average correlation between adjacent base pairs (l_0) and base pairs separated by a distance of n base pairs (l_n). This relationship is linear in log space, log(<l_n * l_0>) = -n<l_0> / Lp. So, given the average correlations across distances and the average distance between adjacent base pairs, we compute Lp via a linear fit.
- Parameters:
correlations (jnp.ndarray) – a (max_dist,) array containing the average correlation between base pairs separated by distances up to max_dist
l0_av (jnp.ndarray) – the average distance between adjacent base pairs
- mythos.observables.persistence_length.vector_autocorrelate(vecs: jax.numpy.ndarray) jax.numpy.ndarray[source]
Computes the average correlations in alignment decay between a list of vector.
Given an ordered list of n vectors (representing vectors between adjacent base pairs), computes the average correlation between all pairs of vectors separated by a distance d for all distances d < n. Note that multiple pairs of vectors are included for all values < n-1.
- Parameters:
vecs (jnp.ndarray) – a (n, 3) array of vectors corresponding to displacements between midpoints of adjacent base pairs.
- mythos.observables.persistence_length.get_all_l_vectors
- mythos.observables.persistence_length.compute_metadata(base_sites: jax.numpy.ndarray, quartets: jax.numpy.ndarray, displacement_fn: collections.abc.Callable, skip_ends: bool) tuple[jax.numpy.ndarray, float][source]
Computes (i) average correlations in alignment decay and (ii) average distance between base pairs.
- class mythos.observables.persistence_length.PersistenceLength[source]
Bases:
mythos.observables.base.BaseObservableComputes the persistence length (Lp) from a trajectory.
To model Lp, we assume an infinitely long, semi-flexible polymer, in which correlations in alignment decay exponentially with separation. So, to compute Lp, we need the average correlations across many states, as well as the average distance between adjacent base pairs. This observable computes these two quantities for a single state, and the average of these quantities across a trajectory can be postprocessed to compute a value for Lp.
The callable of this class computes the weighted fitted Lp for a trajectory, while the lp_fit method computes the fitted Lp and offset. The get_all_corrs_and_l0s method computes the correlations and average distance between adjacent base pairs for each state in a trajectory.
- Parameters:
quartets – a (n_bp-1, 2, 2) array containing the pairs of adjacent base
pairs – for which to compute the Lp
displacement_fn – a function for computing displacements between two positions
truncate – if provided, only consider correlations up to this distance
skip_ends – if True, skip the first two and last two quartets when
computing
- quartets: jax.numpy.ndarray
- displacement_fn: collections.abc.Callable
- __call__(trajectory: mythos.simulators.io.SimulatorTrajectory, weights: jax.numpy.ndarray | None = None) float[source]
Calculate the fitted persistence length for a trajectory.
- Parameters:
trajectory – the trajectory to calculate the persistence length for
weights – if provided, a (n_states,) array of weights to apply to correlations
- Returns:
the fitted persistence length
- lp_fit(trajectory: mythos.simulators.io.SimulatorTrajectory, weights: jax.numpy.ndarray | None = None) tuple[float, float][source]
Calculate the fitted persistence length and offset for a trajectory.
See arguments for __call__.
- Returns:
the fitted persistence length and offset
- get_all_corrs_and_l0s(trajectory: mythos.simulators.io.SimulatorTrajectory) tuple[jax.numpy.ndarray, mythos.utils.types.ARR_OR_SCALAR][source]
Calculate alignment decay and average distance correlations for adjacent base pairs.
- Parameters:
trajectory – the trajectory to calculate the persistence length for
- Returns:
tuple of (correlations, decay) the correlations in alignment decay and the the average distance between adjacent base pairs for each state. The former will have shape (n_states, n_quartets-1) and the latter will have shape (n_states,).