rename compensate

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.6.1] - 2024-04-08
+
+Rename `correct_spillover` -> `compensate`
+
 ## [1.6.0] - 2024-04-08
 
 ### Changed

docs/api/preprocess.md

@@ -18,6 +18,6 @@
     options:
       show_root_heading: true
 
-::: scyan.preprocess.correct_spillover
+::: scyan.preprocess.compensate
     options:
       show_root_heading: true

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "scyan"
-version = "1.6.0"
+version = "1.6.1"
 description = "Single-cell Cytometry Annotation Network"
 documentation = "https://mics-lab.github.io/scyan/"
 homepage = "https://mics-lab.github.io/scyan/"

scyan/preprocess.py

@@ -216,8 +216,8 @@ def subsample(adata: AnnData, n_obs: int) -> AnnData:
     return adata[indices]
 
 
-def correct_spillover(adata: AnnData, key_added: Optional[str] = None):
-    """Use the spillover matrix in `adata.varp["spillover_matrix"]` to correct spillover
+def compensate(adata: AnnData, key_added: Optional[str] = None):
+    """Use the spillover matrix in `adata.varp["spillover_matrix"]` to correct spillover from `adata.X`
 
     Args:
         adata: An `AnnData` object
@@ -231,7 +231,8 @@ def correct_spillover(adata: AnnData, key_added: Optional[str] = None):
     ):
         log.warn("It is recommended to apply spillover only on raw data (unprocessed)")
 
-    corrected = adata.X @ adata.varp["spillover_matrix"].T
+    S = adata.varp["spillover_matrix"]
+    corrected = np.linalg.solve(S, adata.X.T).T
 
     if key_added is None:
         adata.X = corrected