probe_cell

Synopsis

interactively probe cell data values

Input Ports

in_field	Mesh+Cell_Data
in_glyph	Mesh
in_pick	GDobject_templ
parent	user interface parent object

Output Ports

out_fld	Mesh+Node_Data
out_obj	output renderable object

Description

probe_cell interactively probes the value of a cell-based dataset, using a user-specified probe glyph. You click in the viewer (using the pick button) to select an object and a point on or in that object; that point is used to sample the object's cell data by finding which cell encloses that point, and using that cell's data value. The sampled value is shown in four ways:

It is reported numerically in the value window.

It is applied as node data to the glyph, which usually colors the glyph.

It can optionally scale the glyph in X, Y and Z (if Probe Normalize is off).

The glyph's origin is transformed to lie at the sample point.

Note that a pick object is necessary to run the module, so you must click in the viewer to set the location of the probe glyph. After the selected object is determined, you can transform the probe glyph in three ways:

Numerically, using probe_cell's glyph transform editor.

Interactively, by clicking on a different part of the dataset.

Interactively, by directly manipulating the probe glyph.

Input Ports

in_field

Mesh+Cell_Data. The field to probe.

in_glyph

Mesh. The glyph to use to show the location of the probe point. This can be any mesh (for example, a teapot), but the simple meshes defined in Geometries such as Arrow1, Cross2D, or Cross3D are commonly used.

in_pick

GDobject_templ. A pick object which is output from a viewer.

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

cell data

UIradioBoxLabel. Which component of the data to probe. If the selected component is a vector, only the first element of the vector is shown.

Probe Normalize

UItoggle. When this is on, the size of the glyph is not scaled by the probed data value. When off, the size is scaled.

probe scale

UIslider. Scales the size of the glyph in X, Y and Z. If normalize is off, both the data scale and this scale are applied.

Parameters

value

UIfieldTypein. The value of the cell data component at the probe point.

Output Ports

out_fld

The output field consists of the input glyph mesh transformed to the probe location, scaled by the scale value and optionally the data value, and with Node_Data containing the probed data value.

out_obj

Renderable object corresponding to out_fld.

Example

Not available.

File

v/modules.v