psy-reg psyplot plugin

This module defines the rcParams for the psy-reg plugin

Functions:

get_versions([requirements])
patch_prior_1_0(plotter_d, versions)	Patch psy_reg plotters for versions smaller than 1.0
validate_callable(val)
validate_fit(val)
validate_fix(val)
validate_ideal(val)
validate_iter(value)	Validate that the given value is an iterable
validate_line_xlim(val)
validate_p0(value)
validate_param_bounds(value)
validate_stringlist(s)	Validate a list of strings

Data:

patches

patches to apply when loading a project

Classes:

validate_list([dtype, length, listtype])

Validate a list of the specified dtype

psy_reg.plugin.get_versions(requirements=True)

psy_reg.plugin.patch_prior_1_0(plotter_d, versions)

Patch psy_reg plotters for versions smaller than 1.0

Before psyplot 1.0.0, the plotters in the psy_reg package where part of the psyplot.plotter.linreg module. This has to be corrected

psy_reg.plugin.patches = {('psyplot.plotter.linreg', 'DensityRegPlotter'): <function patch_prior_1_0>, ('psyplot.plotter.linreg', 'LinRegPlotter'): <function patch_prior_1_0>}

patches to apply when loading a project

psy_reg.plugin.rcParams = {'plotter.densityreg.lineplot': '-', 'plotter.linreg.bootstrap.random_seed': None, 'plotter.linreg.ci': 95.0, 'plotter.linreg.fit': ['fit'], 'plotter.linreg.fix': [None], 'plotter.linreg.id_color': None, 'plotter.linreg.ideal': None, 'plotter.linreg.line_xlim': [('minmax', 'minmax')], 'plotter.linreg.nboot': 1000, 'plotter.linreg.p0': ['auto'], 'plotter.linreg.param_bounds': [None], 'plotter.linreg.xrange': ('minmax', 'minmax'), 'plotter.linreg.yrange': ('minmax', 'minmax'), 'project.plotters': {'densityreg': {'default_slice': None, 'module': 'psy_reg.plotters', 'plotter_name': 'DensityRegPlotter', 'plugin': 'psy_reg.plugin', 'prefer_list': False, 'summary': 'Make a density plot and draw a fit from x to y of points'}, 'linreg': {'default_slice': None, 'module': 'psy_reg.plotters', 'plotter_name': 'LinRegPlotter', 'plugin': 'psy_reg.plugin', 'prefer_list': True, 'summary': 'Draw a fit from x to y'}}}

the RcParams for the psy-reg plugin

psy_reg.plugin.validate_callable(val)

psy_reg.plugin.validate_fit(val)

psy_reg.plugin.validate_fix(val)

psy_reg.plugin.validate_ideal(val)

psy_reg.plugin.validate_iter(value)

Validate that the given value is an iterable

psy_reg.plugin.validate_line_xlim(val)

class psy_reg.plugin.validate_list(dtype=None, length=None, listtype=<class 'list'>)

Bases: object

Validate a list of the specified dtype

Parameters:

dtype (object) – A datatype (e.g. float) that shall be used for the conversion

Attributes:

dtype

data type (e.g. float) used for the conversion.

dtype

data type (e.g. float) used for the conversion

psy_reg.plugin.validate_p0(value)

psy_reg.plugin.validate_param_bounds(value)

psy_reg.plugin.validate_stringlist(s)

Validate a list of strings

Parameters:

val (iterable of strings)

Returns:

list of str

Return type:

list

Raises:

ValueError –