moscot.base.problems.BirthDeathProblem.push¶
- BirthDeathProblem.push(data=None, subset=None, normalize=True, *, split_mass=False, scale_by_marginals=False)¶
Push data through the
transport_matrix.- Parameters:
data (
Union[str,ndarray[tuple[int,...],dtype[floating]],Array,None]) –Data to push through the transport matrix. Valid options are:
ndarray- array of shape[n,]or[n, d].str- key inadata_src.obs['{data}']. Ifsubsetis alist, the data will be a boolean mask determined by the subset. Useful for categorical data.None- the value depends on thesubset.list- names inadata_src.obs_namesto push.tuple- start and offset indices \((subset[0], subset[0] + subset[1])\). that define a boolean mask to push.None- uniform array of \(1\).
subset (
Union[str,List[str],Tuple[int,int],None]) – Push values contained only within the subset.normalize (
bool) – Whether to normalize the columns ofdatato sum to \(1\).split_mass (
bool) – Whether to split non-zero values indatainto separate columns.scale_by_marginals (
bool) – Whether to scale by the source :term`marginals`a.
- Return type:
- Returns:
: The transported values, array of shape
[m, d].