pytometry.preprocessing.split_signal#
- pytometry.preprocessing.split_signal(adata, var_key=None, key='signal_type', option='area', data_type='facs', copy=False)#
Method to filter out height or area data.
- Parameters
adata (AnnData) – AnnData object containing data.
var_key (str, optional) – key where to check if a feature is an area, height etc. type of value. Use
var_names
if None.key (str, optional) – key for adata.var where the variable type is stored. Defaults to ‘signal_type’.
option (str, optional) – for choosing ‘area’ or ‘height’ in case of FACS data and ‘element’ for cyTOF data. Defaults to ‘area’.
data_type (str, optional) – either ‘facs’ or ‘cytof’/’cyTOF’. Defaults to ‘facs’.
copy (bool, optional) – Return a copy instead of writing to adata. Defaults to False.
- Returns
AnnData: AnnData object containing area or height data in
.var
- Return type
Depending on
copy
, returns or updatesadata
with the following fields