cytoflow.utility.scale¶
-
class
cytoflow.utility.scale.
IScale
[source]¶ Bases:
traits.has_traits.Interface
An interface for various ways we could rescale flow data.
-
name
¶ The name of this view (for serialization, UI, etc.)
Type: Str
-
experiment
¶ The experiment this scale is to be applied to. Needed because some scales have parameters estimated from data.
Type: Instance(Experiment)
-
channel
¶ Which channel to scale. Needed because some scales have parameters estimated from data.
Type: Str
-
condition
¶ What condition to scale. Needed because some scales have parameters estimated from the a condition. Must be a numeric condition; else instantiating the scale should fail.
Type: Str
-
statistic
¶ What statistic to scale. Needed because some scales have parameters estimated from a statistic. The statistic must be numeric or an iterable of numerics; else instantiating the scale should fail.
Type: Tuple(Str, Str)
-
data
¶ What raw data to scale.
Type: array_like
-
-
cytoflow.utility.scale.
scale_factory
(scale, experiment, **scale_params)[source]¶ Make a new instance of a named scale.
Parameters: - scale (string) – The name of the scale to build
- experiment (Experiment) – The experiment to use to parameterize the new scale.
- **scale_params (kwargs) – Other parameters to pass to the scale constructor
-
cytoflow.utility.scale.
register_scale
(scale_class)[source]¶ Register a new scale for the
scale_factory()
andScaleEnum
.