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-46: Valid Property/Value Pairs for Matrix Histogram Plots

name	Value	Default	Description
axisunit	String	Empty	Unit for the histogram axes.
color	custom | black | blue | cyan | green | magenta | red | white | yellow	red	The uniform color to use. Active when coloring is uniform.
coloring	colortable | uniform	colortable	How to color the slices
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 colormethod is set to colortable. See Color Tables for a list of color tables.
colortablerev	on | off	off	Whether to reverse to color table when colormethod is set to colortable
const	String array of property/value pairs	Empty	Parameters to use in the expressions.
data	none | parent | data set name	parent	The data set 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.
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 alternate 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.
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	non-negative 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 alternate 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
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 alternate 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.
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 | manual | none	auto	auto if the title contribution should be computed automatically, possibly using the group’s customization. custom if the title contribution should be computed automatically, but customized. manual if the manual title contribution should be used (the title property). none if no title contribution should be used.
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

Height, HistogramHeight, TableHeight

See Also

Histogram