ImageOverlay

Embed an image overlay in a surface or volume plot.

model.result(<pgtag>).feature(<ftag>).create(<atag>,"ImageOverlay");

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

model.result(<pgtag>).feature(<ftag>).create(<atag>,"ImageOverlay") creates an image overlay attribute feature with the name <ftag>.

You can add an image overlay as an attribute to a 3D volume plot or a 2D or 3D surface plot, overlaying the image in the plot’s surface.

The following properties are available:

Table 7-55: Valid Property/Value Pairs for ImageOverlay Attribute
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.
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.
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.
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.
preserveaspect	true \| false	true	Preserve the aspect ratio when mapping is set to auto.
projsize	double	1	Projected size, when mapping is set to planar.
rot	double	0	The rotation of the image mapping in radians, when mapping is set to planar, cylindrical, or spherical.
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.