metaclean3.fcs¶

Module Contents¶

Classes¶

class metaclean3.fcs.FCSfile¶

Prepares an FCS file for MetaClean3.0.

Attributes:

data (pandas.DataFrame): FCS file data matrix sorted by time. time_step (float | None, optional):

See binning.get_time_binned(). Defaults to None.

time_chan (str): Time channel name. Defaults to ‘time’. bin_chan (str, optional): Name of the bin column to be added. fluo_chans (list | np.ndarray, optional):

Fluorescent channels that can be used for 0. Defaults to np.array([]).

phys_chans (list | np.ndarray, optional):

Physical morphological channels that can be used for 0. Defaults to np.array([]).

data : pandas.DataFrame¶

time_step : float | None¶

time_chan : str = 'time'¶

bin_chan : str = 'bin'¶

fluo_chans : list | numpy.ndarray¶

phys_chans : list | numpy.ndarray¶

time_bin : dataclasses.InitVar[str | None]¶

channel_unique_no : dataclasses.InitVar[int] = 25¶

min_bin_size : dataclasses.InitVar[int] = 2000¶

max_bin_size : dataclasses.InitVar[int] = 10000¶

min_events_per_bin : dataclasses.InitVar[int] = 50¶

__post_init__(time_bin, channel_unique_no, min_bin_size, max_bin_size, min_events_per_bin)¶

Args:

time_bin (str, optional): See binning.get_time_binned().

Defaults to ‘1S’.

channel_unique_no (int):

See channels.get_clean_fp_channels(). Defaults to 25.

min_bin_size (int, optional):

See binning.get_time_binned(). Defaults to 2000.

max_bin_size (int, optional):

See binning.get_time_binned(). Defaults to 10000.

min_events_per_bin (int, optional):

See binning.get_time_binned(). Defaults to 50.