Module: Point Probe ()

Description:

The probing module PointProbe is used to inspect scalar or vector data fields. The probe is taken at a point which may be arbitrarily placed. The controlpoint, which is the samplepoint, determines the location where the sample is to be taken.

To place the controlpoints within the bounding box of the given geometry you can either type in the coordinates in the port Points (see below) or you can shift the points interactively with the mouse. The latter can be done by turning the 3D viewer into interactive mode (ESC key) and picking and moving the crosshair dragger of the current point (see Points port options to show/hide the dragger). You can also pick a location with the middle mouse button on a pickable object in the scene, e.g., an Ortho Slice or a surface, to set the current point to that location. You can change the current point to be moved by pressing 'up arrow' or 'down arrow' key while interacting in viewer window, or by clicking with left mouse button on a point (small yellowish spheres).

The plot immediately changes if the immediate mode toggle is set. Usually the sampled values are plotted as a bar in an extra plot window. If you use more than one data probing module of the same type all plotted curves will be shown in one plot window.

Point Probe displays the value at the sample point and the material if material values are set.

Connections:

Data [required]
Can be connected to arbitrary 3D fields.

Ports:

Evaluate

If the probe is connected to a vector field, these radio buttons are shown. If the magnitude button is set the magnitude of the vectors is shown in the plot window. With the normal+tangent button set you get the normal and tangential components as two curves. Setting the all button shows all components of the vector field as separate curves.

Probe Settings

Options

The immediate option determines whether the samples are taken while the controlpoints are being moved or when the motion is finished. If the interpolate option is on, interpolation is used to evaluate the value of the Point Probe.

CoordSystem

This port allows you to select the coordinates system to use.

Points

Here you can see and/or type in the coordinates of all controlpoints the data probing module makes use of. The options menu lets you toggle whether a dragger or a sphere is shown for the controlpoints.

Point Size

To set the size of the controlpoint.

Plot

If the Show button is pressed a plot window appears where the sampled values are plotted against the length of the probe line. Note: There will be only one plot window regardless of how many probing modules there are in your setup.

Average

Average

The average option averages the probe value by taking samples on a sphere centered on the point probe.

Radius

The radius of the sampling sphere. This slider is only shown if the above "take average" option is checked.

Commands:

getPoint
Returns the coordinate of the controlpoint, expressed in the data 3D coordinates system.

setPoint <x> <y> <z>
Sets the coordinates of the controlpoint, expressed in the data 3D coordinates system.

setImmediate {0|1}
Switches the immediate mode on or off, i.e., data is shown while the probe line or point is being moved.

getNumPoints
Returns the number of control points of a probe line. In case of a point probe 1 is returned.