PlotStruct structure

The PlotStruct structure contains the selection and the options for the current plot (i.e. the marker type, color, etc)

It has the following fields:

Name Content
additional Structure with non general fields (i.e. not applicable for any model)
 
batch Takes the value of the selected batch (third mode) to plot loadings corresponding to this batch. Available for PARAFAC 2 and OPA 3D models.
batchyn

1 or 0:1 when batches have to be distinguished by different colors on the plots.

(available for PCA when multiple sets loaded)

hotelling Variables of hotelling ellipsoid on the plot:
 
exist 1 or 0: present on the plot or not
confid default levels of confidence region
size size to trace ellipsoid
plotvi

for IV-PCA and IV-Tucker

3-vector, for example [1 0 1]:

means that is shown only first and third plots (corresponding to Y and QxY).
potential Variables of potential functions:
 
exist 1 or 0: present on the plot or not
liss lissage constant
num 1or 0: 1 means potential contours will be scaled.
plot kind of plot: contour, contourf, etc..
size the region represented by the axes is divided in size*size rectangles in order to estimate the density of the potential function.
quality Structure with the options relative to the quality parameter (Tucker, PCA, Tucker-IV, PCA-IV).
 
exist 1 or 0: present on the plot or not
limqual real number between 0 and 1, corresponfds to the gap under which the modality has not sufficiently good quality to be drawn on the plot ( it is in grey)
shadow 1 or 0:for 3D plots, possibility to haves shadows of the plot on the 3 different planes constituted by the axes.
state

for Tucker: uses normed (1) or weighted(0) loadings
type

'X' or 'Y' depending on the array the plot refers to (used by nPLS and PLS)
validation
  • 0, do not show validation results
  • 1, show prediction for the validation part (i.e. for test set or leave one out)
  • 2, show replicates (in leave one out and bootstrap)
color Letter code (for instance 'b', 'c' or 'k') or vector of three doubles defining the color for the plot
factors Component/Factor/LV for the three possible axes of a plot
format Vector of length 2:
  1. 1: number,
    2: label,
    3: marker,
    4: no-marker;
  2. 1: discrete,
    2: continuous.
grid 'on'/'off', turn the grid on or off
linestyle all the possible linestyles allowed by MatLab
marker all the possible markers allowed by Matlab plus 'polygon' in which case convex hulls are used as markers for the replicates.
nummode number of the selected mode for plots.
It can be a vector for mixed modes plot in Tucker and Tuckervi
plotdims Number of dimensions for the plot:
  1. 1D plot,
  2. 2D plot,
  3. 3D plot.
type Type of plot. E.g. 'Plot_Loadings','Plot_Explained_Variance', etc.
In particular for PARAFAC and (n)PLS it is the name of the function relative to the plot one wants to display.
visible Model visible or not in the plot.
Possible values: 'on'/'off'

In PARAFAC and nPLS/PLS also:

  • 'label' the model is plot using labels overimposed to validation (if that is also plotted)
  • 'marker' the model is plot using markers overimposed to validation (if that is also plotted)
  • 'number' the model is plot using numbers overimposed to validation (if that is also plotted)