probe

Synopsis

interactively show numeric data values of field at probe location

Input Port

in_field	Mesh + Node_Data
in_glyph	Mesh describing geometry of probe
in_pick	pick information from renderer
ui_parent	user interface parent object

Parameters

data component	UIradioBoxLabel	selects data component to probe
Probe Normalize	UItoggle	normalizes probe size
probe scale	UIslider	scale factor for probe
value	UIfieldTypein	reports value of data at probe location
Probe Transform	(xform)	transformation editor to move probe

Output Port

out_fld	Mesh + Node_Data
out_obj	output renderable object

Description

probe displays the data values present at the probe object's location in a mesh. When the probe object is not exactly on a node, the value shown is the result of an interpolation of the adjacent node data values.

Input

in_field

This input is a field with any mesh type and Node_Data.

in_glyph

A glyph to represent the probe object. This is a mesh describing the geometry of the glyph. Any mesh can be used (e.g., that of a teapot), but for convenience you can use the meshes defined in Geometries such as Arrow1, Cross2D or Cross3D.

in_pick

This input is connected to the renderer module's picked_obj red output port. It informs probe which object has been picked to probe.

ui_parent

A port to connect to a user interface object that contains the macro's widgets. By default, it is connected to the default user interface object in the application in which the macro is instanced. (This default connection is not drawn.)

Parameters

data component

UIradioBoxLabel. Radio buttons to pick which of the input field's components to probe. The component can be scalar or vector. The default is the first (0th) component. If node data labels are present, they are displayed.

Probe Normalize

UItoggle. If off, the size of the probe is proportional to the data component values at each node. If on, the probe is the probe scale size. The default is off.

probe scale

UIslider. A float slider to adjust the size of the probe. The default is 1.0 and the range is -10 to 10.

value

UIfieldTypein. A float. This is an output parameter only - it displays the value of the data at the probe's location. Where the probe does not fall exactly on a node, the value is interpolated from the values of adjacent nodes.

Note that the value displayed is accurate if the selected component was a scalar. If it was a vector, you see only the value of that component's first vector element.

Probe Transform

A transformation editor (XformEditor). Used to place the probe within the input field.

Output Port

out_fld

This output is or marginal utility. It contains the mesh of the probe object and Node_Data that is the value of the data at the probe's current location.

out_obj

The renderable version of the output field.

Algorithm

The algorithms used to interpolate the value at the probe location are trilinear interpolation for structured fields and shape functions for unstructured field.

Example

Libraries.Examples.Visualization.Probe
v/dv_examp/probe.v

File

v/modules.v

See also related modules