MatrixHistogram
Create a matrix histogram plot for 2D plot groups.
Syntax
model.result(<pgtag>).create(<ftag>,"MatrixHistogram");
model.result(<pgtag>).feature(<ftag>).set(property,<value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"MatrixHistogram") creates a histogram plot feature named <ftag> belonging to the plot group <pgtag>.
Use a matrix histogram if you have a precomputed matrix that you want to visualize as a 2D histogram. For example, in a fatigue analysis, you can use it for rainflow counting to visualize the distribution of stress amplitudes and mean stresses. The matrix then contains data points in the xy-plane, where the x- and y-values are stresses. Matrix histogram plots can be added to 2D plot groups.
The following properties are available:
Table 7-80: Valid Properties for Matrix Histogram Plots.
name
Value
Default
Description
axisunit
String
Empty
Unit for the histogram axes.
bottomcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
black
The bottom color to use for a color gradient. Active when coloring is gradient.
color
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
red
The uniform color to use. Active when coloring is uniform.
coloring
colortable | uniform | gradient
colortable
How to color the plot: using a color table, a uniform color, or a color gradient.
colorlegend
on | off
on
Whether to show color legend when coloring is set to colortable.
colortable
color table name
Rainbow
The color table to use when coloring is set to colortable. See Color Tables for a list of color tables.
colortabletrans
none | reverse | nonlinear | nonlinearsymmetric
none
Transformation of the color table, when coloring is set to colortable or gradient.
const
String array of property/value pairs
Empty
Parameters to use in the expressions.
custombottomcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when bottomcolor is set to custom.
customcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when color 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.
data
none | parent | dataset name
parent
The dataset this feature refers to.
descr
String
Model dependent
The description of the expression in expr. Is used in the automatic title.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
differential
on | off
on
Whether the expression should be linearized at the linearization point. Applicable only if evalmethod is harmonic.
evalmethod
linpoint | harmonic | lintotal | lintotalavg | lintotalrms | lintotalpeak
harmonic
Applicable only for solutions with a stored linearization point. Controls if the linearization point, the perturbation, or a combination should be used when evaluating the expression.
expr
String
Model dependent
The expression to plot.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
gridcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
gray
The grid color, if showgrid is set to true.
innerinput
all | first | last | manual | manualindices | interp
all
How to input the solution to use. manual indicates that solnum is used. manualindices indicates that solnumindices is used. interp indicates that t is used.
interp
double row matrix
Empty on all levels
The times to use, for transient levels. Available when data is not parent and the underlying data is transient.
looplevel
integer row matrix
all on all levels
The solutions to use, per level.
looplevelindices
integer row matrix
Empty
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when looplevelinput is manualindices on a level.
looplevelinput
String array with all | first | last | manual | manualindices | interp on each level
all on all levels
How to input the solution to use, per level. manual on a level indicates that looplevel is used on that level. manualindices on a level indicates that looplevelindices is used on that level. interp on a level indicates that interp is used on that level.
nonlinearcolortablerev
on | off
off
Whether to reverse to color table or gradient when coloring is set to colortable or gradient and colortabletrans is set to nonlinear or nonlinearsymmetric.
outerinput
all | first | last | manual | manualindices
all
How to input the outer solutions to use. Applicable only for parametric sweep models. manual indicates that outersolnum is used. manualindices indicates that outersolnumindices is used.
outersolnum
nonnegative integer array
1
The index of the outer solutions to use. Applicable only for parametric sweep models. Since the various outer solutions can have different number of solnum, the solnum property is not used.
outersolnumindices
String or integer array
Empty
An alternative way to specify the outer solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when outerinput is manualindices.
prefixintitle
String
Empty
Added prefix to contribution to title.
showgrid
true | false
false
Whether to include a grid in the matrix histogram plot.
solnum
integer array
All solutions
The solutions to plot. Available when data is not parent and the underlying data has multiple solutions
solnumindices
String or integer array
Empty
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when innerinput is manualindices.
solrepresentation
solnum | solutioninfo
solutioninfo
Indicates which method of selecting solutions is active.
solutionparams
manual | parent
manual
If data is a local dataset with nontrivial data, specify solutions manually or take them from the parent plot group.
suffixintitle
String
Empty
Added suffix to contribution to title.
t
double array
Empty
The times to plot. Available when data is not parent and the underlying solution is transient.
title
String
The auto-title.
The title to use when titletype is manual
titletype
auto | custom | label | manual | none
auto
auto, if the title should be computed automatically. custom, if the title should be computed automatically, but customized. 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 top color to use for a color gradient. Active when coloring is gradient.
typeintitle
on | off
on
Whether the title contribution should contain the type when titletype is custom.
unit
String
Model dependent
The unit to use for the expression in expr. If the old unit is not valid when the expression changes, the unit property is reset to default.
unitintitle
on | off
on
Whether the title contribution should contain the unit when titletype is custom.
xdata
String
Empty
Data for the histogram’s x-axis.
ydata
String
Empty
Data for the histogram’s y-axis.
Attributes
Filter (Plot Attribute); Height, AberrationHeight, HistogramHeight, TableHeight; Transparency (if a height attribute is used)
See Also
Histogram