Image (Plot)
Embed an image in a surface or volume plot.
Syntax
model.result(<pgtag>).feature(<ftag>).create(<atag>,"Image");
model.result(<pgtag>).feature(<ftag>).feature(<atag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).selection()...
Description
 model.result(<pgtag>).feature(<ftag>).create(<atag>,"Image") creates an image feature with the name <ftag>.
You can add an image a to a 3D or 2D plot group to plot an image on the geometry’s surface.
For example, model.result("pg1").feature("img1").selection().set(12); selects boundary 12 as the boundary for which to display the image called img1 in the plot group pg1.
The following properties are available:
Table 7-50: Valid Property/Value Pairs for Image Plots
name
Value
Default
Description
ax2
double array
{0, 0}
The theta and phi angles (in radians), when axistype is set spherical.
ax3
double array
{0, 0, 1}
Axis direction, when axistype is set cartesian.
axistype
cartesian | spherical | x | y | z
z
The axis type: Cartesian, spherical, X-axis, Y-axis, or Z-axis, if mapping is set to cylindrical or spherical.
coordinterpretation
relative | pixels
off
Interpret the u- and v-coordinates as relative values or pixel coordinates when mapping is set to manual.
data
none | parent | dataset name
parent
The dataset this feature refers to.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
displacement
double
0
The displacement for the cylinder, when heightmode is set to manual.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
extrapolation
repeat | mirroredrepeat | clamp
repeat
How the image is extrapolated. With clamp, each coordinate is mapped to the closest valid value at an edge of the image.
filename
String
 
The filename for the image to add.
heightmode
auto | fit | manual
auto
How to determine the height: automatically, to fit to the object, or manually, when mapping is set to cylindrical.
heightval
double
1
The height for the cylinder, when heightmode is set to manual.
importedheight
String
 
The height, in pixels, for example, of the imported image file.
importedname
String
 
Name of the imported image file.
importedwidth
String
 
The width, in pixels, for example, of the imported image file.
inheritdeformscale
Boolean
true
If inheritplot is not none: Determines if the deformation scale is inherited.
inheritplot
none | plot name
none
The plot that color and color range are inherited from.
mapping
auto | manual | planar | cylindrical | spherical | rectangular
auto
The surface mapping of the image (automatic or manual). For 3D only, you can also choose a planar, cylindrical, or spherical mapping. For 2D only, you can also choose a rectangular mapping.
normal
double array
{0, 0, 1}
Normal vector, when planetype is set to general.
planetype
xy | yz | zx | yx | zy | xz | auto | general
xy
The surface mapping of the image (automatic or manual). For 3D only, you can also choose a planar, cylindrical, or spherical mapping.
pos
double array
{0, 0, 0}
Axis direction, when mapping is set to cylindrical or spherical.
phirange
double
360
The angle range (in degrees), when mapping is set to cylindrical.
preserveaspect
true | false
true
Preserve the aspect ratio when mapping is set to auto.
prefixintitle
String
 
Added prefix to contribution to title.
projsize
double
1
Projected size, when mapping is set to planar.
recover
off | pprint | ppr
off
The derivative recovery method (off, within domains, or everywhere).
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 dataset, so the number of elements in the model can increase radically if the plot uses, for example, a revolve dataset.
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.
rot
double
0
The rotation of the image mapping in radians, when mapping is set to planar, cylindrical, or spherical..
smooth
none | material | internal | everywhere | expression
material
Smoothing settings. With material, smoothing is done inside domains with the same material. With internal, smoothing is done inside geometry domains. With expression, the smoothing is based on the expression in smoothexpr.
smoothexpr
String
dom
The expression to use for smoothing when smooth is set to expression.
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.
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.
typeintitle
on | off
on
Whether the title contribution should contain the type when titletype is custom.
unitintitle
on | off
on
Whether the title contribution should contain the unit when titletype is custom.
uexp
String
0
Expression for the u-coordinate when mapping is set to manual.
vexp
String
0
Expression for the v-coordinate when mapping is set to manual.
width
double
1
The width of the image, when mapping is set to rectangular or planar.
Attributes
Deform, MaterialAppearance, Transparency (3D only)
See Also
ImageOverlay, MaterialAppearance, Transparency