Mask

class pylluminator.mask.Mask(mask_name: str, sample_label: str | None, indexes: MultiIndex)

Bases: object

A mask is a set of probes that are masked for a specific sample or for all samples.

Variables:

  • mask_name (str) – the name of the mask

  • sample_label (str) – the name of the sample the mask is applied to

  • indexes (pandas.MultiIndex) – a MultiIndex of masked probes

Methods

__init__(mask_name, sample_label, indexes)

Create a new Mask object.

copy()

Creates a copy of the Mask object.

Methods and attributes detail

__init__(mask_name: str, sample_label: str | None, indexes: MultiIndex)

Create a new Mask object.

Parameters:

  • mask_name (str) – the name of the mask

  • sample_label (str | None) – the name of the sample the mask is applied to. Default: None

  • indexes (pandas.MultiIndex) – a pandas MultiIndex of probes to mask

copy()

Creates a copy of the Mask object.