Warning

You are reading the documentation related to the development version. Go here if you are looking for the documentation of the stable release.

spectrochempy.plot_pen

plot_pen(dataset, *args, **kwargs)[source]

Plot a 1D dataset with solid pen by default.

Alias of plot (with method argument set to pen .

Parameters

  • dataset (NDDataset) – The dataset to plot.

  • **kwargs – Optional keyword parameters (see Other Parameters).

Other Parameters

  • ax (Axe, optional) – Axe where to plot. If not specified, create a new one.

  • style (str, optional, default: dataset.preferences.style (scpy)) – Matplotlib stylesheet (use available_style to get a list of available styles for plotting.

  • use_plotly (bool, optional, default: preferences.use_plotly (False)) – Should we use plotly instead of matplotlib for plotting.

  • twinx (Axes instance, optional, default: None) – If this is not None, then a twin axes will be created with a common x dimension.

  • clear (bool, optional, default: True) – If false, hold the current figure and ax until a new plot is performed.

  • reverse (bool or None [optional, default=None/False) – In principle, coordinates run from left to right, except for wavenumbers (e.g., FTIR spectra) or ppm (e.g., NMR), that spectrochempy will try to guess. But if reverse is set, then this is the setting which will be taken into account.

  • data_only (bool, optional, default: False) – Only the plot is done. No addition of axes or label specifications.

  • imag (bool, optional, default: False) – Show imaginary component for complex data. By default the real component is displayed.

  • show_complex (bool, optional, default: False) – Show both real and imaginary component for complex data. By default only the real component is displayed.

  • figsize (tuple, optional, default is (3.4, 1.7)) – figure size.

  • dpi (int, optional) – the number of pixel per inches.

  • xlim (tuple, optional) – limit on the horizontal axis.

  • zlim or ylim (tuple, optional) – limit on the vertical axis.

  • color or c (color, optional, default: auto) – color of the line.

  • linewidth or lw (float, optional, default: auto) – line width.

  • linestyle or ls (str, optional, default: auto) – line style definition.

  • marker, m (str, optional, default: auto) – marker type for scatter plot. If marker != “” then the scatter type of plot is chosen automatically.

  • markeredgecolor or mec (color, optional)

  • markeredgewidth or mew (float, optional)

  • markerfacecolor or mfc (color, optional)

  • markersize or ms (float, optional)

  • markevery (None or int)

  • title (str) – Title of the plot (or subplot) axe.

  • plottitle (bool, optional, default: False) – Use the name of the dataset as title. Works only if title is not defined

  • xlabel (str, optional) – label on the horizontal axis.

  • zlabel or ylabel (str, optional) – label on the vertical axis.

  • uselabel_x (bool, optional) – use x coordinate label as x tick labels

  • show_z (bool, optional, default: True) – should we show the vertical axis.

  • show_zero (bool, optional) – show the zero basis.

  • show_mask (bool, optional) – Should we display the mask using colored area.

  • plot_model (Bool,) – plot model data if available.

  • modellinestyle or modls (str) – line style of the model.

  • offset (float) – offset of the model individual lines.

  • commands (str,) – matplotlib commands to be executed.

  • output (str,) – name of the file to save the figure.

  • vshift (float, optional) – vertically shift the line from its baseline.

See also

plot_1D, plot_bar, plot_scatter_pen, plot_multiple, plot_2D, plot_stack, plot_map, plot_image, plot_3D, plot_surface, plot_waterfall, multiplot