psy_simple.plotters module

Plotters and formatoptions for the psy-simple plugin.

Formatoption classes:

AlternativeXCoord(key[, plotter, ...])	Use an alternative variable as x-coordinate
AlternativeXCoordPost(key[, plotter, ...])	Use an alternative variable as x-coordinate
ArrowSize(key[, plotter, index_in_list, ...])	Change the size of the arrows
ArrowStyle(key[, plotter, index_in_list, ...])	Change the style of the arrows
AxisColor(key[, plotter, index_in_list, ...])	Color the x- and y-axes
BarAlpha(key[, plotter, index_in_list, ...])	Specify the transparency (alpha)
BarPlot(*args, **kwargs)	Choose how to make the bar plot
BarWidths(key[, plotter, index_in_list, ...])	Specify the widths of the bars
BarXTickLabels(*args, **kwargs)	Modify the x-axis ticklabels
BarXTicks(*args, **kwargs)	Modify the x-axis ticks
BarXlabel(key[, plotter, index_in_list, ...])	Set the x-axis label
BarXlim(*args, **kwargs)	Set the x-axis limits
BarYTickLabels(*args, **kwargs)	Modify the y-axis ticklabels
BarYTicks(*args, **kwargs)	Modify the y-axis ticks
BarYlabel(key[, plotter, index_in_list, ...])	Set the y-axis label
BarYlim(*args, **kwargs)	Set the y-axis limits
Bounds(*args, **kwargs)	Specify the boundaries of the colorbar
CLabel(key[, plotter, index_in_list, ...])	Show the colorbar label
CMap(key[, plotter, index_in_list, ...])	Specify the color map
CTickLabels(*args, **kwargs)	Specify the colorbar ticklabels
CTickProps(key[, plotter, index_in_list, ...])	Specify the font properties of the colorbar ticklabels
CTickSize(key[, plotter, index_in_list, ...])	Specify the font size of the colorbar ticklabels
CTickWeight(key[, plotter, index_in_list, ...])	Specify the fontweight of the colorbar ticklabels
CTicks(*args, **kwargs)	Specify the tick locations of the colorbar
CategoricalBars(key[, plotter, ...])	The location of each bar
Cbar(*args, **kwargs)	Specify the position of the colorbars
CbarOptions(key[, plotter, index_in_list, ...])	Base class for colorbar formatoptions
CbarSpacing(key[, plotter, index_in_list, ...])	Specify the spacing of the bounds in the colorbar
CombinedVectorPlot(*args, **kwargs)	Choose the vector plot type
ContourLevels(*args, **kwargs)	The levels for the contour plot
DataGrid(*args, **kwargs)	Show the grid of the data
DataPrecision(key[, plotter, index_in_list, ...])	Set the precision of the data
DataTicksCalculator(*args, **kwargs)	Abstract base formatoption to calculate ticks and bounds from the data
Density(*args, **kwargs)	Change the density of the arrows
DtTicksBase(*args, **kwargs)	Abstract base class for x- and y-tick formatoptions
ErrorAlpha(key[, plotter, index_in_list, ...])	Set the alpha value for the error range
ErrorCalculator(key[, plotter, ...])	Calculation of the error
ErrorPlot(*args, **kwargs)	Visualize the error range
Extend(key[, plotter, index_in_list, ...])	Draw arrows at the side of the colorbar
Grid(key[, plotter, index_in_list, ...])	Display the grid
Hist2DXRange(*args, **kwargs)	Specify the range of the histogram for the x-dimension
Hist2DYRange(*args, **kwargs)	Specify the range of the histogram for the x-dimension
HistBins(key[, plotter, index_in_list, ...])	Specify the bins of the 2D-Histogramm
InterpolateBounds(key[, plotter, ...])	Interpolate grid cell boundaries for 2D plots
LabelOptions(key[, plotter, index_in_list, ...])	Base formatoption class for label sizes
LabelProps(key[, plotter, index_in_list, ...])	Set the font properties of both, x- and y-label
LabelSize(key[, plotter, index_in_list, ...])	Set the size of both, x- and y-label
LabelWeight(key[, plotter, index_in_list, ...])	Set the font size of both, x- and y-label
Legend(key[, plotter, index_in_list, ...])	Draw a legend
LegendLabels(key[, plotter, index_in_list, ...])	Set the labels of the arrays in the legend
LimitBase(*args, **kwargs)	Base class for x- and y-limits
LineColors(*args, **kwargs)	Set the color coding
LinePlot(*args, **kwargs)	Choose the line style of the plot
LineWidth(key[, plotter, index_in_list, ...])	Choose the width of the lines
Marker(key[, plotter, index_in_list, ...])	Choose the marker for points
MarkerSize(key[, plotter, index_in_list, ...])	Choose the size of the markers for points
MaskDataGrid(key[, plotter, index_in_list, ...])	Mask the datagrid where the array is NaN
MeanCalculator(key[, plotter, ...])	Determine how the error is visualized
MissColor(key[, plotter, index_in_list, ...])	Set the color for missing values
NormedHist2D(key[, plotter, index_in_list, ...])	Specify the normalization of the histogram
Plot2D(*args, **kwargs)	Choose how to visualize a 2-dimensional scalar data field
PointDensity(key[, plotter, index_in_list, ...])	Specify the method to calculate the density
SimplePlot2D(*args, **kwargs)	Specify the plotting method
SimpleVectorPlot(*args, **kwargs)	Choose the vector plot type
SymmetricLimits(key[, plotter, ...])	Make x- and y-axis symmetric
TickLabels(*args, **kwargs)	param key formatoption key in the plotter
TickLabelsBase(*args, **kwargs)	Abstract base class for ticklabels
TickPropsBase(key[, plotter, index_in_list, ...])	Abstract base class for tick parameters
TickSize(key[, plotter, index_in_list, ...])	Change the ticksize of the ticklabels
TickSizeBase(key[, plotter, index_in_list, ...])	Abstract base class for modifying tick sizes
TickWeight(key[, plotter, index_in_list, ...])	Change the fontweight of the ticks
TickWeightBase(key[, plotter, ...])	Abstract base class for modifying font weight of ticks
TicksBase(*args, **kwargs)	Abstract base class for calculating ticks
TicksManager(key[, plotter, index_in_list, ...])	Abstract base class for ticks formatoptions controlling major and minor ticks
TicksManagerBase(key[, plotter, ...])	Abstract base class for formatoptions handling ticks
TicksOptions(key[, plotter, index_in_list, ...])	Base class for ticklabels options that apply for x- and y-axis
Transpose(*args, **kwargs)	Switch x- and y-axes
VCLabel(key[, plotter, index_in_list, ...])	Show the colorbar label of the vector plot
VectorBounds(*args, **kwargs)	Specify the boundaries of the vector colorbar
VectorCTicks(*args, **kwargs)	Specify the tick locations of the vector colorbar
VectorCalculator(*args, **kwargs)	Abstract formatoption that provides calculation functions for speed, etc.
VectorCbar(*args, **kwargs)	Specify the position of the vector plot colorbars
VectorColor(*args, **kwargs)	Set the color for the arrows
VectorDataGrid(*args, **kwargs)	param %(Formatoption.parameters)s
VectorLineWidth(*args, **kwargs)	Change the linewidth of the arrows
VectorPlot(*args, **kwargs)	Choose the vector plot type
ViolinPlot(*args, **kwargs)	Choose how to make the violin plot
ViolinXTickLabels(*args, **kwargs)	Modify the x-axis ticklabels
ViolinXTicks(*args, **kwargs)	Modify the x-axis ticks
ViolinXlim(*args, **kwargs)	Set the x-axis limits
ViolinYTickLabels(*args, **kwargs)	Modify the x-axis ticklabels
ViolinYTicks(*args, **kwargs)	Modify the y-axis ticks
ViolinYlim(*args, **kwargs)	Set the y-axis limits
XRotation(key[, plotter, index_in_list, ...])	Rotate the x-axis ticks
XTickLabels(*args, **kwargs)	Modify the x-axis ticklabels
XTickProps(key[, plotter, index_in_list, ...])	Specify the x-axis tick parameters
XTicks(*args, **kwargs)	Modify the x-axis ticks
XTicks2D(*args, **kwargs)	Modify the x-axis ticks
Xlabel(key[, plotter, index_in_list, ...])	Set the x-axis label
Xlim(*args, **kwargs)	Set the x-axis limits
Xlim2D(*args, **kwargs)	Set the x-axis limits
YRotation(key[, plotter, index_in_list, ...])	Rotate the y-axis ticks
YTickLabels(*args, **kwargs)	Modify the y-axis ticklabels
YTickProps(key[, plotter, index_in_list, ...])	Specify the y-axis tick parameters
YTicks(*args, **kwargs)	Modify the y-axis ticks
YTicks2D(*args, **kwargs)	Modify the y-axis ticks
Ylabel(key[, plotter, index_in_list, ...])	Set the y-axis label
Ylim(*args, **kwargs)	Set the y-axis limits
Ylim2D(*args, **kwargs)	Set the y-axis limits

Plotter classes:

BarPlotter([data, ax, auto_update, project, ...])	Plotter for making bar plots
Base2D([data, ax, auto_update, project, ...])	Base plotter for 2-dimensional plots
BaseVectorPlotter([data, ax, auto_update, ...])	Base plotter for vector plots
CombinedBase([data, ax, auto_update, ...])	Base plotter for combined 2-dimensional scalar and vector plot
CombinedSimplePlotter([data, ax, ...])	Combined 2D plotter and vector plotter
DensityPlotter([data, ax, auto_update, ...])	A plotter to visualize the density of points in a 2-dimensional grid
FldmeanPlotter([data, ax, auto_update, ...])	param data Data object that shall be visualized. If given and plot is True,
LinePlotter([data, ax, auto_update, ...])	Plotter for simple one-dimensional line plots
ScalarCombinedBase([data, ax, auto_update, ...])	Base plotter for combined 2-dimensional scalar field with any other plotter
Simple2DBase([data, ax, auto_update, ...])	Base class for Simple2DPlotter and psyplot.plotter.maps.FieldPlotter that defines the data management
Simple2DPlotter([data, ax, auto_update, ...])	Plotter for visualizing 2-dimensional data.
SimplePlotterBase([data, ax, auto_update, ...])	Base class for all simple plotters
SimpleVectorPlotter([data, ax, auto_update, ...])	Plotter for visualizing 2-dimensional vector data
ViolinPlotter([data, ax, auto_update, ...])	Plotter for making violin plots
XYTickPlotter([data, ax, auto_update, ...])	Plotter class for x- and y-ticks and x- and y- ticklabels

Functions:

convert_radian(coord, *variables)	Convert the given coordinate from radian to degree
format_coord_func(ax, ref)	Create a function that can replace the matplotlib.axes.Axes.format_coord()
round_to_05(n[, exp, mode])	Round to the next 0.5-value.

class psy_simple.plotters.AlternativeXCoord(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psyplot.plotter.Formatoption

Use an alternative variable as x-coordinate

This formatoption let’s you specify another variable in the base dataset of the data array in case you want to use this as the x-coordinate instead of the raw data

Possible types

• None – Use the default

• str – The name of the variable to use in the base dataset

• xarray.DataArray – An alternative variable with the same shape as the displayed array

Examples

To see the difference, we create a simple test dataset:

>>> import xarray as xr

>>> import numpy as np

>>> import psyplot.project as psy

>>> ds = xr.Dataset({
...     'temp': xr.Variable(('time', ), np.arange(5)),
...     'std': xr.Variable(('time', ), np.arange(5, 10))})
>>> ds
<xarray.Dataset>
Dimensions:  (time: 5)
Coordinates:
  * time     (time) int64 0 1 2 3 4
Data variables:
    temp     (time) int64 0 1 2 3 4
    std      (time) int64 5 6 7 8 9

If we create a plot with it, we get the 'time' dimension on the x-axis:

>>> plotter = psy.plot.lineplot(ds, name=['temp']).plotters[0]

>>> plotter.plot_data[0].dims
('time',)

If we however set the 'coord' keyword, we get:

>>> plotter = psy.plot.lineplot(
...     ds, name=['temp'], coord='std').plotters[0]

>>> plotter.plot_data[0].dims
('std',)

and 'std' is plotted on the x-axis.

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

data_dependent	bool or a callable.
data_iterator
group	str.
name	str.
priority	int.
use_raw_data	Bool.

Methods:

diff(value)	Checks whether the given value differs from what is currently set
get_alternative_coord(da, i)
replace_coord(i)	Replace the coordinate for the data array at the given position
update(value)	Method that is call to update the formatoption on the axes

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

property data_iterator

diff(value)

Checks whether the given value differs from what is currently set

Parameters

value – A possible value to set (make sure that it has been validate via the validate attribute before)

Returns

True if the value differs from what is currently set

Return type

bool

get_alternative_coord(da, i)

group = 'data'

str. Key of the group name in groups of this formatoption keyword

name = 'Alternative X-Variable'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 30

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

replace_coord(i)

Replace the coordinate for the data array at the given position

Parameters

• i (int) – The number of the data array in the raw data (if the raw data is not an interactive list, use 0)

• Returns –

• xarray.DataArray – The data array with the replaced coordinate

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

use_raw_data = True

Bool. If True, this Formatoption directly uses the raw_data, otherwise use the normal data

class psy_simple.plotters.AlternativeXCoordPost(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psy_simple.plotters.AlternativeXCoord

Use an alternative variable as x-coordinate

This formatoption let’s you specify another variable in the base dataset of the data array in case you want to use this as the x-coordinate instead of the raw data

Possible types

• None – Use the default

• str – The name of the variable to use in the base dataset

• xarray.DataArray – An alternative variable with the same shape as the displayed array

Examples

To see the difference, we create a simple test dataset:

>>> import xarray as xr

>>> import numpy as np

>>> import psyplot.project as psy

>>> ds = xr.Dataset({
...     'temp': xr.Variable(('time', ), np.arange(5)),
...     'std': xr.Variable(('time', ), np.arange(5, 10))})
>>> ds
<xarray.Dataset>
Dimensions:  (time: 5)
Coordinates:
  * time     (time) int64 0 1 2 3 4
Data variables:
    temp     (time) int64 0 1 2 3 4
    std      (time) int64 5 6 7 8 9

If we create a plot with it, we get the 'time' dimension on the x-axis:

>>> plotter = psy.plot.lineplot(ds, name=['temp']).plotters[0]

>>> plotter.plot_data[0].dims
('time',)

If we however set the 'coord' keyword, we get:

>>> plotter = psy.plot.lineplot(
...     ds, name=['temp'], coord='std').plotters[0]

>>> plotter.plot_data[0].dims
('std',)

and 'std' is plotted on the x-axis.

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

use_raw_data

Bool.

use_raw_data = False

Bool. If True, this Formatoption directly uses the raw_data, otherwise use the normal data

class psy_simple.plotters.ArrowSize(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psyplot.plotter.Formatoption

Change the size of the arrows

Possible types

• None – make no scaling

• float – Factor scaling the size of the arrows

See also

arrowstyle, linewidth, density, color

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

dependencies = ['plot']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'vector'

str. Key of the group name in groups of this formatoption keyword

name = 'Size of the arrows'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

class psy_simple.plotters.ArrowStyle(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psyplot.plotter.Formatoption

Change the style of the arrows

Possible types

str – Any arrow style string (see FancyArrowPatch)

Notes

This formatoption only has an effect for stream plots

See also

arrowsize, linewidth, density, color

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

dependencies = ['plot']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'vector'

str. Key of the group name in groups of this formatoption keyword

name = 'Style of the arrows'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

class psy_simple.plotters.AxisColor(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psyplot.plotter.DictFormatoption

Color the x- and y-axes

This formatoption colors the left, right, bottom and top axis bar.

Possible types

dict – Keys may be one of {‘right’, ‘left’, ‘bottom’, ‘top’}, the values can be any valid color or None.

Notes

The following color abbreviations are supported:

character	color
‘b’	blue
‘g’	green
‘r’	red
‘c’	cyan
‘m’	magenta
‘y’	yellow
‘k’	black
‘w’	white

In addition, you can specify colors in many weird and wonderful ways, including full names ('green'), hex strings ('#008000'), RGB or RGBA tuples ((0,1,0,1)) or grayscale intensities as a string ('0.8').

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

group	str.
name	str.
value2pickle	Return the current axis colors

Methods:

initialize_plot(value)	Method that is called when the plot is made the first time
update(value)	Method that is call to update the formatoption on the axes

group = 'axes'

str. Key of the group name in groups of this formatoption keyword

initialize_plot(value)

Method that is called when the plot is made the first time

Parameters

value – The value to use for the initialization

name = 'Color of x- and y-axes'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

property value2pickle

Return the current axis colors

class psy_simple.plotters.BarAlpha(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psyplot.plotter.Formatoption

Specify the transparency (alpha)

Possible types

float – A value between 0 (opaque) and 1 invisible

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

name	str.
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

name = 'Transparency of the bars'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

class psy_simple.plotters.BarPlot(*args, **kwargs)

Bases: psyplot.plotter.Formatoption

Choose how to make the bar plot

Possible types

• None – Don’t make any plotting

• ‘bar’ – Create a usual bar plot with the bars side-by-side

• ‘stacked’ – Create stacked plot

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

alpha	alpha Formatoption instance in the plotter
categorical	categorical Formatoption instance in the plotter
children	list of str.
color	color Formatoption instance in the plotter
data_dependent	bool or a callable.
dependencies	list of str.
group	str.
name	str.
plot_fmt	bool.
plotted_data	The data that is shown to the user
priority	int.
transpose	transpose Formatoption instance in the plotter
widths	widths Formatoption instance in the plotter

Methods:

get_xys(arr)
make_plot()
remove()	Method to remove the effects of this formatoption
update(value)	Method that is call to update the formatoption on the axes

property alpha

alpha Formatoption instance in the plotter

property categorical

categorical Formatoption instance in the plotter

children = ['color', 'transpose', 'alpha']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

property color

color Formatoption instance in the plotter

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

dependencies = ['widths', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

get_xys(arr)

group = 'plotting'

str. Key of the group name in groups of this formatoption keyword

make_plot()

name = 'Bar plot type'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

plot_fmt = True

bool. Has to be True if the formatoption has a make_plot method to make the plot.

property plotted_data

The data that is shown to the user

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

remove()

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

property widths

widths Formatoption instance in the plotter

class psy_simple.plotters.BarPlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: psy_simple.plotters.SimplePlotterBase

Plotter for making bar plots

Parameters

• data (InteractiveArray or ArrayList, optional) – Data object that shall be visualized. If given and plot is True, the initialize_plot() method is called at the end. Otherwise you can call this method later by yourself

• ax (matplotlib.axes.Axes) – Matplotlib Axes to plot on. If None, a new one will be created as soon as the initialize_plot() method is called

• auto_update (bool) – Default: None. A boolean indicating whether this list shall automatically update the contained arrays when calling the update() method or not. See also the no_auto_update attribute. If None, the value from the 'lists.auto_update' key in the psyplot.rcParams dictionary is used.

• draw (bool or None) – Boolean to control whether the figure of this array shall be drawn at the end. If None, it defaults to the ‘auto_draw’` parameter in the psyplot.rcParams dictionary

• make_plot (bool) – If True, and data is not None, the plot is initialized. Otherwise only the framework between plotter and data is set up

• clear (bool) – If True, the axes is cleared first

• enable_post (bool) – If True, the post formatoption is enabled and post processing scripts are allowed

• **kwargs – Any formatoption key from the formatoptions attribute that shall be used

Miscallaneous formatoptions:

alpha	Specify the transparency (alpha)
categorical	The location of each bar
legend	Draw a legend
legendlabels	Set the labels of the arrays in the legend
sym_lims	Make x- and y-axis symmetric
ticksize	Change the ticksize of the ticklabels
tickweight	Change the fontweight of the ticks
widths	Specify the widths of the bars

Axes formatoptions:

axiscolor	Color the x- and y-axes
background	The background color for the matplotlib axes.
grid	Display the grid
tight	Automatically adjust the plots.
transpose	Switch x- and y-axes
xlim	Set the x-axis limits
ylim	Set the y-axis limits

Color coding formatoptions:

color

Set the color coding

Data manipulation formatoptions:

coord

Use an alternative variable as x-coordinate

Label formatoptions:

figtitle	Plot a figure title
figtitleprops	Properties of the figure title
figtitlesize	Set the size of the figure title
figtitleweight	Set the fontweight of the figure title
labelprops	Set the font properties of both, x- and y-label
labelsize	Set the size of both, x- and y-label
labelweight	Set the font size of both, x- and y-label
text	Add text anywhere on the plot
title	Show the title
titleprops	Properties of the title
titlesize	Set the size of the title
titleweight	Set the fontweight of the title
xlabel	Set the x-axis label
ylabel	Set the y-axis label

Masking formatoptions:

mask	Mask the data where a certain condition is True
maskbetween	Mask data points between two numbers
maskgeq	Mask data points greater than or equal to a number
maskgreater	Mask data points greater than a number
maskleq	Mask data points smaller than or equal to a number
maskless	Mask data points smaller than a number

Plot formatoptions:

plot	Choose how to make the bar plot

Post processing formatoptions:

post	Apply your own postprocessing script
post_timing	Determine when to run the post formatoption

Axis tick formatoptions:

xrotation	Rotate the x-axis ticks
xticklabels	Modify the x-axis ticklabels
xtickprops	Specify the x-axis tick parameters
xticks	Modify the x-axis ticks
yrotation	Rotate the y-axis ticks
yticklabels	Modify the y-axis ticklabels
ytickprops	Specify the y-axis tick parameters
yticks	Modify the y-axis ticks

alpha

Specify the transparency (alpha)

Possible types

float – A value between 0 (opaque) and 1 invisible

axiscolor

Color the x- and y-axes

This formatoption colors the left, right, bottom and top axis bar.

Possible types

dict – Keys may be one of {‘right’, ‘left’, ‘bottom’, ‘top’}, the values can be any valid color or None.

Notes

The following color abbreviations are supported:

character	color
‘b’	blue
‘g’	green
‘r’	red
‘c’	cyan
‘m’	magenta
‘y’	yellow
‘k’	black
‘w’	white

In addition, you can specify colors in many weird and wonderful ways, including full names ('green'), hex strings ('#008000'), RGB or RGBA tuples ((0,1,0,1)) or grayscale intensities as a string ('0.8').

background

The background color for the matplotlib axes.

Possible types

• ‘rc’ – to use matplotlibs rc params

• None – to use a transparent color

• color – Any possible matplotlib color

categorical

The location of each bar

Possible types

• None – If None, use a categorical plotting if the widths are 'equal', otherwise, not

• bool – If True, use a categorical plotting

See also

widths

color

Set the color coding

This formatoptions sets the color of the lines, bars, etc.

Possible types

• None – to use the axes color_cycle

• iterable – (e.g. list) to specify the colors manually

• str – Strings may be any valid colormap name suitable for the matplotlib.cm.get_cmap() function or one of the color lists defined in the ‘colors.cmaps’ key of the psyplot.rcParams dictionary (including their reversed color maps given via the ‘_r’ extension).

• matplotlib.colors.ColorMap – to automatically choose the colors according to the number of lines, etc. from the given colormap

coord

Use an alternative variable as x-coordinate

This formatoption let’s you specify another variable in the base dataset of the data array in case you want to use this as the x-coordinate instead of the raw data

Possible types

• None – Use the default

• str – The name of the variable to use in the base dataset

• xarray.DataArray – An alternative variable with the same shape as the displayed array

Examples

To see the difference, we create a simple test dataset:

>>> import xarray as xr

>>> import numpy as np

>>> import psyplot.project as psy

>>> ds = xr.Dataset({
...     'temp': xr.Variable(('time', ), np.arange(5)),
...     'std': xr.Variable(('time', ), np.arange(5, 10))})
>>> ds
<xarray.Dataset>
Dimensions:  (time: 5)
Coordinates:
  * time     (time) int64 0 1 2 3 4
Data variables:
    temp     (time) int64 0 1 2 3 4
    std      (time) int64 5 6 7 8 9

If we create a plot with it, we get the 'time' dimension on the x-axis:

>>> plotter = psy.plot.lineplot(ds, name=['temp']).plotters[0]

>>> plotter.plot_data[0].dims
('time',)

If we however set the 'coord' keyword, we get:

>>> plotter = psy.plot.lineplot(
...     ds, name=['temp'], coord='std').plotters[0]

>>> plotter.plot_data[0].dims
('std',)

and 'std' is plotted on the x-axis.

figtitle

Plot a figure title

Set the title of the figure. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The title for the suptitle() function

Notes

• If the plotter is part of a psyplot.project.Project and multiple plotters of this project are on the same figure, the replacement attributes (see above) are joined by a delimiter. If the delimiter attribute of this Figtitle instance is not None, it will be used. Otherwise the rcParams[‘texts.delimiter’] item is used.

• This is the title of the whole figure! For the title of this specific subplot, see the title formatoption.

See also

title, figtitlesize, figtitleweight, figtitleprops

figtitleprops

Properties of the figure title

Specify the font properties of the figure title manually.

Possible types

dict – Items may be any valid text property

See also

figtitle, figtitlesize, figtitleweight

figtitlesize

Set the size of the figure title

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

figtitle, figtitleweight, figtitleprops

figtitleweight

Set the fontweight of the figure title

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

figtitle, figtitlesize, figtitleprops

grid

Display the grid

Show the grid on the plot with the specified color.

Possible types

• None – If the grid is currently shown, it will not be displayed any longer. If the grid is not shown, it will be drawn

• bool – If True, the grid is displayed with the automatic settings (usually black)

• string, tuple. – Defines the color of the grid.

Notes

The following color abbreviations are supported:

character	color
‘b’	blue
‘g’	green
‘r’	red
‘c’	cyan
‘m’	magenta
‘y’	yellow
‘k’	black
‘w’	white

In addition, you can specify colors in many weird and wonderful ways, including full names ('green'), hex strings ('#008000'), RGB or RGBA tuples ((0,1,0,1)) or grayscale intensities as a string ('0.8').

labelprops

Set the font properties of both, x- and y-label

Possible types

• dict – A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

• dict – Items may be any valid text property

See also

xlabel, ylabel, labelsize, labelweight

labelsize

Set the size of both, x- and y-label

Possible types

• dict – A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

xlabel, ylabel, labelweight, labelprops

labelweight

Set the font size of both, x- and y-label

Possible types

• dict – A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

xlabel, ylabel, labelsize, labelprops

legend

Draw a legend

This formatoption determines where and if to draw the legend. It uses the labels formatoption to determine the labels.

Possible types

• bool – Draw a legend or not

• str or int – Specifies where to plot the legend (i.e. the location)

• dict – Give the keywords for the matplotlib.pyplot.legend() function

See also

labels

legendlabels

Set the labels of the arrays in the legend

This formatoption specifies the labels for each array in the legend. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

• str – A single string that shall be used for all arrays.

• list of str – Same as a single string but specified for each array

See also

legend

mask

Mask the data where a certain condition is True

This formatoption can be used to mask the plotting data based on another array. This array can be the name of a variable in the base dataset, or it can be a numeric array. Note that the data needs to be on exactly the same coordinates as the data shown here

Possible types

• None – Apply no mask

• str – The name of a variable in the base dataset to use.

  • dimensions that are in the given mask but not in the visualized base variable will be aggregated using numpy.any()

  • if the given mask misses dimensions that are in the visualized data (i.e. the data of this plotter), we broadcast the mask to match the shape of the data

  • dimensions that are in mask and the base variable, but not in the visualized data will be matched against each other

• str – The path to a netCDF file that shall be loaded

• xr.DataArray or np.ndarray – An array that can be broadcasted to the shape of the data

maskbetween

Mask data points between two numbers

Possible types

float – The floating number to mask above

See also

maskless, maskleq, maskgreater, maskgeq

maskgeq

Mask data points greater than or equal to a number

Possible types

float – The floating number to mask above

See also

maskless, maskleq, maskgreater, maskbetween

maskgreater

Mask data points greater than a number

Possible types

float – The floating number to mask above

See also

maskless, maskleq, maskgeq, maskbetween

maskleq

Mask data points smaller than or equal to a number

Possible types

float – The floating number to mask below

See also

maskless, maskgreater, maskgeq, maskbetween

maskless

Mask data points smaller than a number

Possible types

float – The floating number to mask below

See also

maskleq, maskgreater, maskgeq, maskbetween

plot

Choose how to make the bar plot

Possible types

• None – Don’t make any plotting

• ‘bar’ – Create a usual bar plot with the bars side-by-side

• ‘stacked’ – Create stacked plot

post

Apply your own postprocessing script

This formatoption let’s you apply your own post processing script. Just enter the script as a string and it will be executed. The formatoption will be made available via the self variable

Possible types

• None – Don’t do anything

• str – The post processing script as string

Note

This formatoption uses the built-in exec() function to compile the script. Since this poses a security risk when loading psyplot projects, it is by default disabled through the Plotter.enable_post attribute. If you are sure that you can trust the script in this formatoption, set this attribute of the corresponding Plotter to True

Examples

Assume, you want to manually add the mean of the data to the title of the matplotlib axes. You can simply do this via

from psyplot.plotter import Plotter
from xarray import DataArray
plotter = Plotter(DataArray([1, 2, 3]))
# enable the post formatoption
plotter.enable_post = True
plotter.update(post="self.ax.set_title(str(self.data.mean()))")
plotter.ax.get_title()
'2.0'

By default, the post formatoption is only ran, when it is explicitly updated. However, you can use the post_timing formatoption, to run it automatically. E.g. for running it after every update of the plotter, you can set

plotter.update(post_timing='always')

See also

post_timing

Determine the timing of this formatoption

post_timing

Determine when to run the post formatoption

This formatoption determines, whether the post formatoption should be run never, after replot or after every update.

Possible types

• ‘never’ – Never run post processing scripts

• ‘always’ – Always run post processing scripts

• ‘replot’ – Only run post processing scripts when the data changes or a replot is necessary

See also

post

The post processing formatoption

sym_lims

Make x- and y-axis symmetric

Possible types

• None – No symmetric type

• ‘min’ – Use the minimum of x- and y-limits

• ‘max’ – Use the maximum of x- and y-limits

• [str, str] – A combination, None, 'min' and 'max' specific for minimum and maximum limit

text

Add text anywhere on the plot

This formatoption draws a text on the specified position on the figure. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

• str – If string s: this will be used as (1., 1., s, {‘ha’: ‘right’}) (i.e. a string in the upper right corner of the axes).

• tuple or list of tuples (x,y,s[,coord.-system][,options]]) – Each tuple defines a text instance on the plot. 0<=x, y<=1 are the coordinates. The coord.-system can be either the data coordinates (default, 'data') or the axes coordinates ('axes') or the figure coordinates (‘fig’). The string s finally is the text. options may be a dictionary to specify format the appearence (e.g. 'color', 'fontweight', 'fontsize', etc., see matplotlib.text.Text for possible keys). To remove one single text from the plot, set (x,y,’’[, coord.-system]) for the text at position (x,y)

• empty list – remove all texts from the plot

See also

title, figtitle

ticksize

Change the ticksize of the ticklabels

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

tickweight, xtickprops, ytickprops

tickweight

Change the fontweight of the ticks

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

ticksize, xtickprops, ytickprops

tight

Automatically adjust the plots.

If set to True, the plots are automatically adjusted to fit to the figure limitations via the matplotlib.pyplot.tight_layout() function.

Possible types

bool – True for automatic adjustment

Warning

There is no update method to undo what happend after this formatoption is set to True!

title

Show the title

Set the title of the plot. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The title for the title() function.

Notes

This is the title of this specific subplot! For the title of the whole figure, see the figtitle formatoption.

See also

figtitle, titlesize, titleweight, titleprops

titleprops

Properties of the title

Specify the font properties of the figure title manually.

Possible types

dict – Items may be any valid text property

See also

title, titlesize, titleweight

titlesize

Set the size of the title

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

title, titleweight, titleprops

titleweight

Set the fontweight of the title

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

title, titlesize, titleprops

transpose

Switch x- and y-axes

By default, one-dimensional arrays have the dimension on the x-axis and two dimensional arrays have the first dimension on the y and the second on the x-axis. You can set this formatoption to True to change this behaviour

Possible types

bool – If True, axes are switched

widths

Specify the widths of the bars

Possible types

• ‘equal’ – Each bar will have the same width (the default)

• ‘data’ – Each bar will have the width as specified by the boundaries

• float – The width for each bar

See also

categorical

xlabel

Set the x-axis label

Set the label for the x-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The text for the xlabel() function.

See also

xlabelsize, xlabelweight, xlabelprops

xlim

Set the x-axis limits

Possible types

• None – To not change the current limits

• str or list [str, str] or [[str, float], [str, float]] – Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

  rounded

  Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the limits are chosen such that they are symmetric around zero

  minmax

  Uses the minimum and maximum

  sym

  Same as minmax but symmetric around zero

• tuple (xmin, xmax) – xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

ylim

xrotation

Rotate the x-axis ticks

Possible types

float – The rotation angle in degrees

See also

yrotation

xticklabels

Modify the x-axis ticklabels

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• str – A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

• array – An array of strings to use for the ticklabels

See also

xticks, ticksize, tickweight, xtickprops, yticklabels

xtickprops

Specify the x-axis tick parameters

This formatoption can be used to make a detailed change of the ticks parameters on the x-axis.

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• dict – Items may be anything of the matplotlib.pyplot.tick_params() function

See also

xticks, yticks, ticksize, tickweight, ytickprops

xticks

Modify the x-axis ticks

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• None – use the default ticks

• int – for an integer i, only every i-th tick of the default ticks are used

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

  hour

  draw ticks every hour

  day

  draw ticks every day

  week

  draw ticks every week

  month, monthend, monthbegin

  draw ticks in the middle, at the end or at the beginning of each month

  year, yearend, yearbegin

  draw ticks in the middle, at the end or at the beginning of each year

  For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

Examples

Plot 11 ticks over the whole data range:

>>> plotter.update(xticks='rounded')

Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

>>> plotter.update(xticks=['minmax', 7])

Plot ticks every year and minor ticks every month:

>>> plotter.update(xticks={'major': 'year', 'minor': 'month'})

See also

xticklabels, ticksize, tickweight, xtickprops, yticks

ylabel

Set the y-axis label

Set the label for the y-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The text for the ylabel() function.

See also

ylabelsize, ylabelweight, ylabelprops

ylim

Set the y-axis limits

Possible types

• None – To not change the current limits

• str or list [str, str] or [[str, float], [str, float]] – Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

  rounded

  Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the limits are chosen such that they are symmetric around zero

  minmax

  Uses the minimum and maximum

  sym

  Same as minmax but symmetric around zero

• tuple (xmin, xmax) – xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

xlim

yrotation

Rotate the y-axis ticks

Possible types

float – The rotation angle in degrees

See also

xrotation

yticklabels

Modify the y-axis ticklabels

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• str – A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

• array – An array of strings to use for the ticklabels

See also

yticks, ticksize, tickweight, ytickprops, xticklabels

ytickprops

Specify the y-axis tick parameters

This formatoption can be used to make a detailed change of the ticks parameters of the y-axis.

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• dict – Items may be anything of the matplotlib.pyplot.tick_params() function

See also

xticks, yticks, ticksize, tickweight, xtickprops

yticks

Modify the y-axis ticks

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• None – use the default ticks

• int – for an integer i, only every i-th tick of the default ticks are used

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

  hour

  draw ticks every hour

  day

  draw ticks every day

  week

  draw ticks every week

  month, monthend, monthbegin

  draw ticks in the middle, at the end or at the beginning of each month

  year, yearend, yearbegin

  draw ticks in the middle, at the end or at the beginning of each year

  For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

See also

yticklabels, ticksize, tickweight, ytickprops

xticks

for possible examples

class psy_simple.plotters.BarWidths(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psyplot.plotter.Formatoption

Specify the widths of the bars

Possible types

• ‘equal’ – Each bar will have the same width (the default)

• ‘data’ – Each bar will have the width as specified by the boundaries

• float – The width for each bar

See also

categorical

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

name	str.
priority	int.

Methods:

update(value)

Method that is call to update the formatoption on the axes

name = 'Width of the bars'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

class psy_simple.plotters.BarXTickLabels(*args, **kwargs)

Bases: psy_simple.plotters.XTickLabels

Modify the x-axis ticklabels

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• str – A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

• array – An array of strings to use for the ticklabels

See also

xticks, ticksize, tickweight, xtickprops, yticklabels

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

categorical	categorical Formatoption instance in the plotter
dependencies	list of str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xticks	xticks Formatoption instance in the plotter
yticklabels	yticklabels Formatoption instance in the plotter

Methods:

set_stringformatter(s)

property categorical

categorical Formatoption instance in the plotter

dependencies = ['transpose', 'xticks', 'yticklabels', 'plot', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

set_stringformatter(s)

property transpose

transpose Formatoption instance in the plotter

property xticks

xticks Formatoption instance in the plotter

property yticklabels

yticklabels Formatoption instance in the plotter

class psy_simple.plotters.BarXTicks(*args, **kwargs)

Bases: psy_simple.plotters.XTicks

Modify the x-axis ticks

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• None – use the default ticks

• int – for an integer i, only every i-th tick of the default ticks are used

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

  hour

  draw ticks every hour

  day

  draw ticks every day

  week

  draw ticks every week

  month, monthend, monthbegin

  draw ticks in the middle, at the end or at the beginning of each month

  year, yearend, yearbegin

  draw ticks in the middle, at the end or at the beginning of each year

  For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

Examples

Plot 11 ticks over the whole data range:

>>> plotter.update(xticks='rounded')

Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

>>> plotter.update(xticks=['minmax', 7])

Plot ticks every year and minor ticks every month:

>>> plotter.update(xticks={'major': 'year', 'minor': 'month'})

See also

xticklabels, ticksize, tickweight, xtickprops, yticks

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

array	The numpy array of the data
categorical	categorical Formatoption instance in the plotter
connections	list of str.
dependencies	list of str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xlim	xlim Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

Methods:

set_default_locators()	Sets the default locator that is used for updating to None or int
update(value)	Method that is call to update the formatoption on the axes

property array

The numpy array of the data

property categorical

categorical Formatoption instance in the plotter

connections = ['xlim']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

dependencies = ['transpose', 'plot', 'plot', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

set_default_locators()

Sets the default locator that is used for updating to None or int

Parameters

which ({None, 'minor', 'major'}) – Specify which locator shall be set

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

property xlim

xlim Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.BarXlabel(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psy_simple.plotters.Xlabel

Set the x-axis label

Set the label for the x-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The text for the xlabel() function.

See also

xlabelsize, xlabelweight, xlabelprops

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

transpose	transpose Formatoption instance in the plotter
update_after_plot	Xlabel is modified by the pandas plot routine, therefore we update it after each plot
ylabel	ylabel Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

update_after_plot = True

Xlabel is modified by the pandas plot routine, therefore we update it after each plot

property ylabel

ylabel Formatoption instance in the plotter

class psy_simple.plotters.BarXlim(*args, **kwargs)

Bases: psy_simple.plotters.ViolinXlim

Set the x-axis limits

Possible types

• None – To not change the current limits

• str or list [str, str] or [[str, float], [str, float]] – Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

  rounded

  Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the limits are chosen such that they are symmetric around zero

  minmax

  Uses the minimum and maximum

  sym

  Same as minmax but symmetric around zero

• tuple (xmin, xmax) – xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

ylim

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

array	The numpy array of the data
categorical	categorical Formatoption instance in the plotter
dependencies	list of str.
plot	plot Formatoption instance in the plotter
sym_lims	sym_lims Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xticks	xticks Formatoption instance in the plotter
ylim	ylim Formatoption instance in the plotter

property array

The numpy array of the data

property categorical

categorical Formatoption instance in the plotter

dependencies = ['xticks', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

property sym_lims

sym_lims Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property xticks

xticks Formatoption instance in the plotter

property ylim

ylim Formatoption instance in the plotter

class psy_simple.plotters.BarYTickLabels(*args, **kwargs)

Bases: psy_simple.plotters.YTickLabels

Modify the y-axis ticklabels

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• str – A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

• array – An array of strings to use for the ticklabels

See also

yticks, ticksize, tickweight, ytickprops, xticklabels

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

categorical	categorical Formatoption instance in the plotter
dependencies	list of str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

Methods:

set_stringformatter(s)

property categorical

categorical Formatoption instance in the plotter

dependencies = ['transpose', 'yticks', 'plot', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

set_stringformatter(s)

property transpose

transpose Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.BarYTicks(*args, **kwargs)

Bases: psy_simple.plotters.YTicks

Modify the y-axis ticks

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• None – use the default ticks

• int – for an integer i, only every i-th tick of the default ticks are used

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

  hour

  draw ticks every hour

  day

  draw ticks every day

  week

  draw ticks every week

  month, monthend, monthbegin

  draw ticks in the middle, at the end or at the beginning of each month

  year, yearend, yearbegin

  draw ticks in the middle, at the end or at the beginning of each year

  For data, mid, hour, day, week, month, etc., the optional second value can be an integer i determining that every i-th data point shall be used (by default, it is set to 1). For rounded, roundedsym, minmax and sym, the second value determines the total number of ticks (defaults to 11).

See also

yticklabels, ticksize, tickweight, ytickprops

xticks

for possible examples

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

array	The numpy array of the data
categorical	categorical Formatoption instance in the plotter
connections	list of str.
dependencies	list of str.
plot	plot Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
ylim	ylim Formatoption instance in the plotter

Methods:

set_default_locators()	Sets the default locator that is used for updating to None or int
update(value)	Method that is call to update the formatoption on the axes

property array

The numpy array of the data

property categorical

categorical Formatoption instance in the plotter

connections = ['ylim']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

dependencies = ['transpose', 'plot', 'plot', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

set_default_locators()

Sets the default locator that is used for updating to None or int

Parameters

which ({None, 'minor', 'major'}) – Specify which locator shall be set

property transpose

transpose Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

property ylim

ylim Formatoption instance in the plotter

class psy_simple.plotters.BarYlabel(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psy_simple.plotters.Ylabel

Set the y-axis label

Set the label for the y-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The text for the ylabel() function.

See also

ylabelsize, ylabelweight, ylabelprops

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

transpose	transpose Formatoption instance in the plotter
update_after_plot	Ylabel is modified by the pandas plot routine, therefore we update it after each plot

property transpose

transpose Formatoption instance in the plotter

update_after_plot = True

Ylabel is modified by the pandas plot routine, therefore we update it after each plot

class psy_simple.plotters.BarYlim(*args, **kwargs)

Bases: psy_simple.plotters.ViolinYlim

Set the y-axis limits

Possible types

• None – To not change the current limits

• str or list [str, str] or [[str, float], [str, float]] – Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

  rounded

  Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the limits are chosen such that they are symmetric around zero

  minmax

  Uses the minimum and maximum

  sym

  Same as minmax but symmetric around zero

• tuple (xmin, xmax) – xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

xlim

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

array	The numpy array of the data
categorical	categorical Formatoption instance in the plotter
dependencies	list of str.
plot	plot Formatoption instance in the plotter
sym_lims	sym_lims Formatoption instance in the plotter
transpose	transpose Formatoption instance in the plotter
xlim	xlim Formatoption instance in the plotter
yticks	yticks Formatoption instance in the plotter

property array

The numpy array of the data

property categorical

categorical Formatoption instance in the plotter

dependencies = ['yticks', 'categorical']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

property sym_lims

sym_lims Formatoption instance in the plotter

property transpose

transpose Formatoption instance in the plotter

property xlim

xlim Formatoption instance in the plotter

property yticks

yticks Formatoption instance in the plotter

class psy_simple.plotters.Base2D(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: psyplot.plotter.Plotter

Base plotter for 2-dimensional plots

Parameters

• data (InteractiveArray or ArrayList, optional) – Data object that shall be visualized. If given and plot is True, the initialize_plot() method is called at the end. Otherwise you can call this method later by yourself

• ax (matplotlib.axes.Axes) – Matplotlib Axes to plot on. If None, a new one will be created as soon as the initialize_plot() method is called

• auto_update (bool) – Default: None. A boolean indicating whether this list shall automatically update the contained arrays when calling the update() method or not. See also the no_auto_update attribute. If None, the value from the 'lists.auto_update' key in the psyplot.rcParams dictionary is used.

• draw (bool or None) – Boolean to control whether the figure of this array shall be drawn at the end. If None, it defaults to the ‘auto_draw’` parameter in the psyplot.rcParams dictionary

• make_plot (bool) – If True, and data is not None, the plot is initialized. Otherwise only the framework between plotter and data is set up

• clear (bool) – If True, the axes is cleared first

• enable_post (bool) – If True, the post formatoption is enabled and post processing scripts are allowed

• **kwargs – Any formatoption key from the formatoptions attribute that shall be used

Color coding formatoptions:

bounds	Specify the boundaries of the colorbar
cbar	Specify the position of the colorbars
cbarspacing	Specify the spacing of the bounds in the colorbar
cmap	Specify the color map
ctickprops	Specify the font properties of the colorbar ticklabels
cticksize	Specify the font size of the colorbar ticklabels
ctickweight	Specify the fontweight of the colorbar ticklabels
extend	Draw arrows at the side of the colorbar

Label formatoptions:

clabel	Show the colorbar label
clabelprops	Properties of the Colorbar label
clabelsize	Set the size of the Colorbar label
clabelweight	Set the fontweight of the Colorbar label

Axis tick formatoptions:

cticklabels	Specify the colorbar ticklabels
cticks	Specify the tick locations of the colorbar

Miscallaneous formatoptions:

datagrid	Show the grid of the data
mask_datagrid	Mask the datagrid where the array is NaN

Attributes:

plot

Post processing formatoptions:

post	Apply your own postprocessing script
post_timing	Determine when to run the post formatoption

bounds

Specify the boundaries of the colorbar

Possible types

• None – make no normalization

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

• int – Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

• matplotlib.colors.Normalize – A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

cbar

Specify the position of the colorbars

Possible types

• bool – True: defaults to ‘b’ False: Don’t draw any colorbar

• str – The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

  • ‘b’, ‘r’ stand for bottom and right of the axes

  • ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

  • ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

• list – A containing one of the above positions

Examples

Draw a colorbar at the bottom and left of the axes:

>>> plotter.update(cbar='bl')

cbarspacing

Specify the spacing of the bounds in the colorbar

Possible types

str {‘uniform’, ‘proportional’} – if 'uniform', every color has exactly the same width in the colorbar, if 'proportional', the size is chosen according to the data

clabel

Show the colorbar label

Set the label of the colorbar. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The title for the set_label() method.

See also

clabelsize, clabelweight, clabelprops

clabelprops

Properties of the Colorbar label

Specify the font properties of the figure title manually.

Possible types

dict – Items may be any valid text property

See also

clabel, clabelsize, clabelweight

clabelsize

Set the size of the Colorbar label

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

clabel, clabelweight, clabelprops

clabelweight

Set the fontweight of the Colorbar label

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

clabel, clabelsize, clabelprops

cmap

Specify the color map

This formatoption specifies the color coding of the data via a matplotlib.colors.Colormap

Possible types

• str – Strings may be any valid colormap name suitable for the matplotlib.cm.get_cmap() function or one of the color lists defined in the ‘colors.cmaps’ key of the psyplot.rcParams dictionary (including their reversed color maps given via the ‘_r’ extension).

• matplotlib.colors.Colormap – The colormap instance to use

See also

bounds

specifies the boundaries of the colormap

cticklabels

Specify the colorbar ticklabels

Possible types

• str – A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

• array – An array of strings to use for the ticklabels

See also

cticks, cticksize, ctickweight, ctickprops, vcticks, vcticksize, vctickweight, vctickprops

ctickprops

Specify the font properties of the colorbar ticklabels

Possible types

dict – Items may be anything of the matplotlib.pyplot.tick_params() function

See also

cticksize, ctickweight, cticklabels, cticks, vcticksize, vctickweight, vcticklabels, vcticks

cticks

Specify the tick locations of the colorbar

Possible types

• None – use the default ticks

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

  bounds

  let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

  midbounds

  Same as bounds but in the middle between two bounds

• int – Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels

cticksize

Specify the font size of the colorbar ticklabels

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

ctickweight, ctickprops, cticklabels, cticks, vctickweight, vctickprops, vcticklabels, vcticks

ctickweight

Specify the fontweight of the colorbar ticklabels

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

cticksize, ctickprops, cticklabels, cticks, vcticksize, vctickprops, vcticklabels, vcticks

datagrid

Show the grid of the data

This formatoption shows the grid of the data (without labels)

Possible types

• None – Don’t show the data grid

• str – A linestyle in the form 'k-', where 'k' is the color and '-' the linestyle.

• dict – any keyword arguments that are passed to the plotting function ( matplotlib.pyplot.triplot() for unstructured grids and matplotlib.pyplot.hlines() for rectilinear grids)

See also

mask_datagrid

To display cells with NaN

extend

Draw arrows at the side of the colorbar

Possible types

str {‘neither’, ‘both’, ‘min’ or ‘max’} – If not ‘neither’, make pointed end(s) for out-of-range values

mask_datagrid

Mask the datagrid where the array is NaN

This boolean formatoption enables to mask the grid of the datagrid formatoption where the data is NaN

Possible types

bool – Either True, to not display the data grid for cells with NaN, or False

See also

datagrid

plot = None

post

Apply your own postprocessing script

This formatoption let’s you apply your own post processing script. Just enter the script as a string and it will be executed. The formatoption will be made available via the self variable

Possible types

• None – Don’t do anything

• str – The post processing script as string

Note

This formatoption uses the built-in exec() function to compile the script. Since this poses a security risk when loading psyplot projects, it is by default disabled through the Plotter.enable_post attribute. If you are sure that you can trust the script in this formatoption, set this attribute of the corresponding Plotter to True

Examples

Assume, you want to manually add the mean of the data to the title of the matplotlib axes. You can simply do this via

from psyplot.plotter import Plotter
from xarray import DataArray
plotter = Plotter(DataArray([1, 2, 3]))
# enable the post formatoption
plotter.enable_post = True
plotter.update(post="self.ax.set_title(str(self.data.mean()))")
plotter.ax.get_title()
'2.0'

By default, the post formatoption is only ran, when it is explicitly updated. However, you can use the post_timing formatoption, to run it automatically. E.g. for running it after every update of the plotter, you can set

plotter.update(post_timing='always')

See also

post_timing

Determine the timing of this formatoption

post_timing

Determine when to run the post formatoption

This formatoption determines, whether the post formatoption should be run never, after replot or after every update.

Possible types

• ‘never’ – Never run post processing scripts

• ‘always’ – Always run post processing scripts

• ‘replot’ – Only run post processing scripts when the data changes or a replot is necessary

See also

post

The post processing formatoption

class psy_simple.plotters.BaseVectorPlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: psy_simple.plotters.Base2D

Base plotter for vector plots

Parameters

• data (InteractiveArray or ArrayList, optional) – Data object that shall be visualized. If given and plot is True, the initialize_plot() method is called at the end. Otherwise you can call this method later by yourself

• ax (matplotlib.axes.Axes) – Matplotlib Axes to plot on. If None, a new one will be created as soon as the initialize_plot() method is called

• auto_update (bool) – Default: None. A boolean indicating whether this list shall automatically update the contained arrays when calling the update() method or not. See also the no_auto_update attribute. If None, the value from the 'lists.auto_update' key in the psyplot.rcParams dictionary is used.

• draw (bool or None) – Boolean to control whether the figure of this array shall be drawn at the end. If None, it defaults to the ‘auto_draw’` parameter in the psyplot.rcParams dictionary

• make_plot (bool) – If True, and data is not None, the plot is initialized. Otherwise only the framework between plotter and data is set up

• clear (bool) – If True, the axes is cleared first

• enable_post (bool) – If True, the post formatoption is enabled and post processing scripts are allowed

• **kwargs – Any formatoption key from the formatoptions attribute that shall be used

Attributes:

allowed_dims

Vector plot formatoptions:

arrowsize	Change the size of the arrows
arrowstyle	Change the style of the arrows
density	Change the density of the arrows

Color coding formatoptions:

bounds	Specify the boundaries of the vector colorbar
cbar	Specify the position of the vector plot colorbars
cbarspacing	Specify the spacing of the bounds in the colorbar
cmap	Specify the color map
color	Set the color for the arrows
ctickprops	Specify the font properties of the colorbar ticklabels
cticksize	Specify the font size of the colorbar ticklabels
ctickweight	Specify the fontweight of the colorbar ticklabels
extend	Draw arrows at the side of the colorbar

Methods:

check_data(name, dims, is_unstructured)

A validation method for the data shape

Label formatoptions:

clabel	Show the colorbar label
clabelprops	Properties of the Colorbar label
clabelsize	Set the size of the Colorbar label
clabelweight	Set the fontweight of the Colorbar label

Axis tick formatoptions:

cticklabels	Specify the colorbar ticklabels
cticks	Specify the tick locations of the vector colorbar

Miscallaneous formatoptions:

datagrid
linewidth	Change the linewidth of the arrows
mask_datagrid	Mask the datagrid where the array is NaN

Post processing formatoptions:

post	Apply your own postprocessing script
post_timing	Determine when to run the post formatoption

allowed_dims = 3

arrowsize

Change the size of the arrows

Possible types

• None – make no scaling

• float – Factor scaling the size of the arrows

See also

arrowstyle, linewidth, density, color

arrowstyle

Change the style of the arrows

Possible types

str – Any arrow style string (see FancyArrowPatch)

Notes

This formatoption only has an effect for stream plots

See also

arrowsize, linewidth, density, color

bounds

Specify the boundaries of the vector colorbar

Possible types

• None – make no normalization

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

• int – Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

• matplotlib.colors.Normalize – A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

cbar

Specify the position of the vector plot colorbars

Possible types

• bool – True: defaults to ‘b’ False: Don’t draw any colorbar

• str – The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

  • ‘b’, ‘r’ stand for bottom and right of the axes

  • ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

  • ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

• list – A containing one of the above positions

cbarspacing

Specify the spacing of the bounds in the colorbar

Possible types

str {‘uniform’, ‘proportional’} – if 'uniform', every color has exactly the same width in the colorbar, if 'proportional', the size is chosen according to the data

classmethod check_data(name, dims, is_unstructured)

A validation method for the data shape

Parameters

• name (str or list of str) – The variable names (two variables for the array or one if the dims are one greater)

• dims (list with length 1 or list of lists with length 1) – The dimension of the arrays. Only 2D-Arrays are allowed (or 1-D if the array is unstructured)

• is_unstructured (bool or list of bool) – True if the corresponding array is unstructured.

Returns

• list of bool or None – True, if everything is okay, False in case of a serious error, None if it is intermediate. Each object in this list corresponds to one in the given name

• list of str – The message giving more information on the reason. Each object in this list corresponds to one in the given name

clabel

Show the colorbar label

Set the label of the colorbar. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The title for the set_label() method.

See also

clabelsize, clabelweight, clabelprops

clabelprops

Properties of the Colorbar label

Specify the font properties of the figure title manually.

Possible types

dict – Items may be any valid text property

See also

clabel, clabelsize, clabelweight

clabelsize

Set the size of the Colorbar label

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

clabel, clabelweight, clabelprops

clabelweight

Set the fontweight of the Colorbar label

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

clabel, clabelsize, clabelprops

cmap

Specify the color map

This formatoption specifies the color coding of the data via a matplotlib.colors.Colormap

Possible types

• str – Strings may be any valid colormap name suitable for the matplotlib.cm.get_cmap() function or one of the color lists defined in the ‘colors.cmaps’ key of the psyplot.rcParams dictionary (including their reversed color maps given via the ‘_r’ extension).

• matplotlib.colors.Colormap – The colormap instance to use

See also

bounds

specifies the boundaries of the colormap

color

Set the color for the arrows

This formatoption can be used to set a single color for the vectors or define the color coding

Possible types

• float – Determines the greyness

• color – Defines the same color for all arrows. The string can be either a html hex string (e.g. ‘#eeefff’), a single letter (e.g. ‘b’: blue, ‘g’: green, ‘r’: red, ‘c’: cyan, ‘m’: magenta, ‘y’: yellow, ‘k’: black, ‘w’: white) or any other color

• string {‘absolute’, ‘u’, ‘v’} – Strings may define how the formatoption is calculated. Possible strings are

  • absolute: for the absolute wind speed

  • u: for the u component

  • v: for the v component

• 2D-array – The values determine the color for each plotted arrow. Note that the shape has to match the one of u and v.

See also

arrowsize, arrowstyle, density, linewidth

cticklabels

Specify the colorbar ticklabels

Possible types

• str – A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

• array – An array of strings to use for the ticklabels

See also

cticks, cticksize, ctickweight, ctickprops, vcticks, vcticksize, vctickweight, vctickprops

ctickprops

Specify the font properties of the colorbar ticklabels

Possible types

dict – Items may be anything of the matplotlib.pyplot.tick_params() function

See also

cticksize, ctickweight, cticklabels, cticks, vcticksize, vctickweight, vcticklabels, vcticks

cticks

Specify the tick locations of the vector colorbar

Possible types

• None – use the default ticks

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

  bounds

  let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

  midbounds

  Same as bounds but in the middle between two bounds

• int – Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels, vcticklabels

cticksize

Specify the font size of the colorbar ticklabels

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

ctickweight, ctickprops, cticklabels, cticks, vctickweight, vctickprops, vcticklabels, vcticks

ctickweight

Specify the fontweight of the colorbar ticklabels

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

cticksize, ctickprops, cticklabels, cticks, vcticksize, vctickprops, vcticklabels, vcticks

datagrid

density

Change the density of the arrows

Possible types

• float – Scales the density of the arrows in x- and y-direction (1.0 means no scaling)

• tuple (x, y) – Defines the scaling in x- and y-direction manually

Notes

quiver plots do not support density scaling

extend

Draw arrows at the side of the colorbar

Possible types

str {‘neither’, ‘both’, ‘min’ or ‘max’} – If not ‘neither’, make pointed end(s) for out-of-range values

linewidth

Change the linewidth of the arrows

Possible types

• float – give the linewidth explicitly

• string {‘absolute’, ‘u’, ‘v’} – Strings may define how the formatoption is calculated. Possible strings are

  • absolute: for the absolute wind speed

  • u: for the u component

  • v: for the v component

• tuple (string, float) – string may be one of the above strings, float may be a scaling factor

• 2D-array – The values determine the linewidth for each plotted arrow. Note that the shape has to match the one of u and v.

See also

arrowsize, arrowstyle, density, color

mask_datagrid

Mask the datagrid where the array is NaN

This boolean formatoption enables to mask the grid of the datagrid formatoption where the data is NaN

Possible types

bool – Either True, to not display the data grid for cells with NaN, or False

See also

datagrid

post

Apply your own postprocessing script

This formatoption let’s you apply your own post processing script. Just enter the script as a string and it will be executed. The formatoption will be made available via the self variable

Possible types

• None – Don’t do anything

• str – The post processing script as string

Note

This formatoption uses the built-in exec() function to compile the script. Since this poses a security risk when loading psyplot projects, it is by default disabled through the Plotter.enable_post attribute. If you are sure that you can trust the script in this formatoption, set this attribute of the corresponding Plotter to True

Examples

Assume, you want to manually add the mean of the data to the title of the matplotlib axes. You can simply do this via

from psyplot.plotter import Plotter
from xarray import DataArray
plotter = Plotter(DataArray([1, 2, 3]))
# enable the post formatoption
plotter.enable_post = True
plotter.update(post="self.ax.set_title(str(self.data.mean()))")
plotter.ax.get_title()
'2.0'

By default, the post formatoption is only ran, when it is explicitly updated. However, you can use the post_timing formatoption, to run it automatically. E.g. for running it after every update of the plotter, you can set

plotter.update(post_timing='always')

See also

post_timing

Determine the timing of this formatoption

post_timing

Determine when to run the post formatoption

This formatoption determines, whether the post formatoption should be run never, after replot or after every update.

Possible types

• ‘never’ – Never run post processing scripts

• ‘always’ – Always run post processing scripts

• ‘replot’ – Only run post processing scripts when the data changes or a replot is necessary

See also

post

The post processing formatoption

class psy_simple.plotters.Bounds(*args, **kwargs)

Bases: psy_simple.plotters.DataTicksCalculator

Specify the boundaries of the colorbar

Possible types

• None – make no normalization

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

• int – Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

• matplotlib.colors.Normalize – A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

cbar	cbar Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
connections	list of str.
group	str.
name	str.
priority	int.
value2share	The normalization instance

Methods:

get_fmt_widget(parent, project)	Open a psy_simple.widget.CMapFmtWidget
update(value)	Method that is call to update the formatoption on the axes

property cbar

cbar Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

connections = ['cmap', 'cbar']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

get_fmt_widget(parent, project)

Open a psy_simple.widget.CMapFmtWidget

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Boundaries of the color map'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

property value2share

The normalization instance

class psy_simple.plotters.CLabel(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psy_simple.base.TextBase, psyplot.plotter.Formatoption

Show the colorbar label

Set the label of the colorbar. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The title for the set_label() method.

See also

clabelsize, clabelweight, clabelprops

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

axis_locations
cbar	cbar Formatoption instance in the plotter
children	list of str.
data_dependent	bool or a callable.
dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter

Methods:

update(value)

Method that is call to update the formatoption on the axes

axis_locations = {'b': 'x', 'fb': 'x', 'fl': 'y', 'fr': 'y', 'ft': 'x', 'l': 'y', 'r': 'y', 'sh': 'x', 'sv': 'y', 't': 'x'}

property cbar

cbar Formatoption instance in the plotter

children = ['plot']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

data_dependent = True

bool or a callable. This attribute indicates whether this Formatoption depends on the data and should be updated if the data changes. If it is a callable, it must accept one argument: the new data. (Note: This is automatically set to True for plot formatoptions)

dependencies = ['cbar']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'labels'

str. Key of the group name in groups of this formatoption keyword

name = 'Colorbar label'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

class psy_simple.plotters.CMap(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psyplot.plotter.Formatoption

Specify the color map

This formatoption specifies the color coding of the data via a matplotlib.colors.Colormap

Possible types

• str – Strings may be any valid colormap name suitable for the matplotlib.cm.get_cmap() function or one of the color lists defined in the ‘colors.cmaps’ key of the psyplot.rcParams dictionary (including their reversed color maps given via the ‘_r’ extension).

• matplotlib.colors.Colormap – The colormap instance to use

See also

bounds

specifies the boundaries of the colormap

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

bounds	bounds Formatoption instance in the plotter
cbar	cbar Formatoption instance in the plotter
connections	list of str.
group	str.
name	str.
priority	int.

Methods:

get_cmap([arr, cmap, N])	Get the matplotlib.colors.Colormap for plotting
get_fmt_widget(parent, project)	Open a psy_simple.widget.CMapFmtWidget
update(value)	Method that is call to update the formatoption on the axes

property bounds

bounds Formatoption instance in the plotter

property cbar

cbar Formatoption instance in the plotter

connections = ['bounds', 'cbar']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

get_cmap(arr=None, cmap=None, N=None)

Get the matplotlib.colors.Colormap for plotting

Parameters

• arr (np.ndarray) – The array to plot

• cmap (str or matplotlib.colors.Colormap) – The colormap to use. If None, the value of this formatoption is used

• N (int) – The number of colors in the colormap. If None, the norm of the bounds formatoption is used and, if necessary, the given array arr

Returns

The colormap returned by psy_simple.colors.get_cmap()

Return type

matplotlib.colors.Colormap

get_fmt_widget(parent, project)

Open a psy_simple.widget.CMapFmtWidget

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Colormap'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

class psy_simple.plotters.CTickLabels(*args, **kwargs)

Bases: psy_simple.plotters.CbarOptions, psy_simple.plotters.TickLabelsBase

Specify the colorbar ticklabels

Possible types

• str – A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

• array – An array of strings to use for the ticklabels

See also

cticks, cticksize, ctickweight, ctickprops, vcticks, vcticksize, vctickweight, vctickprops

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

cbar	cbar Formatoption instance in the plotter
default_formatters	Default locator of the axis of the colorbars
name	str.
plot	plot Formatoption instance in the plotter

Methods:

set_default_formatters()	Sets the default formatters that is used for updating to None
set_formatter(formatter)	Sets a given formatter

property cbar

cbar Formatoption instance in the plotter

property default_formatters

Default locator of the axis of the colorbars

name = 'Colorbar ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

set_default_formatters()

Sets the default formatters that is used for updating to None

set_formatter(formatter)

Sets a given formatter

class psy_simple.plotters.CTickProps(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psy_simple.plotters.CbarOptions, psy_simple.plotters.TickPropsBase

Specify the font properties of the colorbar ticklabels

Possible types

dict – Items may be anything of the matplotlib.pyplot.tick_params() function

See also

cticksize, ctickweight, cticklabels, cticks, vcticksize, vctickweight, vcticklabels, vcticks

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

cbar	cbar Formatoption instance in the plotter
children	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter

Methods:

update_axis(value)

property cbar

cbar Formatoption instance in the plotter

children = ['plot']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Font properties of the colorbar ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

update_axis(value)

class psy_simple.plotters.CTickSize(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psy_simple.plotters.CbarOptions, psy_simple.plotters.TickSizeBase

Specify the font size of the colorbar ticklabels

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

ctickweight, ctickprops, cticklabels, cticks, vctickweight, vctickprops, vcticklabels, vcticks

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

cbar	cbar Formatoption instance in the plotter
ctickprops	ctickprops Formatoption instance in the plotter
dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter

property cbar

cbar Formatoption instance in the plotter

property ctickprops

ctickprops Formatoption instance in the plotter

dependencies = ['cbar', 'ctickprops']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Font size of the colorbar ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

class psy_simple.plotters.CTickWeight(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psy_simple.plotters.CbarOptions, psy_simple.plotters.TickWeightBase

Specify the fontweight of the colorbar ticklabels

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

cticksize, ctickprops, cticklabels, cticks, vcticksize, vctickprops, vcticklabels, vcticks

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

cbar	cbar Formatoption instance in the plotter
ctickprops	ctickprops Formatoption instance in the plotter
dependencies	list of str.
group	str.
name	str.
plot	plot Formatoption instance in the plotter

property cbar

cbar Formatoption instance in the plotter

property ctickprops

ctickprops Formatoption instance in the plotter

dependencies = ['cbar', 'ctickprops']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Font weight of the colorbar ticklabels'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

class psy_simple.plotters.CTicks(*args, **kwargs)

Bases: psy_simple.plotters.CbarOptions, psy_simple.plotters.TicksBase

Specify the tick locations of the colorbar

Possible types

• None – use the default ticks

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

  bounds

  let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

  midbounds

  Same as bounds but in the middle between two bounds

• int – Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

bounds	bounds Formatoption instance in the plotter
cbar	cbar Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
connections	list of str.
default_locator	Default locator of the axis of the colorbars
dependencies	list of str.
name	str.
plot	plot Formatoption instance in the plotter

Methods:

get_fmt_widget(parent, project)	Open a psy_simple.widget.CMapFmtWidget
set_default_locators(*args, **kwargs)	Sets the default locator that is used for updating to None or int
set_ticks(value)
update(value)	Method that is call to update the formatoption on the axes
update_axis(value)

property bounds

bounds Formatoption instance in the plotter

property cbar

cbar Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

connections = ['cmap']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

property default_locator

Default locator of the axis of the colorbars

dependencies = ['cbar', 'bounds']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

get_fmt_widget(parent, project)

Open a psy_simple.widget.CMapFmtWidget

name = 'Colorbar ticks'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

property plot

plot Formatoption instance in the plotter

set_default_locators(*args, **kwargs)

Sets the default locator that is used for updating to None or int

Parameters

which ({None, 'minor', 'major'}) – Specify which locator shall be set

set_ticks(value)

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

update_axis(value)

class psy_simple.plotters.CategoricalBars(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psyplot.plotter.Formatoption

The location of each bar

Possible types

• None – If None, use a categorical plotting if the widths are 'equal', otherwise, not

• bool – If True, use a categorical plotting

See also

widths

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

dependencies	list of str.
name	str.
priority	int.
widths	widths Formatoption instance in the plotter

Methods:

update(value)

Method that is call to update the formatoption on the axes

dependencies = ['widths']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

name = 'Categorical or non-categorical plotting'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

priority = 20

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

property widths

widths Formatoption instance in the plotter

class psy_simple.plotters.Cbar(*args, **kwargs)

Bases: psyplot.plotter.Formatoption

Specify the position of the colorbars

Possible types

• bool – True: defaults to ‘b’ False: Don’t draw any colorbar

• str – The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

  • ‘b’, ‘r’ stand for bottom and right of the axes

  • ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

  • ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

• list – A containing one of the above positions

Examples

Draw a colorbar at the bottom and left of the axes:

>>> plotter.update(cbar='bl')

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

• other_cbars (list of str) – List of other colorbar formatoption keys (necessary for a sufficient resizing of the axes)

Attributes:

bounds	bounds Formatoption instance in the plotter
cbarspacing	cbarspacing Formatoption instance in the plotter
cmap	cmap Formatoption instance in the plotter
dependencies	list of str.
extend	extend Formatoption instance in the plotter
figure_positions
group	str.
init_kwargs	dict key word arguments that are passed to the initialization of a new instance when accessed from the descriptor
levels	levels Formatoption instance in the plotter
name	str.
original_position
plot	plot Formatoption instance in the plotter
priority	int.
value2share	Those colorbar positions that are directly at the axes

Methods:

draw_colorbar(pos)
finish_update()	Finish the update, initialization and sharing process
initialize_plot(value)	Method that is called when the plot is made the first time
remove([positions])	Method to remove the effects of this formatoption
set_label_pos(pos)
update(value)	Updates the colorbar
update_colorbar(pos)

property bounds

bounds Formatoption instance in the plotter

property cbarspacing

cbarspacing Formatoption instance in the plotter

property cmap

cmap Formatoption instance in the plotter

dependencies = ['plot', 'cmap', 'bounds', 'extend', 'cbarspacing', 'levels']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

draw_colorbar(pos)

property extend

extend Formatoption instance in the plotter

figure_positions = {'b', 'fb', 'fl', 'fr', 'ft', 'l', 'r', 't'}

finish_update()

Finish the update, initialization and sharing process

This function is called at the end of the Plotter.start_update(), Plotter.initialize_plot() or the Plotter.share() methods.

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

property init_kwargs

dict key word arguments that are passed to the initialization of a new instance when accessed from the descriptor

initialize_plot(value)

Method that is called when the plot is made the first time

Parameters

value – The value to use for the initialization

property levels

levels Formatoption instance in the plotter

name = 'Position of the colorbar'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

original_position = None

property plot

plot Formatoption instance in the plotter

priority = 10.1

int. Priority value of the the formatoption determining when the formatoption is updated.

• 10: at the end (for labels, etc.)

• 20: before the plotting (e.g. for colormaps, etc.)

• 30: before loading the data (e.g. for lonlatbox)

remove(positions='all')

Method to remove the effects of this formatoption

This method is called when the axes is cleared due to a formatoption with requires_clearing set to True. You don’t necessarily have to implement this formatoption if your plot results are removed by the usual matplotlib.axes.Axes.clear() method.

set_label_pos(pos)

update(value)

Updates the colorbar

Parameters

• value – The value to update (see possible types)

• no_fig_cbars – Does not update the colorbars that are not in the axes of this plot

update_colorbar(pos)

property value2share

Those colorbar positions that are directly at the axes

class psy_simple.plotters.CbarOptions(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psyplot.plotter.Formatoption

Base class for colorbar formatoptions

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

axis	axis of the colorbar with the ticks.
axis_locations
axisname
cbar	cbar Formatoption instance in the plotter
children	list of str.
colorbar
data	The data that is plotted
dependencies	list of str.
plot	plot Formatoption instance in the plotter
which

Methods:

update(value)

Method that is call to update the formatoption on the axes

property axis

axis of the colorbar with the ticks. Will be overwritten during update process.

axis_locations = {'b': 'x', 'fb': 'x', 'fl': 'y', 'fr': 'y', 'ft': 'x', 'l': 'y', 'r': 'y', 'sh': 'x', 'sv': 'y', 't': 'x'}

property axisname

property cbar

cbar Formatoption instance in the plotter

children = ['plot']

list of str. List of formatoptions that have to be updated before this one is updated. Those formatoptions are only updated if they exist in the update parameters.

property colorbar

property data

The data that is plotted

dependencies = ['cbar']

list of str. List of formatoptions that force an update of this formatoption if they are updated.

property plot

plot Formatoption instance in the plotter

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

which = 'major'

class psy_simple.plotters.CbarSpacing(key, plotter=None, index_in_list=None, additional_children=[], additional_dependencies=[], **kwargs)

Bases: psyplot.plotter.Formatoption

Specify the spacing of the bounds in the colorbar

Possible types

str {‘uniform’, ‘proportional’} – if 'uniform', every color has exactly the same width in the colorbar, if 'proportional', the size is chosen according to the data

Parameters

• key (str) – formatoption key in the plotter

• plotter (psyplot.plotter.Plotter) – Plotter instance that holds this formatoption. If None, it is assumed that this instance serves as a descriptor.

• index_in_list (int or None) – The index that shall be used if the data is a psyplot.InteractiveList

• additional_children (list or str) – Additional children to use (see the children attribute)

• additional_dependencies (list or str) – Additional dependencies to use (see the dependencies attribute)

• **kwargs – Further keywords may be used to specify different names for children, dependencies and connection formatoptions that match the setup of the plotter. Hence, keywords may be anything of the children, dependencies and connections attributes, with values being the name of the new formatoption in this plotter.

Attributes:

cbar	cbar Formatoption instance in the plotter
connections	list of str.
group	str.
name	str.

Methods:

update(value)

Method that is call to update the formatoption on the axes

property cbar

cbar Formatoption instance in the plotter

connections = ['cbar']

list of str. Connections to other formatoptions that are (different from dependencies and children) not important for the update process

group = 'colors'

str. Key of the group name in groups of this formatoption keyword

name = 'Spacing of the colorbar'

str. A bit more verbose name than the formatoption key to be included in the gui. If None, the key is used in the gui

update(value)

Method that is call to update the formatoption on the axes

Parameters

value – Value to update

class psy_simple.plotters.CombinedBase(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: psy_simple.plotters.ScalarCombinedBase

Base plotter for combined 2-dimensional scalar and vector plot

Parameters

• data (InteractiveArray or ArrayList, optional) – Data object that shall be visualized. If given and plot is True, the initialize_plot() method is called at the end. Otherwise you can call this method later by yourself

• ax (matplotlib.axes.Axes) – Matplotlib Axes to plot on. If None, a new one will be created as soon as the initialize_plot() method is called

• auto_update (bool) – Default: None. A boolean indicating whether this list shall automatically update the contained arrays when calling the update() method or not. See also the no_auto_update attribute. If None, the value from the 'lists.auto_update' key in the psyplot.rcParams dictionary is used.

• draw (bool or None) – Boolean to control whether the figure of this array shall be drawn at the end. If None, it defaults to the ‘auto_draw’` parameter in the psyplot.rcParams dictionary

• make_plot (bool) – If True, and data is not None, the plot is initialized. Otherwise only the framework between plotter and data is set up

• clear (bool) – If True, the axes is cleared first

• enable_post (bool) – If True, the post formatoption is enabled and post processing scripts are allowed

• **kwargs – Any formatoption key from the formatoptions attribute that shall be used

Vector plot formatoptions:

arrowsize	Change the size of the arrows
arrowstyle	Change the style of the arrows

Color coding formatoptions:

bounds	Specify the boundaries of the colorbar
cbar	Specify the position of the colorbars
color	Set the color for the arrows
vbounds	Specify the boundaries of the vector colorbar
vcbar	Specify the position of the vector plot colorbars
vcbarspacing	Specify the spacing of the bounds in the colorbar
vcmap	Specify the color map
vctickprops	Specify the font properties of the colorbar ticklabels
vcticksize	Specify the font size of the colorbar ticklabels
vctickweight	Specify the fontweight of the colorbar ticklabels

Methods:

check_data(name, dims, is_unstructured)

A validation method for the data shape

Axis tick formatoptions:

cticks	Specify the tick locations of the colorbar
vcticklabels	Specify the colorbar ticklabels
vcticks	Specify the tick locations of the vector colorbar

Miscallaneous formatoptions:

linewidth

Change the linewidth of the arrows

Masking formatoptions:

maskbetween	Mask data points between two numbers
maskgeq	Mask data points greater than or equal to a number
maskgreater	Mask data points greater than a number
maskleq	Mask data points smaller than or equal to a number
maskless	Mask data points smaller than a number

Post processing formatoptions:

post	Apply your own postprocessing script
post_timing	Determine when to run the post formatoption

Label formatoptions:

vclabel	Show the colorbar label of the vector plot
vclabelprops	Properties of the Vector colorbar label
vclabelsize	Set the size of the Vector colorbar label
vclabelweight	Set the fontweight of the Vector colorbar label

arrowsize

Change the size of the arrows

Possible types

• None – make no scaling

• float – Factor scaling the size of the arrows

See also

arrowstyle, linewidth, density, color

arrowstyle

Change the style of the arrows

Possible types

str – Any arrow style string (see FancyArrowPatch)

Notes

This formatoption only has an effect for stream plots

See also

arrowsize, linewidth, density, color

bounds

Specify the boundaries of the colorbar

Possible types

• None – make no normalization

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

• int – Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

• matplotlib.colors.Normalize – A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

cbar

Specify the position of the colorbars

Possible types

• bool – True: defaults to ‘b’ False: Don’t draw any colorbar

• str – The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

  • ‘b’, ‘r’ stand for bottom and right of the axes

  • ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

  • ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

• list – A containing one of the above positions

Examples

Draw a colorbar at the bottom and left of the axes:

>>> plotter.update(cbar='bl')

classmethod check_data(name, dims, is_unstructured)

A validation method for the data shape

Parameters

• name (list of str with length 2) – The variable names (one for the first, two for the second array)

• dims (list with length 2 of lists with length 1) – The dimension of the arrays. Only 2D-Arrays are allowed (or 1-D if an array is unstructured)

• is_unstructured (bool or list of bool) – True if the corresponding array is unstructured.

Returns

• list of bool or None – True, if everything is okay, False in case of a serious error, None if it is intermediate. Each object in this list corresponds to one in the given name

• list of str – The message giving more information on the reason. Each object in this list corresponds to one in the given name

color

Set the color for the arrows

This formatoption can be used to set a single color for the vectors or define the color coding

Possible types

• float – Determines the greyness

• color – Defines the same color for all arrows. The string can be either a html hex string (e.g. ‘#eeefff’), a single letter (e.g. ‘b’: blue, ‘g’: green, ‘r’: red, ‘c’: cyan, ‘m’: magenta, ‘y’: yellow, ‘k’: black, ‘w’: white) or any other color

• string {‘absolute’, ‘u’, ‘v’} – Strings may define how the formatoption is calculated. Possible strings are

  • absolute: for the absolute wind speed

  • u: for the u component

  • v: for the v component

• 2D-array – The values determine the color for each plotted arrow. Note that the shape has to match the one of u and v.

See also

arrowsize, arrowstyle, density, linewidth

cticks

Specify the tick locations of the colorbar

Possible types

• None – use the default ticks

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

  bounds

  let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

  midbounds

  Same as bounds but in the middle between two bounds

• int – Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels

linewidth

Change the linewidth of the arrows

Possible types

• float – give the linewidth explicitly

• string {‘absolute’, ‘u’, ‘v’} – Strings may define how the formatoption is calculated. Possible strings are

  • absolute: for the absolute wind speed

  • u: for the u component

  • v: for the v component

• tuple (string, float) – string may be one of the above strings, float may be a scaling factor

• 2D-array – The values determine the linewidth for each plotted arrow. Note that the shape has to match the one of u and v.

See also

arrowsize, arrowstyle, density, color

maskbetween

Mask data points between two numbers

Possible types

float – The floating number to mask above

See also

maskless, maskleq, maskgreater, maskgeq

maskgeq

Mask data points greater than or equal to a number

Possible types

float – The floating number to mask above

See also

maskless, maskleq, maskgreater, maskbetween

maskgreater

Mask data points greater than a number

Possible types

float – The floating number to mask above

See also

maskless, maskleq, maskgeq, maskbetween

maskleq

Mask data points smaller than or equal to a number

Possible types

float – The floating number to mask below

See also

maskless, maskgreater, maskgeq, maskbetween

maskless

Mask data points smaller than a number

Possible types

float – The floating number to mask below

See also

maskleq, maskgreater, maskgeq, maskbetween

post

Apply your own postprocessing script

This formatoption let’s you apply your own post processing script. Just enter the script as a string and it will be executed. The formatoption will be made available via the self variable

Possible types

• None – Don’t do anything

• str – The post processing script as string

Note

This formatoption uses the built-in exec() function to compile the script. Since this poses a security risk when loading psyplot projects, it is by default disabled through the Plotter.enable_post attribute. If you are sure that you can trust the script in this formatoption, set this attribute of the corresponding Plotter to True

Examples

Assume, you want to manually add the mean of the data to the title of the matplotlib axes. You can simply do this via

from psyplot.plotter import Plotter
from xarray import DataArray
plotter = Plotter(DataArray([1, 2, 3]))
# enable the post formatoption
plotter.enable_post = True
plotter.update(post="self.ax.set_title(str(self.data.mean()))")
plotter.ax.get_title()
'2.0'

By default, the post formatoption is only ran, when it is explicitly updated. However, you can use the post_timing formatoption, to run it automatically. E.g. for running it after every update of the plotter, you can set

plotter.update(post_timing='always')

See also

post_timing

Determine the timing of this formatoption

post_timing

Determine when to run the post formatoption

This formatoption determines, whether the post formatoption should be run never, after replot or after every update.

Possible types

• ‘never’ – Never run post processing scripts

• ‘always’ – Always run post processing scripts

• ‘replot’ – Only run post processing scripts when the data changes or a replot is necessary

See also

post

The post processing formatoption

vbounds

Specify the boundaries of the vector colorbar

Possible types

• None – make no normalization

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

• int – Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

• matplotlib.colors.Normalize – A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

vcbar

Specify the position of the vector plot colorbars

Possible types

• bool – True: defaults to ‘b’ False: Don’t draw any colorbar

• str – The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

  • ‘b’, ‘r’ stand for bottom and right of the axes

  • ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

  • ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

• list – A containing one of the above positions

vcbarspacing

Specify the spacing of the bounds in the colorbar

Possible types

str {‘uniform’, ‘proportional’} – if 'uniform', every color has exactly the same width in the colorbar, if 'proportional', the size is chosen according to the data

vclabel

Show the colorbar label of the vector plot

Set the label of the colorbar. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The title for the set_label() method.

See also

vclabelsize, vclabelweight, vclabelprops

vclabelprops

Properties of the Vector colorbar label

Specify the font properties of the figure title manually.

Possible types

dict – Items may be any valid text property

See also

vclabel, vclabelsize, vclabelweight

vclabelsize

Set the size of the Vector colorbar label

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

vclabel, vclabelweight, vclabelprops

vclabelweight

Set the fontweight of the Vector colorbar label

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

vclabel, vclabelsize, vclabelprops

vcmap

Specify the color map

This formatoption specifies the color coding of the data via a matplotlib.colors.Colormap

Possible types

• str – Strings may be any valid colormap name suitable for the matplotlib.cm.get_cmap() function or one of the color lists defined in the ‘colors.cmaps’ key of the psyplot.rcParams dictionary (including their reversed color maps given via the ‘_r’ extension).

• matplotlib.colors.Colormap – The colormap instance to use

See also

bounds

specifies the boundaries of the colormap

vcticklabels

Specify the colorbar ticklabels

Possible types

• str – A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

• array – An array of strings to use for the ticklabels

See also

cticks, cticksize, ctickweight, ctickprops, vcticks, vcticksize, vctickweight, vctickprops

vctickprops

Specify the font properties of the colorbar ticklabels

Possible types

dict – Items may be anything of the matplotlib.pyplot.tick_params() function

See also

cticksize, ctickweight, cticklabels, cticks, vcticksize, vctickweight, vcticklabels, vcticks

vcticks

Specify the tick locations of the vector colorbar

Possible types

• None – use the default ticks

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

  bounds

  let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

  midbounds

  Same as bounds but in the middle between two bounds

• int – Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels, vcticklabels

vcticksize

Specify the font size of the colorbar ticklabels

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

ctickweight, ctickprops, cticklabels, cticks, vctickweight, vctickprops, vcticklabels, vcticks

vctickweight

Specify the fontweight of the colorbar ticklabels

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

cticksize, ctickprops, cticklabels, cticks, vcticksize, vctickprops, vcticklabels, vcticks

class psy_simple.plotters.CombinedSimplePlotter(data=None, ax=None, auto_update=None, project=None, draw=False, make_plot=True, clear=False, enable_post=False, **kwargs)

Bases: psy_simple.plotters.CombinedBase, psy_simple.plotters.Simple2DPlotter, psy_simple.plotters.SimpleVectorPlotter

Combined 2D plotter and vector plotter

See also

psyplot.plotter.maps.CombinedPlotter

for visualizing the data on a map

Parameters

• data (InteractiveArray or ArrayList, optional) – Data object that shall be visualized. If given and plot is True, the initialize_plot() method is called at the end. Otherwise you can call this method later by yourself

• ax (matplotlib.axes.Axes) – Matplotlib Axes to plot on. If None, a new one will be created as soon as the initialize_plot() method is called

• auto_update (bool) – Default: None. A boolean indicating whether this list shall automatically update the contained arrays when calling the update() method or not. See also the no_auto_update attribute. If None, the value from the 'lists.auto_update' key in the psyplot.rcParams dictionary is used.

• draw (bool or None) – Boolean to control whether the figure of this array shall be drawn at the end. If None, it defaults to the ‘auto_draw’` parameter in the psyplot.rcParams dictionary

• make_plot (bool) – If True, and data is not None, the plot is initialized. Otherwise only the framework between plotter and data is set up

• clear (bool) – If True, the axes is cleared first

• enable_post (bool) – If True, the post formatoption is enabled and post processing scripts are allowed

• **kwargs – Any formatoption key from the formatoptions attribute that shall be used

Vector plot formatoptions:

arrowsize	Change the size of the arrows
arrowstyle	Change the style of the arrows
density	Change the density of the arrows

Axes formatoptions:

axiscolor	Color the x- and y-axes
background	The background color for the matplotlib axes.
grid	Display the grid
tight	Automatically adjust the plots.
transpose	Switch x- and y-axes
xlim	Set the x-axis limits
ylim	Set the y-axis limits

Color coding formatoptions:

bounds	Specify the boundaries of the colorbar
cbar	Specify the position of the colorbars
cbarspacing	Specify the spacing of the bounds in the colorbar
cmap	Specify the color map
color	Set the color for the arrows
ctickprops	Specify the font properties of the colorbar ticklabels
cticksize	Specify the font size of the colorbar ticklabels
ctickweight	Specify the fontweight of the colorbar ticklabels
extend	Draw arrows at the side of the colorbar
levels	The levels for the contour plot
miss_color	Set the color for missing values
vbounds	Specify the boundaries of the vector colorbar
vcbar	Specify the position of the vector plot colorbars
vcbarspacing	Specify the spacing of the bounds in the colorbar
vcmap	Specify the color map
vctickprops	Specify the font properties of the colorbar ticklabels
vcticksize	Specify the font size of the colorbar ticklabels
vctickweight	Specify the fontweight of the colorbar ticklabels

Label formatoptions:

clabel	Show the colorbar label
clabelprops	Properties of the Colorbar label
clabelsize	Set the size of the Colorbar label
clabelweight	Set the fontweight of the Colorbar label
figtitle	Plot a figure title
figtitleprops	Properties of the figure title
figtitlesize	Set the size of the figure title
figtitleweight	Set the fontweight of the figure title
labelprops	Set the font properties of both, x- and y-label
labelsize	Set the size of both, x- and y-label
labelweight	Set the font size of both, x- and y-label
text	Add text anywhere on the plot
title	Show the title
titleprops	Properties of the title
titlesize	Set the size of the title
titleweight	Set the fontweight of the title
vclabel	Show the colorbar label of the vector plot
vclabelprops	Properties of the Vector colorbar label
vclabelsize	Set the size of the Vector colorbar label
vclabelweight	Set the fontweight of the Vector colorbar label
xlabel	Set the x-axis label
ylabel	Set the y-axis label

Axis tick formatoptions:

cticklabels	Specify the colorbar ticklabels
cticks	Specify the tick locations of the colorbar
vcticklabels	Specify the colorbar ticklabels
vcticks	Specify the tick locations of the vector colorbar
xrotation	Rotate the x-axis ticks
xticklabels	Modify the x-axis ticklabels
xtickprops	Specify the x-axis tick parameters
xticks	Modify the x-axis ticks
yrotation	Rotate the y-axis ticks
yticklabels	Modify the y-axis ticklabels
ytickprops	Specify the y-axis tick parameters
yticks	Modify the y-axis ticks

Miscallaneous formatoptions:

datagrid
interp_bounds	Interpolate grid cell boundaries for 2D plots
linewidth	Change the linewidth of the arrows
mask_datagrid	Mask the datagrid where the array is NaN
sym_lims	Make x- and y-axis symmetric
ticksize	Change the ticksize of the ticklabels
tickweight	Change the fontweight of the ticks

Masking formatoptions:

mask	Mask the data where a certain condition is True
maskbetween	Mask data points between two numbers
maskgeq	Mask data points greater than or equal to a number
maskgreater	Mask data points greater than a number
maskleq	Mask data points smaller than or equal to a number
maskless	Mask data points smaller than a number

Plot formatoptions:

plot	Choose how to visualize a 2-dimensional scalar data field
vplot	Choose the vector plot type

Post processing formatoptions:

post	Apply your own postprocessing script
post_timing	Determine when to run the post formatoption

arrowsize

Change the size of the arrows

Possible types

• None – make no scaling

• float – Factor scaling the size of the arrows

See also

arrowstyle, linewidth, density, color

arrowstyle

Change the style of the arrows

Possible types

str – Any arrow style string (see FancyArrowPatch)

Notes

This formatoption only has an effect for stream plots

See also

arrowsize, linewidth, density, color

axiscolor

Color the x- and y-axes

This formatoption colors the left, right, bottom and top axis bar.

Possible types

dict – Keys may be one of {‘right’, ‘left’, ‘bottom’, ‘top’}, the values can be any valid color or None.

Notes

The following color abbreviations are supported:

character	color
‘b’	blue
‘g’	green
‘r’	red
‘c’	cyan
‘m’	magenta
‘y’	yellow
‘k’	black
‘w’	white

In addition, you can specify colors in many weird and wonderful ways, including full names ('green'), hex strings ('#008000'), RGB or RGBA tuples ((0,1,0,1)) or grayscale intensities as a string ('0.8').

background

The background color for the matplotlib axes.

Possible types

• ‘rc’ – to use matplotlibs rc params

• None – to use a transparent color

• color – Any possible matplotlib color

bounds

Specify the boundaries of the colorbar

Possible types

• None – make no normalization

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

• int – Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

• matplotlib.colors.Normalize – A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

cbar

Specify the position of the colorbars

Possible types

• bool – True: defaults to ‘b’ False: Don’t draw any colorbar

• str – The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

  • ‘b’, ‘r’ stand for bottom and right of the axes

  • ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

  • ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

• list – A containing one of the above positions

Examples

Draw a colorbar at the bottom and left of the axes:

>>> plotter.update(cbar='bl')

cbarspacing

Specify the spacing of the bounds in the colorbar

Possible types

str {‘uniform’, ‘proportional’} – if 'uniform', every color has exactly the same width in the colorbar, if 'proportional', the size is chosen according to the data

clabel

Show the colorbar label

Set the label of the colorbar. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The title for the set_label() method.

See also

clabelsize, clabelweight, clabelprops

clabelprops

Properties of the Colorbar label

Specify the font properties of the figure title manually.

Possible types

dict – Items may be any valid text property

See also

clabel, clabelsize, clabelweight

clabelsize

Set the size of the Colorbar label

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

clabel, clabelweight, clabelprops

clabelweight

Set the fontweight of the Colorbar label

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

clabel, clabelsize, clabelprops

cmap

Specify the color map

This formatoption specifies the color coding of the data via a matplotlib.colors.Colormap

Possible types

• str – Strings may be any valid colormap name suitable for the matplotlib.cm.get_cmap() function or one of the color lists defined in the ‘colors.cmaps’ key of the psyplot.rcParams dictionary (including their reversed color maps given via the ‘_r’ extension).

• matplotlib.colors.Colormap – The colormap instance to use

See also

bounds

specifies the boundaries of the colormap

color

Set the color for the arrows

This formatoption can be used to set a single color for the vectors or define the color coding

Possible types

• float – Determines the greyness

• color – Defines the same color for all arrows. The string can be either a html hex string (e.g. ‘#eeefff’), a single letter (e.g. ‘b’: blue, ‘g’: green, ‘r’: red, ‘c’: cyan, ‘m’: magenta, ‘y’: yellow, ‘k’: black, ‘w’: white) or any other color

• string {‘absolute’, ‘u’, ‘v’} – Strings may define how the formatoption is calculated. Possible strings are

  • absolute: for the absolute wind speed

  • u: for the u component

  • v: for the v component

• 2D-array – The values determine the color for each plotted arrow. Note that the shape has to match the one of u and v.

See also

arrowsize, arrowstyle, density, linewidth

cticklabels

Specify the colorbar ticklabels

Possible types

• str – A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

• array – An array of strings to use for the ticklabels

See also

cticks, cticksize, ctickweight, ctickprops, vcticks, vcticksize, vctickweight, vctickprops

ctickprops

Specify the font properties of the colorbar ticklabels

Possible types

dict – Items may be anything of the matplotlib.pyplot.tick_params() function

See also

cticksize, ctickweight, cticklabels, cticks, vcticksize, vctickweight, vcticklabels, vcticks

cticks

Specify the tick locations of the colorbar

Possible types

• None – use the default ticks

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

  bounds

  let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

  midbounds

  Same as bounds but in the middle between two bounds

• int – Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels

cticksize

Specify the font size of the colorbar ticklabels

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

ctickweight, ctickprops, cticklabels, cticks, vctickweight, vctickprops, vcticklabels, vcticks

ctickweight

Specify the fontweight of the colorbar ticklabels

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

cticksize, ctickprops, cticklabels, cticks, vcticksize, vctickprops, vcticklabels, vcticks

datagrid

density

Change the density of the arrows

Possible types

• float – Scales the density of the arrows in x- and y-direction (1.0 means no scaling)

• tuple (x, y) – Defines the scaling in x- and y-direction manually

Notes

quiver plots do not support density scaling

extend

Draw arrows at the side of the colorbar

Possible types

str {‘neither’, ‘both’, ‘min’ or ‘max’} – If not ‘neither’, make pointed end(s) for out-of-range values

figtitle

Plot a figure title

Set the title of the figure. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The title for the suptitle() function

Notes

• If the plotter is part of a psyplot.project.Project and multiple plotters of this project are on the same figure, the replacement attributes (see above) are joined by a delimiter. If the delimiter attribute of this Figtitle instance is not None, it will be used. Otherwise the rcParams[‘texts.delimiter’] item is used.

• This is the title of the whole figure! For the title of this specific subplot, see the title formatoption.

See also

title, figtitlesize, figtitleweight, figtitleprops

figtitleprops

Properties of the figure title

Specify the font properties of the figure title manually.

Possible types

dict – Items may be any valid text property

See also

figtitle, figtitlesize, figtitleweight

figtitlesize

Set the size of the figure title

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

figtitle, figtitleweight, figtitleprops

figtitleweight

Set the fontweight of the figure title

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

figtitle, figtitlesize, figtitleprops

grid

Display the grid

Show the grid on the plot with the specified color.

Possible types

• None – If the grid is currently shown, it will not be displayed any longer. If the grid is not shown, it will be drawn

• bool – If True, the grid is displayed with the automatic settings (usually black)

• string, tuple. – Defines the color of the grid.

Notes

The following color abbreviations are supported:

character	color
‘b’	blue
‘g’	green
‘r’	red
‘c’	cyan
‘m’	magenta
‘y’	yellow
‘k’	black
‘w’	white

In addition, you can specify colors in many weird and wonderful ways, including full names ('green'), hex strings ('#008000'), RGB or RGBA tuples ((0,1,0,1)) or grayscale intensities as a string ('0.8').

interp_bounds

Interpolate grid cell boundaries for 2D plots

This formatoption can be used to tell enable and disable the interpolation of grid cell boundaries. Usually, netCDF files only contain the centered coordinates. In this case, we interpolate the boundaries between the grid cell centers.

Possible types

• None – Interpolate the boundaries, except for circumpolar grids

• bool – If True (the default), the grid cell boundaries are inter- and extrapolated. Otherwise, if False, the coordinate centers are used and the default behaviour of matplotlib cuts of the most outer row and column of the 2D-data. Note that this results in a slight shift of the data

labelprops

Set the font properties of both, x- and y-label

Possible types

• dict – A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

• dict – Items may be any valid text property

See also

xlabel, ylabel, labelsize, labelweight

labelsize

Set the size of both, x- and y-label

Possible types

• dict – A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

xlabel, ylabel, labelweight, labelprops

labelweight

Set the font size of both, x- and y-label

Possible types

• dict – A dictionary with the keys 'x' and (or) 'y' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is used for the x- and y-axis. The values in the dictionary can be one types below.

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

xlabel, ylabel, labelsize, labelprops

levels

The levels for the contour plot

This formatoption sets the levels for the filled contour plot and only has an effect if the plot Formatoption is set to 'contourf'

Possible types

• None – Use the settings from the bounds formatoption and if this does not specify boundaries, use 11

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

• int – Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

linewidth

Change the linewidth of the arrows

Possible types

• float – give the linewidth explicitly

• string {‘absolute’, ‘u’, ‘v’} – Strings may define how the formatoption is calculated. Possible strings are

  • absolute: for the absolute wind speed

  • u: for the u component

  • v: for the v component

• tuple (string, float) – string may be one of the above strings, float may be a scaling factor

• 2D-array – The values determine the linewidth for each plotted arrow. Note that the shape has to match the one of u and v.

See also

arrowsize, arrowstyle, density, color

mask

Mask the data where a certain condition is True

This formatoption can be used to mask the plotting data based on another array. This array can be the name of a variable in the base dataset, or it can be a numeric array. Note that the data needs to be on exactly the same coordinates as the data shown here

Possible types

• None – Apply no mask

• str – The name of a variable in the base dataset to use.

  • dimensions that are in the given mask but not in the visualized base variable will be aggregated using numpy.any()

  • if the given mask misses dimensions that are in the visualized data (i.e. the data of this plotter), we broadcast the mask to match the shape of the data

  • dimensions that are in mask and the base variable, but not in the visualized data will be matched against each other

• str – The path to a netCDF file that shall be loaded

• xr.DataArray or np.ndarray – An array that can be broadcasted to the shape of the data

mask_datagrid

Mask the datagrid where the array is NaN

This boolean formatoption enables to mask the grid of the datagrid formatoption where the data is NaN

Possible types

bool – Either True, to not display the data grid for cells with NaN, or False

See also

datagrid

maskbetween

Mask data points between two numbers

Possible types

float – The floating number to mask above

See also

maskless, maskleq, maskgreater, maskgeq

maskgeq

Mask data points greater than or equal to a number

Possible types

float – The floating number to mask above

See also

maskless, maskleq, maskgreater, maskbetween

maskgreater

Mask data points greater than a number

Possible types

float – The floating number to mask above

See also

maskless, maskleq, maskgeq, maskbetween

maskleq

Mask data points smaller than or equal to a number

Possible types

float – The floating number to mask below

See also

maskless, maskgreater, maskgeq, maskbetween

maskless

Mask data points smaller than a number

Possible types

float – The floating number to mask below

See also

maskleq, maskgreater, maskgeq, maskbetween

miss_color

Set the color for missing values

Possible types

• None – Use the default from the colormap

• string, tuple. – Defines the color of the grid.

plot

Choose how to visualize a 2-dimensional scalar data field

Possible types

• None – Don’t make any plotting

• ‘mesh’ – Use the matplotlib.pyplot.pcolormesh() function to make the plot or the matplotlib.pyplot.tripcolor() for an unstructered grid

• ‘poly’ – Draw each polygon indivually. This method is used by default for unstructured grids. If there are no grid cell boundaries in the dataset, we will interpolate them

• ‘contourf’ – Make a filled contour plot using the matplotlib.pyplot.contourf() function. The levels for the contour plot are controlled by the levels formatoption

• ‘contour’ – Same a 'contourf', but does not make a filled contour plot, only lines.

post

Apply your own postprocessing script

This formatoption let’s you apply your own post processing script. Just enter the script as a string and it will be executed. The formatoption will be made available via the self variable

Possible types

• None – Don’t do anything

• str – The post processing script as string

Note

This formatoption uses the built-in exec() function to compile the script. Since this poses a security risk when loading psyplot projects, it is by default disabled through the Plotter.enable_post attribute. If you are sure that you can trust the script in this formatoption, set this attribute of the corresponding Plotter to True

Examples

Assume, you want to manually add the mean of the data to the title of the matplotlib axes. You can simply do this via

from psyplot.plotter import Plotter
from xarray import DataArray
plotter = Plotter(DataArray([1, 2, 3]))
# enable the post formatoption
plotter.enable_post = True
plotter.update(post="self.ax.set_title(str(self.data.mean()))")
plotter.ax.get_title()
'2.0'

By default, the post formatoption is only ran, when it is explicitly updated. However, you can use the post_timing formatoption, to run it automatically. E.g. for running it after every update of the plotter, you can set

plotter.update(post_timing='always')

See also

post_timing

Determine the timing of this formatoption

post_timing

Determine when to run the post formatoption

This formatoption determines, whether the post formatoption should be run never, after replot or after every update.

Possible types

• ‘never’ – Never run post processing scripts

• ‘always’ – Always run post processing scripts

• ‘replot’ – Only run post processing scripts when the data changes or a replot is necessary

See also

post

The post processing formatoption

sym_lims

Make x- and y-axis symmetric

Possible types

• None – No symmetric type

• ‘min’ – Use the minimum of x- and y-limits

• ‘max’ – Use the maximum of x- and y-limits

• [str, str] – A combination, None, 'min' and 'max' specific for minimum and maximum limit

text

Add text anywhere on the plot

This formatoption draws a text on the specified position on the figure. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

• str – If string s: this will be used as (1., 1., s, {‘ha’: ‘right’}) (i.e. a string in the upper right corner of the axes).

• tuple or list of tuples (x,y,s[,coord.-system][,options]]) – Each tuple defines a text instance on the plot. 0<=x, y<=1 are the coordinates. The coord.-system can be either the data coordinates (default, 'data') or the axes coordinates ('axes') or the figure coordinates (‘fig’). The string s finally is the text. options may be a dictionary to specify format the appearence (e.g. 'color', 'fontweight', 'fontsize', etc., see matplotlib.text.Text for possible keys). To remove one single text from the plot, set (x,y,’’[, coord.-system]) for the text at position (x,y)

• empty list – remove all texts from the plot

See also

title, figtitle

ticksize

Change the ticksize of the ticklabels

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

tickweight, xtickprops, ytickprops

tickweight

Change the fontweight of the ticks

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

ticksize, xtickprops, ytickprops

tight

Automatically adjust the plots.

If set to True, the plots are automatically adjusted to fit to the figure limitations via the matplotlib.pyplot.tight_layout() function.

Possible types

bool – True for automatic adjustment

Warning

There is no update method to undo what happend after this formatoption is set to True!

title

Show the title

Set the title of the plot. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The title for the title() function.

Notes

This is the title of this specific subplot! For the title of the whole figure, see the figtitle formatoption.

See also

figtitle, titlesize, titleweight, titleprops

titleprops

Properties of the title

Specify the font properties of the figure title manually.

Possible types

dict – Items may be any valid text property

See also

title, titlesize, titleweight

titlesize

Set the size of the title

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

title, titleweight, titleprops

titleweight

Set the fontweight of the title

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

title, titlesize, titleprops

transpose

Switch x- and y-axes

By default, one-dimensional arrays have the dimension on the x-axis and two dimensional arrays have the first dimension on the y and the second on the x-axis. You can set this formatoption to True to change this behaviour

Possible types

bool – If True, axes are switched

vbounds

Specify the boundaries of the vector colorbar

Possible types

• None – make no normalization

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

• int – Specifies how many ticks to use with the 'rounded' option. I.e. if integer i, then this is the same as ['rounded', i].

• matplotlib.colors.Normalize – A matplotlib normalization instance

Examples

• Plot 11 bounds over the whole data range:

  >>> plotter.update(bounds='rounded')
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded'})
  

• Plot 7 ticks over the whole data range where the maximal and minimal tick matches the data maximum and minimum:

  >>> plotter.update(bounds=['minmax', 7])
  

  which is equivaluent to:

  >>> plotter.update(bounds={'method': 'minmax', 'N': 7})
  

• chop the first and last five percentiles:

  >>> plotter.update(bounds=['rounded', None, 5, 95])
  

  which is equivalent to:

  >>> plotter.update(bounds={'method': 'rounded', 'percmin': 5,
  ...                        'percmax': 95})
  

• Plot 3 bounds per power of ten:

  >>> plotter.update(bounds=['log', 3])
  

• Plot continuous logarithmic bounds:

  >>> from matplotlib.colors import LogNorm
  >>> plotter.update(bounds=LogNorm())
  

See also

cmap

Specifies the colormap

vcbar

Specify the position of the vector plot colorbars

Possible types

• bool – True: defaults to ‘b’ False: Don’t draw any colorbar

• str – The string can be a combination of one of the following strings: {‘fr’, ‘fb’, ‘fl’, ‘ft’, ‘b’, ‘r’, ‘sv’, ‘sh’}

  • ‘b’, ‘r’ stand for bottom and right of the axes

  • ‘fr’, ‘fb’, ‘fl’, ‘ft’ stand for bottom, right, left and top of the figure

  • ‘sv’ and ‘sh’ stand for a vertical or horizontal colorbar in a separate figure

• list – A containing one of the above positions

vcbarspacing

Specify the spacing of the bounds in the colorbar

Possible types

str {‘uniform’, ‘proportional’} – if 'uniform', every color has exactly the same width in the colorbar, if 'proportional', the size is chosen according to the data

vclabel

Show the colorbar label of the vector plot

Set the label of the colorbar. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The title for the set_label() method.

See also

vclabelsize, vclabelweight, vclabelprops

vclabelprops

Properties of the Vector colorbar label

Specify the font properties of the figure title manually.

Possible types

dict – Items may be any valid text property

See also

vclabel, vclabelsize, vclabelweight

vclabelsize

Set the size of the Vector colorbar label

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

vclabel, vclabelweight, vclabelprops

vclabelweight

Set the fontweight of the Vector colorbar label

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

vclabel, vclabelsize, vclabelprops

vcmap

Specify the color map

This formatoption specifies the color coding of the data via a matplotlib.colors.Colormap

Possible types

• str – Strings may be any valid colormap name suitable for the matplotlib.cm.get_cmap() function or one of the color lists defined in the ‘colors.cmaps’ key of the psyplot.rcParams dictionary (including their reversed color maps given via the ‘_r’ extension).

• matplotlib.colors.Colormap – The colormap instance to use

See also

bounds

specifies the boundaries of the colormap

vcticklabels

Specify the colorbar ticklabels

Possible types

• str – A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

• array – An array of strings to use for the ticklabels

See also

cticks, cticksize, ctickweight, ctickprops, vcticks, vcticksize, vctickweight, vctickprops

vctickprops

Specify the font properties of the colorbar ticklabels

Possible types

dict – Items may be anything of the matplotlib.pyplot.tick_params() function

See also

cticksize, ctickweight, cticklabels, cticks, vcticksize, vctickweight, vcticklabels, vcticks

vcticks

Specify the tick locations of the vector colorbar

Possible types

• None – use the default ticks

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax

  The maximum to use (in which case it is not calculated from the specified method)

  method

  A string that defines how minimum and maximum shall be set. This argument is not optional and can be one of the following:

  data

  plot the ticks exactly where the data is.

  mid

  plot the ticks in the middle of the data.

  rounded

  Sets the minimum and maximum of the ticks to the rounded data minimum or maximum. Ticks are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimal tick will always be lower or equal than the data minimum, the maximal tick will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the ticks are chose such that they are symmetric around zero

  minmax

  Uses the minimum as minimal tick and maximum as maximal tick

  sym

  Same as minmax but symmetric around zero

  log

  Use logarithmic bounds. In this case, the given number N determines the number of bounds per power of tenth (i.e. N == 2 results in something like 1.0, 5.0, 10.0, 50.0, etc., If this second number is None, then it will be chosen such that we have around 11 boundaries but at least one per power of ten.

  symlog

  The same as log but symmetric around 0. If the number N is None, then we have around 12 boundaries but at least one per power of ten

  bounds

  let the bounds keyword determine the ticks. An additional integer i may be specified to only use every i-th bound as a tick (see also int below)

  midbounds

  Same as bounds but in the middle between two bounds

• int – Specifies how many ticks to use with the 'bounds' option. I.e. if integer i, then this is the same as ['bounds', i].

See also

cticklabels, vcticklabels

vcticksize

Specify the font size of the colorbar ticklabels

Possible types

• float – The absolute font size in points (e.g., 12)

• string – Strings might be ‘xx-small’, ‘x-small’, ‘small’, ‘medium’, ‘large’, ‘x-large’, ‘xx-large’.

See also

ctickweight, ctickprops, cticklabels, cticks, vctickweight, vctickprops, vcticklabels, vcticks

vctickweight

Specify the fontweight of the colorbar ticklabels

Possible types

• float – a float between 0 and 1000

• string – Possible strings are one of ‘ultralight’, ‘light’, ‘normal’, ‘regular’, ‘book’, ‘medium’, ‘roman’, ‘semibold’, ‘demibold’, ‘demi’, ‘bold’, ‘heavy’, ‘extra bold’, ‘black’.

See also

cticksize, ctickprops, cticklabels, cticks, vcticksize, vctickprops, vcticklabels, vcticks

vplot

Choose the vector plot type

Possible types

str – Plot types can be either

quiver

to make a quiver plot

stream

to make a stream plot

xlabel

Set the x-axis label

Set the label for the x-axis. You can insert any meta key from the xarray.DataArray.attrs via a string like '%(key)s'. Furthermore there are some special cases:

• Strings like '%Y', '%b', etc. will be replaced using the datetime.datetime.strftime() method as long as the data has a time coordinate and this can be converted to a datetime object.

• '%(x)s', '%(y)s', '%(z)s', '%(t)s' will be replaced by the value of the x-, y-, z- or time coordinate (as long as this coordinate is one-dimensional in the data)

• any attribute of one of the above coordinates is inserted via axis + key (e.g. the name of the x-coordinate can be inserted via '%(xname)s').

• Labels defined in the psyplot.rcParams 'texts.labels' key are also replaced when enclosed by ‘{}’. The standard labels are

  • tinfo: %H:%M

  • dtinfo: %B %d, %Y. %H:%M

  • dinfo: %B %d, %Y

  • desc: %(long_name)s [%(units)s]

  • sdesc: %(name)s [%(units)s]

Possible types

str – The text for the xlabel() function.

See also

xlabelsize, xlabelweight, xlabelprops

xlim

Set the x-axis limits

Possible types

• None – To not change the current limits

• str or list [str, str] or [[str, float], [str, float]] – Automatically determine the ticks corresponding to the data. The given string determines how the limits are calculated. The float determines the percentile to use A string can be one of the following:

  rounded

  Sets the minimum and maximum of the limits to the rounded data minimum or maximum. Limits are rounded to the next 0.5 value with to the difference between data max- and minimum. The minimum will always be lower or equal than the data minimum, the maximum will always be higher or equal than the data maximum.

  roundedsym

  Same as rounded above but the limits are chosen such that they are symmetric around zero

  minmax

  Uses the minimum and maximum

  sym

  Same as minmax but symmetric around zero

• tuple (xmin, xmax) – xmin is the smaller value, xmax the larger. Any of those values can be None or one of the strings (or lists) above to use the corresponding value here

See also

ylim

xrotation

Rotate the x-axis ticks

Possible types

float – The rotation angle in degrees

See also

yrotation

xticklabels

Modify the x-axis ticklabels

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• str – A formatstring like '%Y' for plotting the year (in the case that time is shown on the axis) or ‘%i’ for integers

• array – An array of strings to use for the ticklabels

See also

xticks, ticksize, tickweight, xtickprops, yticklabels

xtickprops

Specify the x-axis tick parameters

This formatoption can be used to make a detailed change of the ticks parameters on the x-axis.

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• dict – Items may be anything of the matplotlib.pyplot.tick_params() function

See also

xticks, yticks, ticksize, tickweight, ytickprops

xticks

Modify the x-axis ticks

Possible types

• dict – A dictionary with the keys 'minor' and (or) 'major' to specify which ticks are managed. If the given value is not a dictionary with those keys, it is put into a dictionary with the key determined by the rcParams 'ticks.which' key (usually 'major'). The values in the dictionary can be one types below.

• None – use the default ticks

• int – for an integer i, only every i-th tick of the default ticks are used

• numeric array – specifies the ticks manually

• str or list [str, …] – A list of the below mentioned values of the mapping like [method, N, percmin, percmax, vmin, vmax], where only the first one is absolutely necessary

• dict – Automatically determine the ticks corresponding to the data. The mapping can have the following keys, but only method is not optional.

  N

  An integer describing the number of boundaries (or ticks per power of ten, see log and symlog above)

  percmin

  The percentile to use for the minimum (by default, 0, i.e. the minimum of the array)

  percmax

  The percentile to use for the maximum (by default, 100, i.e. the maximum of the array)

  vmin

  The minimum to use (in which case it is not calculated from the specified method)

  vmax