Organize multiple renderable objects by grouping them into a single renderable object.
Applies all connected module's output to the Viewer's 2D overlay. Objects in the overlay are not transformed (rotated, zoomed, panned). These objects are locked in position. This provides a mechanism to apply graphics like drawing title blocks or company logos.
Allows any change in a module property to trigger a python script.
Combine the input fields from up to 4 separate inputs into a unified single field with any number of nodal data components.
Perform mathematical operations on values coming from various numeric and string input ports to generate a resultant value.
Convert nodes into a three-dimensional surface of triangular cells representing an unstructured mesh.
Recreates the cell sets based on nodal data.
Iterates an operation. For example, you could use a loop object to control the movement of an object in your application; such as incrementing the movement of a slider for a slice plane.
Alter the data within its inner radius to a set value and the blend data in its outer radius between its original value and the set modification value.
Create convex and concave hulls from points.
Subsections of Tools
group objects
The group objects module organizes multiple renderable objects by grouping them into a single renderable object. Unlike a data object, group objects does not include data. Instead, it serves as a node in the rendering hierarchy that groups other data objects together and supplies common attributes for them. This object is connected directly to one of the viewers or to another data object.
Group objects combines the following:
- DefaultDatamap to convert scalar node or cell data to RGB color values. By default, the datamap’s minimum and maximum values are 0 and 255, respectively. This datamap is inherited by any children objects if they do not have their own datamaps.
- DefaultProps to control color, material, line attribute, and geometrical attributes.
- DefaultModes to control point, line, surface, volume, and bounds rendering modes.
- DefaultPickInfo to contain information when this object is picked.
- DefaultObject to control visibility, pickability, caching, transform mode, surface conversion, and image display attributes.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Objects | Renderable | Any number of renderable objects. |
| Output | Output Object | Renderable | A renderable object created from all passed in objects. |
Properties
| Property | Type | Description |
|---|---|---|
| Visibility | Boolean | The Visibility toggle will turn on or off the visible state of the output objects. |
group objects to 2d overlay
The group objects to 2d overlay module applies any connected module’s output to the viewer’s 2D overlay. Objects in the overlay are not transformed (rotated, zoomed, panned). These objects are locked in position. This provides a mechanism to apply graphics like drawing title blocks or company logos.
You must ensure that the object sent to the 2D overlay fits inside its limited spatial extent. The 2D overlay is a window with an x-extent from -1.0 to 1.0. The y-extent is dependent on the aspect ratio of the viewer. With a default viewer having a 4:3 aspect ratio, it is three-quarters of the x-extent (e.g. -0.75 to 0.75).
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Objects | Renderable | Any number of renderable objects. |
| Output | Output Object | Renderable | A renderable object created from all passed in objects. |
Properties
This module has no user-configurable properties.
trigger script
The trigger script module provides a powerful way to link parameters and actions of multiple modules. This gives you the ability for a sequence of events to be “triggered” as the result of one or more parameters changing.
The module requires a Python script be created, which runs when you “Add” triggers. Triggers are module parameters that might change and thereby cause the script to be run. The script can do just about anything.
In addition to the triggers that you specify, there are 4 input (and output) ports that accept numbers (such as a plume level) that can be used in your script, and are more readily accessible without editing the Python script.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Value N1 | Number | A value to use as a variable. |
| Input | Input Value N2 | Number | A value to use as a variable. |
| Input | Input Value N3 | Number | A value to use as a variable. |
| Input | Input Value N4 | Number | A value to use as a variable. |
| Output | Output Value N1 | Number | A value to use as a variable. |
| Output | Output Value N2 | Number | A value to use as a variable. |
| Output | Output Value N3 | Number | A value to use as a variable. |
| Output | Output Value N4 | Number | A value to use as a variable. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | Determines whether the module is allowed to execute. Set to True to allow this module to run. |
| Execute | Button | Executes the script immediately. |
| Filename | String | The script which is run whenever appropriate triggers occur. |
| Triggers | String | The parameters used to trigger the script to execute. |
| Run On Load | Boolean | Determines whether the module is allowed to execute when the application is being loaded. Set to True to allow this module to run. |
Variables
| Property | Type | Description |
|---|---|---|
| N1 | Double | Number passed into script. |
| N2 | Double | Number passed into script. |
| N3 | Double | Number passed into script. |
| N4 | Double | Number passed into script. |
| Trigger | String | The parameter which triggered the script. |
merge fields
The merge fields module combines the input fields from up to 4 separate inputs into a unified single field with any number of nodal data components, which can be output to other modules for processing or directly to the viewer. This is useful when you want to slice through or otherwise subset multiple fields using the same criteria.
You must be aware that fields contain more than just grids and data. They contain meta-data set during the creation of those grids and data, including, but not limited to:
- Data Processing (log or linear)
- Coordinate units
- Data units (mg/kg or %)
- Data Min and Max values (ensures that datamaps from kriging match datamaps in post samples)
NOTE: There are potential dangers and serious consequences of merging fields because we allow for merging of data without requiring strict name or meta data matching.
- Meta data from the leftmost input field is always used for the merged result.
- You can only merge fields having the same number of nodal and/or cell data components.
- We do not require strict name matching, therefore it is possible to merge data with very negative consequences. Examples are:
- Benzene data from one input field with Toluene from another field.
- Log Processed TPH data with linear processed TPH data.
- One field with coordinate units of meters with another in feet.
- Overlapping Volumes: When you merge fields you must be aware that this is not an alternative way to create the union of multiple plumes.
- The merge fields module does not remove overlapping volumes.
- Volume calculations with volumetrics can count overlapping regions multiple times giving nonsensical values.
The Merge Cell Sets When Possible option works only if you have matching types and names. A good and appropriate example is merging fault blocks so that all “Clay” cell sets are controlled as a single entity.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | First Input Field | Field | A field to be used for merging. |
| Input | Second Input Field | Field | A field to be used for merging. |
| Input | Third Input Field | Field | A field to be used for merging. |
| Input | Fourth Input Field | Field | A field to be used for merging. |
| Output | Output Field | Field | A field containing the merged fields. |
| Output | Output Object | Renderable | A renderable object displaying the data from the merged fields. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | The Allow Run toggle will prevent the module from running. This allows the user to make multiple changes without the module constantly updating. |
| Execute | Button | The Run Once button will cause the module to run one time even if the Allow Run toggle has been turned off. |
| Merge Cell Sets When Possible | Boolean | If all input fields have matching cell set types and names, automatically merge them in output. |
| Nodal Data From Field1 | Multi-select | The nodal data from Field 1 that should be included in the output. Be sure that the order of the components is identical from each input. |
| Cell Data From Field1 | Multi-select | The cell data from Field 1 that should be included in the output. Be sure that the order of the components is identical from each input. |
| Nodal Data From Field2 | Multi-select | The nodal data from Field 2 that should be included in the output. Be sure that the order of the components is identical from each input. |
| Cell Data From Field2 | Multi-select | The cell data from Field 2 that should be included in the output. Be sure that the order of the components is identical from each input. |
| Nodal Data From Field3 | Multi-select | The nodal data from Field 3 that should be included in the output. Be sure that the order of the components is identical from each input. |
| Cell Data From Field3 | Multi-select | The cell data from Field 3 that should be included in the output. Be sure that the order of the components is identical from each input. |
| Nodal Data From Field4 | Multi-select | The nodal data from Field 4 that should be included in the output. Be sure that the order of the components is identical from each input. |
| Cell Data From Field4 | Multi-select | The cell data from Field 4 that should be included in the output. Be sure that the order of the components is identical from each input. |
float math
The float math module provides a simple means to perform mathematical operations on numbers coming from up to 4 input ports. By using multiple float math modules, any number of values may be combined.
The default equation is N1 + N2 + N3 + N4, which adds all four input values. Any of the available mathematical operators may be used in the expression.
The output Result Value port produces the numeric value resulting from the equation. The value will update when any of the input values are changed.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Value 1 | Number | A value to use as a variable. |
| Input | Input Value 2 | Number | A value to use as a variable. |
| Input | Input Value 3 | Number | A value to use as a variable. |
| Input | Input Value 4 | Number | A value to use as a variable. |
| Output | Output Value 1 | Number | A value to use as a variable. |
| Output | Output Value 2 | Number | A value to use as a variable. |
| Output | Output Value 3 | Number | A value to use as a variable. |
| Output | Output Value 4 | Number | A value to use as a variable. |
| Output | Result Value | Number | A value created by solving the module expression. |
Properties
| Property | Type | Description |
|---|---|---|
| Expression | String | The Expression allows the user to control the sequence of variables used to create the output double value. |
| N1 | Double | A double value that can be used as the variable {N1} in the expression. |
| N2 | Double | A double value that can be used as the variable {N2} in the expression. |
| N3 | Double | A double value that can be used as the variable {N3} in the expression. |
| N4 | Double | A double value that can be used as the variable {N4} in the expression. |
| Result | Double | The output double value created by resolving the Expression. |
create tin
The create tin module is used to convert scattered sample data into a three-dimensional surface of triangular cells representing an unstructured mesh.
“Scattered sample data” means that there are discrete nodes in space. An example would be geology or analyte (e.g. chemistry) data where the coordinates are the x, y, and elevation of a measured parameter. The data is “scattered” because there is not necessarily an implicit grid of data.
Create tin uses a proprietary version of the Delaunay tessellation algorithm.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Points | Field | The main input field consisting of points or lines. |
| Output | Output Field | Field | The field with selected data. |
| Output | Output Object | Renderable | A renderable object displaying the selected data. |
Properties
| Property | Type | Description |
|---|---|---|
| Color By | Choice: Node Data, Cell Data, Solid Color | The Color By selection sets the data map of the output TIN. |
| Nodal Data Component | Choice | If Color By is set to Node Data, the Nodal Data Component selects which nodal data will set the data map. |
| Cell Data Component | Choice | If Color By is set to Cell Data, the Cell Data Component selects which cell data will set the data map. |
| Vector Component | Integer | If Color By is set to Node Data, the Vector Component allows the user to use just a single component of a vector data to set the data map. |
| Use Vector Magnitude | Boolean | If Color By is set to Node Data, allows the user to use the magnitude of a vector data to set the data map. |
| Object Color | Color | If Color By is set to Solid Color, the Object Color will set the data map. |
material to cellsets
The material to cellsets module is intended to receive a 3D field into its input port which has been processed through a module like plume. If the original field (pre-plume) had multiple cell sets related to geologic units or materials, the output of plume will generally have only two cell sets which comprise all hexahedron and all tetrahedron cells. The ability to control the visibility of the layer-cell sets is normally lost.
This module takes plume’s output and recreates the cell sets based on nodal data. However, since each geologic layer will likely have two cell sets each (one for all hexahedron and all tetrahedron cells), the output tends to have twice as many cell sets as the original pre-plume field.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Field | Field | The field containing the data to create cell sets with. |
| Input | Geologic Legend Input Information | Geology Legend | Geologic legend input information. |
| Output | Output Field | Field | A field containing cell sets created by input data. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | The Allow Run toggle, when deselected, will prevent the module from running. |
| Execute | Button | This button will force the module to run even if the Allow Run toggle has been turned off. This allows the user to make a number of changes before updating. |
| Data Type | Choice: Nodal Data, Cell Data | The Data Type selects either nodal or cell data to be used to create cell sets. |
| Nodal Data Component | Choice | The data from the input field that is used to set cell sets. |
| Cell Data Component | Choice | The data from the input field that is used to set cell sets. |
loop
The loop module iterates an operation. For example, you could use a loop object to control the movement of an object in your application, such as incrementing the movement of a slider for a slice plane.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Starting Value | Number | Starting value used for animation range. |
| Input | Input Ending Value | Number | End value used for animation range. |
| Input | Input Current Value | Number | Current value of interest. |
| Output | Output Starting Value | Number | Starting value used for animation range. |
| Output | Output Ending Value | Number | Ending value used for animation range. |
| Output | Output Current Value | Number | Current value of interest. |
Properties
| Property | Type | Description |
|---|---|---|
| Current Value | Double | The current value of interest. |
| Loop | Loop | The Loop controls setting the Current Value by specified increments. |
| Starting Value | Double | The starting value is the beginning value for the simulation. |
| Ending Value | Double | The ending value is the end value for the simulation. |
| Step Size | Double | The Step Size value specifies a factor for the increment for advancement when stepping or running. |
modify data 3d
The modify data 3d module provides the ability to interactively change data in 3D volumetric models. This is not a recommended practice since volumetric models created in EVS generally have underlying statistical measures of quality that will be meaningless if the data is modified in any way.
However, it is not unusual for a model to occasionally have regions where extrapolation artifacts cause shards of plumes to appear. This module provides a way to remove those.
The basic approach is to move the modification sphere to the problem region and set the size and shape of the ellipsoid before changing your data.
Note: This module does not modify the upstream data.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Field | Field | The field containing the data to be modified. |
| Input | Z Scale | Number | The factor for vertical scaling. |
| Output | Output Field | Field | A field containing the field with modified data. |
| Output | SampleData | Renderable | A renderable object displaying the selected data. |
Properties
| Property | Type | Description |
|---|---|---|
| Transition Option | Choice: Linear, Non-Linear | The Transition Option control allows the user to select how the values are modified. Linear causes the weighting to be a straight line from the Inner Weighting value to zero at the outer change radius. Non-Linear is a smooth transition from the Inner Weighting value to zero at the outer change radius. |
| Anisotropy | Double | The Anisotropy is the ratio of the change radius in the x-y plane to the vertical (z) direction for undistorted coordinates. |
| Pre Altered Z Scale | Double | Pre-Altered Z Scaling is the z-exaggeration you are using for display purposes. |
| Create Output Field | Button | Create Modified Output Field button causes the modified data to be output. |
Modification Settings
| Property | Type | Description |
|---|---|---|
| X Center | Double | The X Center slider controls the center of the change sphere. |
| Y Center | Double | The Y Center slider controls the center of the change sphere. |
| Z Center | Double | The Z Center slider controls the center of the change sphere. |
| Glyph Display Radius | Double | Glyph Display Radius is the size (in your units) of the spherical glyph that identifies the center modification location. |
| Modification Value | Double | The Modification Value is the value to change (clamp) the data set. |
| Inner Weighting | Double | The Inner Weighting is the constant value over the inner change radius. |
| Inner Change Radius | Double | The Inner Change Radius is the radius in the x-y plane of the region affected at the constant Inner Weighting. |
| Outer Change Radius | Double | The Outer Change Radius is the radius in the x-y plane of the total region affected. |
Display Settings
| Property | Type | Description |
|---|---|---|
| Display Points | Boolean | The Display Points toggle controls whether the affected nodes (cloud of points) will be displayed. |
create mask
The create mask module creates convex and concave hulls from input point data. The resulting mask can be output as a triangulated surface or as lines.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Field | Field | The input field with the nodes to create the mask from. |
| Output | Output Field | Field | The output mask field. |
| Output | Output Object | Renderable | A renderable object to display. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | This toggle can prevent the module from running. Allowing the user to make changes to large data sets without waiting for updates. |
| Execute | Button | This button will force the module to run even if the Allow Run toggle has been turned off. This allows the user to make a number of changes before updating. |
| Mask Type | Choice: Convex, Concave | Controls whether the output is a convex or concave hull. |
| Bridging Target | Double | Distance between two points used to determine the fidelity of the concave hull in coordinate system units. |
| Disconnected Regions | Integer | This value represents the estimated number of disconnected regions in the input, which is used to determine the optimal default Bridging Distance value. |
| Offset | Double | This value represents the offset in user coordinates the resulting mask will be inflated by. |
| Arc Resolution | Integer | This specifies the number of points used on each corner for smoothing if a value in the Offset option other than 0 is chosen. An Arc Resolution of 1 results in just the corner point without any smoothing. |
| Output As Surface | Boolean | If enabled, this option will output the resulting mask as a triangulated surface. Otherwise, the output will be lines. |
| Z Position | Double | Z Position determines the Z location of the output. This allows you to position the output at the most convenient elevation. |