#!/usr/bin/env python3.8
# coding: latin-1
# (c) Massachusetts Institute of Technology 2015-2018
# (c) Brian Teague 2018-2022
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""
cytoflowgui.workflow.views.stats_2d
-----------------------------------
"""
import logging
from textwrap import dedent
from traits.api import provides, Instance, Enum
from cytoflow import Stats2DView
import cytoflow.utility as util
from cytoflowgui.workflow.serialization import camel_registry, cytoflow_class_repr, traits_str
from .view_base import IWorkflowView, WorkflowByView, Stats2DPlotParams as _Stats2DPlotParams, LINE_STYLES, SCATTERPLOT_MARKERS
Stats2DView.__repr__ = cytoflow_class_repr
[docs]
class Stats2DPlotParams(_Stats2DPlotParams):
linestyle = Enum(LINE_STYLES)
marker = Enum(SCATTERPLOT_MARKERS)
markersize = util.PositiveCFloat(6, allow_zero = False)
capsize = util.PositiveCFloat(None, allow_none = True, allow_zero = False)
alpha = util.PositiveCFloat(1.0)
[docs]
@provides(IWorkflowView)
class Stats2DWorkflowView(WorkflowByView, Stats2DView):
plot_params = Instance(Stats2DPlotParams, ())
[docs]
def get_notebook_code(self, idx):
view = Stats2DView()
view.copy_traits(self, view.copyable_trait_names())
plot_params_str = traits_str(self.plot_params)
return dedent("""
{repr}.plot(ex_{idx}{plot}{plot_params})
"""
.format(repr = repr(view),
idx = idx,
plot = ", plot_name = " + repr(self.current_plot) if self.current_plot else "",
plot_params = ", " + plot_params_str if plot_params_str else ""))
### Serialization
@camel_registry.dumper(Stats2DWorkflowView, 'stats-2d', version = 3)
def _dump(view):
return dict(statistic = view.statistic,
xfeature = view.xfeature,
xscale = view.xscale,
yfeature = view.yfeature,
yscale = view.yscale,
variable = view.variable,
xfacet = view.xfacet,
yfacet = view.yfacet,
huefacet = view.huefacet,
huescale = view.huescale,
xerror_low = view.xerror_low,
xerror_high = view.xerror_high,
yerror_low = view.yerror_low,
yerror_high = view.yerror_high,
subset_list = view.subset_list,
plot_params = view.plot_params,
current_plot = view.current_plot)
@camel_registry.dumper(Stats2DWorkflowView, 'stats-2d', version = 2)
def _dump_v2(view):
return dict(xstatistic = view.xstatistic,
xscale = view.xscale,
ystatistic = view.ystatistic,
yscale = view.yscale,
variable = view.variable,
xfacet = view.xfacet,
yfacet = view.yfacet,
huefacet = view.huefacet,
huescale = view.huescale,
x_error_statistic = view.x_error_statistic,
y_error_statistic = view.y_error_statistic,
subset_list = view.subset_list,
plot_params = view.plot_params,
current_plot = view.current_plot)
@camel_registry.dumper(Stats2DWorkflowView, 'stats-2d', version = 1)
def _dump_v1(view):
return dict(xstatistic = view.xstatistic,
xscale = view.xscale,
ystatistic = view.ystatistic,
yscale = view.yscale,
variable = view.variable,
xfacet = view.xfacet,
yfacet = view.yfacet,
huefacet = view.huefacet,
huescale = view.huescale,
x_error_statistic = view.x_error_statistic,
y_error_statistic = view.y_error_statistic,
subset_list = view.subset_list)
@camel_registry.loader('stats-2d', version = 3)
def _load(data, version):
return Stats2DWorkflowView(**data)
@camel_registry.loader('stats-2d', version = 2)
def _load_v2(data, version):
data['statistic'] = data['xstatistic'][0]
del data['ystatistic']
del data['x_error_statistic']
del data['y_error_statistic']
logging.warn("Statistics have changed substantially since you saved this "
".flow file, so you'll need to reset a few things. "
"See the FAQ in the online documentation for details.")
return Stats2DWorkflowView(**data)
@camel_registry.loader('stats-2d', version = 1)
def _load_v1(data, version):
data['statistic'] = data['xstatistic'][0]
del data['ystatistic']
del data['x_error_statistic']
del data['y_error_statistic']
logging.warn("Statistics have changed substantially since you saved this "
".flow file, so you'll need to reset a few things. "
"See the FAQ in the online documentation for details.")
return Stats2DWorkflowView(**data)
@camel_registry.dumper(Stats2DPlotParams, 'stats-2d-params', version = 2)
def _dump_params_v2(params):
return dict(
# BasePlotParams
title = params.title,
xlabel = params.xlabel,
ylabel = params.ylabel,
huelabel = params.huelabel,
col_wrap = params.col_wrap,
sns_style = params.sns_style,
sns_context = params.sns_context,
palette = params.palette,
legend = params.legend,
sharex = params.sharex,
sharey = params.sharey,
despine = params.despine,
# Base2DStatisticsView
xlim = params.xlim,
ylim = params.ylim,
# Stats 2D View
linestyle = params.linestyle,
marker = params.marker,
markersize = params.markersize,
capsize = params.capsize,
alpha = params.alpha)
@camel_registry.dumper(Stats2DPlotParams, 'stats-2d-params', version = 1)
def _dump_params_v1(params):
return dict(
# BasePlotParams
title = params.title,
xlabel = params.xlabel,
ylabel = params.ylabel,
huelabel = params.huelabel,
col_wrap = params.col_wrap,
sns_style = params.sns_style,
sns_context = params.sns_context,
legend = params.legend,
sharex = params.sharex,
sharey = params.sharey,
despine = params.despine,
# Base2DStatisticsView
xlim = params.xlim,
ylim = params.ylim,
# Stats 2D View
linestyle = params.linestyle,
marker = params.marker,
markersize = params.markersize,
capsize = params.capsize,
alpha = params.alpha)
@camel_registry.loader('stats-2d-params', version = any)
def _load_params(data, version):
return Stats2DPlotParams(**data)