SobolIndex
Create a Sobol index plot to visualize Sobol indices for a sensitivity analysis in an uncertainty quantification study This plot type can be added to 1D plot groups.
The Sobol index plot requires a license for the Uncertainty Quantification Module.
Syntax
model.result().create(<pgtag>,"SobolIndex");
model.result(<pgtag>).set(property,<value>);
model.result(<pgtag>).run();
Description
model.result(<pgtag>).create(<ftag>,"SobolIndex") creates a Sobol index feature named <ftag> belonging to the 1D plot group <pgtag>. The plot takes a quantity of interest from a table created by an uncertainty quantification study.
The following properties are available:
Table 7-145: Valid Properties for Sobol Index Plots.
name
Value
Default
Description
autoheaders
true | false
true
Whether the automatic legends should include the column headers.
autoplotlabel
true | false
false
Whether the automatic legends should include the plot label.
bottomcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
black
The bottom color to use for a color gradient. Active when linecolor is cyclegradient.
colorcycle
default | long
default
The color cycle, when linecolor is set to cycle. With default, it contains 7 colors; with long, it contains 19 colors.
colortable
color table name
Rainbow
The color table to use when linecolor is set to cyclecolortable. See Color Tables for a list of color tables.
custombottomcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when bottomcolor is set to custom.
customlinecolor
RGB-triplet
{0,0,1} or last used edgecolor
The color to use for the lines. Active when linecolor is set to custom.
customtopcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when topcolor is set to custom.
cyclelength
auto | manual
auto
The length of color cycle when linecolor is cyclegradient.
legend
on | off
off
Whether to show legends.
legendmethod
automatic | manual
automatic
Whether to use the automatic legends or the legends supplied in the legends property.
legendprefix
String
 
A prefix added to the automatic legend.
legends
String array
The last computed automatic legends
Manual legends active when legendmethod is set to manual.
legendsuffix
String
 
A suffix added to the automatic legend.
linecolor
custom | cycle | cyclereset | cyclecolortable | cyclegradient | fromtheme | black | blue | cyan | gray | green | magenta | red | white | yellow
cycle
How to color the lines in the graph. Cycle indicates that the colors is different for each line. Use cyclereset to restart the cycling of colors from the first color. Use fromtheme to take the color from the selected color theme.
numberofcolors
integer
7
The number of colors in the color cycle when cyclelength is manual.
quantityofinterest
positive integer
1
The column in the table that contains the quantity of interest.
reversecolortable
boolean
false
Whether to reverse the order of the colors in the color table. Active when linecolor is cyclecolortable.
sort
boolean
false
Sort parameters in decreasing order with respect to the total Sobol index for the quantity of interest.
table
none | table feature name
First available table
The table feature this plot 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.
topcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
white
The bottom color to use for a color gradient. Active when linecolor is cyclegradient.
See Also
Table