JointProbabilityDistribution
Plot a joint probability distribution.
The JointProbabilityDistribution plot requires a license for the Uncertainty Quantification Module.
Syntax
model.result(<pgtag>).create(<ftag>,"JointProbabilityDistribution");
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result().dataset().create(<ftag>,"JointProbabilityDistribution"); creates a joint probability distribution plot in 2D plot groups as a postprocessing step for models using uncertainty quantification.
The following properties are available:
Table 7-64: Valid Property/Value Pairs for Joint Probability Distribution Plots
Property
Value
Default
Description
abovediagonal
true | false
true
Include parameter pairs above the diagonal, if mode is set to overview.
colortable
color table name
Rainbow
The color table to use when plotcontours is set to true. See Color Tables for a list of color tables.
colx
Table column number
 
The x-axis column for the parameter pair when mode is set to pair.
coly
Table column number
 
The y-axis column for the parameter pair when mode is set to pair.
curvecolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
blue
The estimation distribution curve color to use. Active when plotestimdistr is true.
customcurvecolor
1-by-3 double (RGB values)
 
The RGB values for a custom estimation distribution curve color, when curvecolor is set to custom.
customhistogramcolor
1-by-3 double (RGB values)
 
The RGB values for a custom hi color, when histogramcolor is set to custom.
customjointcolor
1-by-3 double (RGB values)
 
The RGB values for a custom point color, when jointcolor is set to custom.
descr
String
Model dependent
The description of the expression in expr. Is used in the automatic title.
histogramcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
green
The histogram color to use. Active when plothistogram is true.
jointcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
gray
The point color to use. Active when plotpoints is true.
mode
overview | pair
overview
The plot mode: overview for an overview, or pair for an enlarged view of the scatter plot for the selected pair.
numberoflevels
positive integer
10
The number of contour levels, if plotcontours is set to true.
padding
double
0.02
Padding of parameter ranges.
plotcontours
true | false
true
Plot contours.
plotestimdistr
true | false
true
Plot estimated distribution, if mode is set to overview.
plothistogram
true | false
true
Plot histogram, if mode is set to overview.
plotpoints
true | false
true
Plot points.
table
none | table name
 
The table this feature refers to.
title
String
The auto-title
The title to use when titletype is manual.
titletype
auto | label | manual | none
auto
auto, if the title should be computed automatically. label, if the title should be the plot group’s label. manual, if the manual title should be used (the title property). none, if no title should be displayed.
xpadding
double
0.02
x-axis padding, when mode is set to pair.
xspacing
double
0.05
Horizontal spacing between plots, when mode is set to pair.
ypadding
double
0.01
y-axis padding, when mode is set to pair.
yspacing
double
0.05
Vertical spacing between plots, when mode is set to pair.
Attributes
None.