episcanpy.api.pp.log1p

episcanpy.api.pp.log1p(X, *, base=None, copy=False, chunked=None, chunk_size=None, layer=None, obsm=None)

episcanpy.api.pp.log1p(X, *, base=None, copy=False)

episcanpy.api.pp.log1p(X, *, base=None, copy=False)

episcanpy.api.pp.log1p(adata, *, base=None, copy=False, chunked=False, chunk_size=None, layer=None, obsm=None)

Logarithmize the data matrix.

Computes \(X = \log(X + 1)\), where \(log\) denotes the natural logarithm unless a different base is given.

Parameters

X : AnnData | ndarray | spmatrixUnion[AnnData, ndarray, spmatrix]

The (annotated) data matrix of shape n_obs × n_vars. Rows correspond to cells and columns to genes.

base : Number | NoneOptional[Number] (default: None)

Base of the logarithm. Natural logarithm is used by default.

copy : boolbool (default: False)

If an AnnData is passed, determines whether a copy is returned.

chunked : bool | NoneOptional[bool] (default: None)

Process the data matrix in chunks, which will save memory. Applies only to AnnData.

chunk_size : int | NoneOptional[int] (default: None)

n_obs of the chunks to process the data in.

layer : str | NoneOptional[str] (default: None)

Entry of layers to tranform.

obsm : str | NoneOptional[str] (default: None)

Entry of obsm to transform.

Returns

Returns or updates data, depending on copy.