Histogram

Create a histogram plot for 1D and 2D plot groups.

Syntax

model.result(<pgtag>).create(<ftag>,"Histogram");

model.result(<pgtag>).feature(<ftag>).set(property, <value>);

model.result(<pgtag>).feature(<ftag>).run();

Description

model.result(<pgtag>).create(<ftag>,"Histogram") creates a histogram plot feature named <ftag> belonging to the plot group <pgtag>.

Histograms are used to visualize the distribution of the range of an expression. The result is a plot with the expression’s range on the x-axis and element length, area, or volume on the y-axis. Histogram plots can be added to 1D plot groups.

The following properties are available:

Table 7-35: Valid Property/Value Pairs for Histogram Plots

name	Value	Default	Description
const	String array of property/value pairs	Empty	Parameters to use in the expressions.
cumulative	Boolean	false	Plot a cumulative histogram.
customlinecolor	RGB-triplet	{0,0,1} or last used edgecolor.	The color to use for the lines. Active when linecolor is set to custom.
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.
function	continuous | discrete	continuous	Use a continuous function or a discrete function (that is, using a constant level in each bin) for the histogram.
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.
level	fromdataset | volume | surface | line | point	fromdataset	The geometry level to evaluate on.
limits	double array	0 1	The bin limits if method is limits.
linecolor	custom | cycle | black | blue | cyan | green | magenta | red | white | yellow	cycle	How to color the lines in the graph. Cycle indicates that the colors is different for each line.
linewidth	double	0.5	The line width.
linemarker	none | cycle | asterisk | circle | diamond | plus | point | square | star | triangle	none	The line markers, if any. Cycle indicates that the marker is different for each line.
linestyle	none | cycle | solid | dotted | dashed | dashdot	solid	The line style, if any. Cycle indicates that the line style is different for each line.
looplevel	integer row matrix	All solutions 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.
markerpos	interp | datapoints	interp	Controls whether the positions of the markers are in the data points of the plot, or interpolated depending on the number (set in markers). Markers are visible when linemarker is set.
markers	integer	8	The number of markers to show. Markers are visible when linemarker is set.
method	limit | number	number	The method used to specify the bins in which the expression’s range is split
normalization	integral | none | peak	none	The normalization of the values plot on the y-axis.
number	nonnegative integer	10	The number of bins if method is number.
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 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
refine	nonnegative integer	1	The element refinement to use, if resolution is set to manual. Bear in mind that this is the refinement used for the base data set, so the number of elements in the model can increase radically if the plot uses, for example, a revolve data set.
resolution	norefine | coarse | normal | fine | finer | extrafine | custom	normal	Controls the plot’s resolution. A finer setting results in a higher resolution by modifying the internally computed default refinement. Use custom to enter your own refinement in the refine property.
sdim	fromdataset | 0 | 1 | 2 | 3	fromdataset	The space dimension to evaluate the underlying data set in
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.
type	curve | solid	curve	Use a filled histogram (solid) or a histogram drawn using lines (curve). This property is only available when function is discrete.
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.

See Also

MatrixHistogram