cytoflow.operations.base_op_views¶

class cytoflow.operations.base_op_views.OpView[source]¶

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[source]¶

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:	String

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[source]¶

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

xchannel, ychannel

The channels to use for this view’s X and Y axes. If you created the view using default_view(), this is already set.

Type:	String

xscale, yscale

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.ByView[source]¶

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(String)

by¶

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

Type:	List(String)

enum_plots(experiment)[source]¶

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)[source]¶

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[source]¶: Bases: cytoflow.operations.base_op_views.ByView, cytoflow.operations.base_op_views.Op1DView

class cytoflow.operations.base_op_views.By2DView[source]¶: Bases: cytoflow.operations.base_op_views.ByView, cytoflow.operations.base_op_views.Op2DView

class cytoflow.operations.base_op_views.NullView[source]¶

Bases: cytoflow.views.base_views.BaseDataView

An IView that doesn’t actually do any plotting.

class cytoflow.operations.base_op_views.AnnotatingView[source]¶

Bases: cytoflow.views.base_views.BaseDataView

A IView that plots an underlying data plot, then plots some annotations on top of it. See 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)[source]¶

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