watex.property.BasePlot#

class watex.property.BasePlot(savefig=None, fig_num=1, fig_size=(12, 8), fig_dpi=300, fig_legend=None, fig_orientation='landscape', fig_title=None, fig_aspect='auto', font_size=3.0, font_style='italic', font_weight='bold', fs=5.0, ms=3.0, marker='o', markerfacecolor='yellow', markeredgecolor='cyan', markeredgewidth=3.0, lc='k', ls='-', lw=1.0, alpha=0.5, bins=10, xlim=None, ylim=None, xminorticks=1, yminorticks=1, xlabel=None, ylabel=None, rotate_xlabel=None, rotate_ylabel=None, leg_kws={'loc': 'lower right'}, plt_kws={}, plt_style='pcolormesh', plt_shading='auto', imshow_interp=None, s=40.0, cmap='jet_r', show_grid=False, galpha=0.5, gaxis='both', gc='k', gls='--', glw=2.0, gwhich='major', tp_axis='both', tp_labelsize=3.0, tp_bottom=True, tp_top=True, tp_labelbottom=False, tp_labeltop=True, cb_orientation='vertical', cb_aspect=20.0, cb_shrink=1.0, cb_pad=0.05, cb_anchor=(0.0, 0.5), cb_panchor=(1.0, 0.5), cb_label=None, cb_spacing='uniform', cb_drawedges=False, cb_format=None, sns_orient='v', sns_style=None, sns_palette=None, sns_height=4.0, sns_aspect=0.7, sns_theme_kws=None, verbose=0)[source]#

Base class deals with Machine learning and conventional Plots.

The BasePlot can not be instanciated. It is build on the top of other plotting classes and its attributes are used for external plots.

Hold others optional informations:

Property

Description

fig_dpi

dots-per-inch resolution of the figure default is 300

fig_num

number of the figure instance. default is 1

fig_aspect

[‘equal’| ‘auto’] or float, figure aspect. Can be rcParams[“image.aspect”]. default is auto.

fig_size

size of figure in inches (width, height) default is [5, 5]

savefig

savefigure’s name, default is None

fig_orientation

figure orientation. default is landscape

fig_title

figure title. default is None

fs

size of font of axis tick labels, axis labels are fs+2. default is 6

ls

[ ‘-’ | ‘.’ | ‘:’ ] line style of mesh lines default is ‘-’

lc

line color of the plot, default is k

lw

line weight of the plot, default is 1.5

alpha

transparency number, default is 0.5

font_weight

weight of the font , default is bold.

ms

size of marker in points. default is 5

marker

style of marker in points. default is o.

marker_facecolor

facecolor of the marker. default is yellow

marker_edgecolor

edgecolor of the marker. default is cyan.

marker_edgewidth

width of the marker. default is 3.

xminorticks

minortick according to x-axis size and default is 1.

yminorticks

minortick according to y-axis size and default is 1.

font_size

size of font in inches (width, height) default is 3.

font_style

style of font. default is italic

bins
histograms element separation between two bar.

default is 10.

xlim

limit of x-axis in plot. default is None

ylim

limit of y-axis in plot. default is None

xlabel

label name of x-axis in plot. default is None

ylabel

label name of y-axis in plot. default is None

rotate_xlabel

angle to rotate xlabel in plot. default is None

rotate_ylabel

angle to rotate ylabel in plot. default is None

leg_kws

keyword arguments of legend. default is empty dict.

plt_kws

keyword arguments of plot. default is empty dict

plt_style

keyword argument of 2d style. default is pcolormesh

plt_shading

keyword argument of Axes pycolormesh shading. It can be [‘flat’|’nearest’|’gouraud’|’auto’].*default* is ‘auto’

imshow_interp

[‘bicubic’|’nearest’|’bilinear’|’quadractic’ ] kind of interpolation for ‘imshow’ plot. Click `interpol_imshow`_ to get furher details about the interpolation method. default is None.

rs

[ ‘-’ | ‘.’ | ‘:’ ] line style of Recall metric default is ‘–’

ps

[ ‘-’ | ‘.’ | ‘:’ ] line style of `Precision `metric default is ‘-’

rc

line color of Recall metric default is (.6,.6,.6)

pc

line color of Precision metric default is k

s

size of items in scattering plots. default is fs*40.

cmap

matplotlib colormap. default is jet_r

gls

[ ‘-’ | ‘.’ | ‘:’ ] line style of grid default is ‘–‘.

glc

line color of the grid plot, default is k

glw

line weight of the grid plot, default is 2

galpha

transparency number of grid, default is 0.5

gaxis

axis to plot grid.*default* is 'both'

gwhich

type of grid to plot. default is major

tp_axis

axis to apply ticks params. default is both

tp_labelsize

labelsize of ticks params. default is italic

tp_bottom

position at bottom of ticks params. default is True.

tp_top

position at the top of ticks params. default is True.

tp_labelbottom

see label on the bottom of the ticks. default is False

tp_labeltop

see the label on the top of ticks. default is True

cb_orientation

orientation of the colorbar. default is vertical

cb_aspect

aspect of the colorbar. default is 20.

cb_shrink

shrink size of the colorbar. default is 1.0

cb_pad

pad of the colorbar of plot. default is .05

cb_anchor

anchor of the colorbar. default is (0.0, 0.5)

cb_panchor

proportionality anchor of the colorbar. default is `` (1.0, 0.5)``.

cb_label

label of the colorbar. default is None.

cb_spacing

spacing of the colorbar. default is uniform

cb_drawedges

draw edges inside of the colorbar. default is False

cb_format

format of the colorbar values. default is None.

sns_orient

seaborn fig orientation. default is v which refer to vertical

sns_style

seaborn style

sns_palette

seaborn palette

sns_height

seaborn height of figure. default is 4..

sns_aspect

seaborn aspect of the figure. default is .7

sns_theme_kws

seaborn keywords theme arguments. default is { 'style':4., 'palette':.7}

verbose

control the verbosity. Higher value, more messages. default is 0.