cytoflow.operations.base_op_views

Base classes for IOperation default views:

OpView – a view that has an operation, OpView.op, as an attribute.

Op1DView – an OpView that has a Op1DView.channel attribute and its attendant Op1DView.scale. This class overrides Base1DView to delegate those attributes to OpView.op.

Op2DView – an OpView that has Op2DView.xchannel (and Op2DView.xscale) and Op2DView.ychannel (and Op2DView.yscale). This class overrides Base2DView to delegate those attributes to OpView.op.

ByView – an OpView that can plot various plots depending on what is passed to ByView.plot’s plot_name parameter.

AnnotatingView – An IView that plots an underlying data plot, then plots some annotations on top of it.

class cytoflow.operations.base_op_views.OpView

Bases: cytoflow.views.base_views.BaseDataView

op

The IOperation that this view is associated with. If you created the view using default_view, this is already set.

Type

Instance(IOperation)

class cytoflow.operations.base_op_views.Op1DView

Bases: cytoflow.operations.base_op_views.OpView, cytoflow.views.base_views.Base1DView

channel

The channel this view is viewing. If you created the view using default_view, this is already set.

Type

Str

scale

The way to scale the x axes. If you created the view using default_view, this may be already set.

Type

{‘linear’, ‘log’, ‘logicle’}

class cytoflow.operations.base_op_views.Op2DView

Bases: cytoflow.operations.base_op_views.OpView, cytoflow.views.base_views.Base2DView

xchannel

The channels to use for this view’s X axis. If you created the view using default_view, this is already set.

Type

Str

ychannel

The channels to use for this view’s Y axis. If you created the view using default_view, this is already set.

Type

Str

xscale

The way to scale the x axis. If you created the view using default_view, this may be already set.

Type

{‘linear’, ‘log’, ‘logicle’}

yscale

The way to scale the y axis. If you created the view using default_view, this may be already set.

Type

{‘linear’, ‘log’, ‘logicle’}

class cytoflow.operations.base_op_views.ByView

Bases: cytoflow.operations.base_op_views.OpView

A view that can plot various plots based on the plot_name parameter of plot.

facets

A read-only list of the conditions used to facet this view.

Type

List(Str)

by

A read-only list of the conditions used to group this view’s data before plotting.

Type

List(Str)

enum_plots(experiment)

Returns an iterator over the possible plots that this View can produce. The values returned can be passed to the plot_name keyword of plot.

Parameters

experiment (Experiment) – The Experiment that will be producing the plots.

plot(experiment, **kwargs)

Make the plot.

Parameters

plot_name (Str) – If this IView can make multiple plots, plot_name is the name of the plot to make. Must be one of the values retrieved from enum_plots.

class cytoflow.operations.base_op_views.By1DView

Bases: cytoflow.operations.base_op_views.ByView, cytoflow.operations.base_op_views.Op1DView

class cytoflow.operations.base_op_views.By2DView

Bases: cytoflow.operations.base_op_views.ByView, cytoflow.operations.base_op_views.Op2DView

class cytoflow.operations.base_op_views.NullView

Bases: cytoflow.views.base_views.BaseDataView

An IView that doesn’t actually do any plotting.

class cytoflow.operations.base_op_views.AnnotatingView

Bases: cytoflow.views.base_views.BaseDataView

A IView that plots an underlying data plot, then plots some annotations on top of it. See gaussian.GaussianMixture1DView for an example. By default, it assumes that the annotations are to be plotted in the same color as the view’s huefacet, and sets huefacet accordingly if the annotation isn’t already set to a different facet.

Note

The annotation_facet and annotation_plot parameters that the plot method consumes are only for internal use, which is why they’re not documented in the plot docstring.

plot(experiment, **kwargs)

Parameters

color (matplotlib color) – The color to plot the annotations. Overrides the default color cycle.