legend

The legend module is used to place a legend which help correlate colors to analytical values or materials . The legend shows the relationship between the selected data component for a particular module and the colors shown in the viewer. For this reason, the legend’s RED input port must be connected to the RED output port of a module which is connected to the viewer and is generally the dominant colored object in view.

Many modules with red output ports have a selector to choose which ONE of the nodal or cell data components are to be used for coloring. The name of the selected data component will be displayed as the Title of the legend if the Label Options are set to Automatic (default).

If the data component to be viewed is either Geo_Layer or Material_ID (for models where the grid is based upon geology), the Geologic legend Information port from gridding and horizons (or lithologic modeling) must also be connected to legend to provide the Geologic Layer (or material) names for automatic labeling. When this port is connected it will have no affect if any other data component is selected.

The minimum and maximum values are taken from the data input as defined in the datamap. Labels can be placed at user defined intervals along the color scale bar. Labels can consist of user input alphanumerical values or automatically determined numerical values.

Module Input Ports

• Geologic legend Information [Geology legend] Accepts the geologic material information from modules that read geologic data.
• Contour Levels [Contours]: Accepts an array of values representing values to be labeled in the legend.
• Input Object [Renderable]: Accepts the output of a module to which the legend corresponds.

Module Output Ports

• Output legend [Field] Outputs the legend as a field to allow texturing
• Title Output [String] Can be connected to the 3d estimation, 3D_Geology Map, and surface from horizons(s) modules.
• Output Object [Renderable]: Outputs to the viewer.

Properties and Parameters

The Properties window is arranged in the following groups of parameters:

• Label Options: controls the legend labeling
• Scale Options: controls the legend size and placement

Text Formatting:

Text formatting can be performed with a very restrictive subset of Markdown Syntax

• Bold **bold text**

• Italic _italicized text_

• Headings (Larger and bolder text)

  • H1

  • H2

  • H3

The legend module is used to place a legend which help correlate colors to analytical values or materials . The legend shows the relationship between the selected data component for a particular module and the colors shown in the viewer. For this reason, the legend’s RED input port must be connected to the RED output port of a module which is connected to the viewer and is generally the dominant colored object in view.

Many modules with red output ports have a selector to choose which ONE of the nodal or cell data components are to be used for coloring. The name of the selected data component will be displayed as the Title of the legend if the Label Options are set to Automatic (default).

If the data component to be viewed is either Geo_Layer or Material_ID (for models where the grid is based upon geology), the Geologic legend Information port from gridding and horizons (or lithologic modeling) must also be connected to legend to provide the Geologic Layer (or material) names for automatic labeling. When this port is connected it will have no affect if any other data component is selected.

The minimum and maximum values are taken from the data input as defined in the datamap. Labels can be placed at user defined intervals along the color scale bar. Labels can consist of user input alphanumerical values or automatically determined numerical values.

Module Input Ports

• Geologic legend Information [Geology legend] Accepts the geologic material information from modules that read geologic data.
• Contour Levels [Contours]: Accepts an array of values representing values to be labeled in the legend.
• Input Object [Renderable]: Accepts the output of a module to which the legend corresponds.

Module Output Ports

• Output legend [Field] Outputs the legend as a field to allow texturing
• Title Output [String] Can be connected to the 3d estimation, 3D_Geology Map, and surface from horizons(s) modules.
• Output Object [Renderable]: Outputs to the viewer.

Properties and Parameters

The Properties window is arranged in the following groups of parameters:

• Label Options: controls the legend labeling
• Scale Options: controls the legend size and placement

Text Formatting:

Text formatting can be performed with a very restrictive subset of Markdown Syntax

• Bold **bold text**

• Italic _italicized text_

• Headings (Larger and bolder text)

  • H1

  • H2

  • H3

axes

General Module Function

The axes module is used to place 3D axes in the viewer scaled by the model data and/or user defined limits. Axes accepts data from many of the Subsetting and Processing modules and outputs directly to the viewer. Data passed to Axes should come from modules which have scaled or transformed the mesh data, for example explode_and_scale. Axes generated by axes and displayed in the viewer are transformable with other objects in the viewer.

The User interface to axes is very comprehensive. Each coordinate direction axis can be individually controlled. Axis labels and tick marks for each axes can be specified. The label font, label precision, label orientation, and other label parameters are all user specified. Many of the parameters do not have default values that will produce the desired results because many variables control how the axes should be defined.

axes requires a field input to position and size the axes. If you disconnect the (blue/black) field input port, you no longer lose the axes bounds values and your axes remain in place. This is useful when field data changes in an animation so that you don’t constantly recreate the axes.

Also, the size of text and tick marks is based on a percentage of the x-y-z extent of the input field. This now allows you to set the extent of one or more axes to zero so you can have a scale of only one or two dimensions.

Module Input Ports

• View[View] This is the primary Purple port which connects to the viewer to receive the extent of all objects in the viewer AND outputs the axes.
  • This port can be used as your only connection from axes to the viewer and no other connections are needed.
• Input Geologic Field [Field] Accepts a field to receive the extent
• Input Objects [Renderable]: Accepts a renderable output port to receive the extent
• Minor Ports not needed for most all cases
  • Z Scale [Number] Accepts Z Scale (vertical exaggeration) from other modules
  • Explode [Number] Accepts the Explode distance from other modules

Module Output Ports

• Output Object [Renderable] Outputs the axes to the viewer.

Properties and Parameters

The Properties window is arranged in the following groups of parameters:

• Properties: controls the scaling and exploding
• Spatial Definition: Controls the extents and grid densities
• Display Settings: controls layer exploding and cell sets
• All Axes Settings: Controls parameters for XYZ simultaneously
• X Axes Settings: Controls parameters for X axis
• Y Axes Settings: Controls parameters for Y axis
• Z Axes Settings: Controls parameters for Z axis

in_view (Purple) : This port accepts the output of the viewer directly. It will draw the axes around everything displayed in the viewer. This port will only cause the module to run when the port is connected or when the “Accept Current Values” button is pressed. If the models coordinate extents are going to change often then another input port should be used.

objects_in (Red) : This port accepts any number of (Red) output ports from other modules. When any of those modules are run the axes module will run as well.

meshs_in (Blue/Black) : This port accepts any number of (Blue/Black) output ports from other modules. When any of those modules are run the axes module will run as well.

explode (Grey/Green) : This port accepts a float value representing the explode distance from explode_and_scale. If you have an explode distance set to anything but 0, the Z axis tick labels are not printed.

z_scale (Grey/Brown) : This port accepts a float value representing Z exaggeration of the model from modules like explode_and_scale to ensure that the Z axis is correctly labeled.

direction indicator

The direction indicator module is used to place a 3D North Arrow or Rose Compass in the 3D viewer scaled by the model data and/or user defined parameters.

Module Input Ports

• View[View] This is the primary Purple port which connects to the viewer to receive the extent of all objects in the viewer AND outputs the north arrow or compass rose.
  • This port can be used as your only connection from direction indicator to the viewer and no other connections are needed.
• Minor Ports not needed for most all cases
  • Z Scale [Number] Accepts Z Scale (vertical exaggeration) from other modules
  • Explode [Number] Accepts the Explode distance from other modules

Module Output Ports

• Output For Transform [Renderable] Provides an additional output port if you want to duplicate place_text’s output via a transform_group module.

Properties and Parameters

The Properties window is arranged in the following groups of parameters:

• Properties: controls the scaling and positioning
• North Arrow Settings:
• Compass Rose Settings:

viewer to frame

The viewer to frame module is used to place a image of one viewer inside a second viewer’s non-transformable overlay. It is extremely easy to use.

There are sliders to adjust size and position.

Module Input Ports

• View [View] Connects to the viewer used as an overlay

Module Output Ports

• Output Object [Renderable] Outputs the input view as a 2D overlay in the viewer.

add_logo

The add_logo module is used to place a logo or other graphic object in the viewer’s non-transformable overlay. It is extremely easy to use. There are sliders to adjust size and position and a button to select the image file to use as a logo.

Module Input Ports

• View [View] Connects to the viewer

Module Output Ports

• Output Object [Renderable] Outputs the logo as a 2D overlay in the viewer.

titles

Titles connects to the red port on the viewer and provides a means to place text in the non-transformable 2D Overlay of the viewer. The text is not transformed by viewer transformations and is positioned using sliders in the Titles user interface.

Module Input Ports

• Input String [String] Accepts the string to display.
• Number 1 [Number]: Accepts a number used to construct a the title. (this is effectively a simple version of format_string
• Number 2 [Number]: Accepts a number used to construct a the title
• String 1 [String]: Accepts a number used to construct a the title

Module Output Ports

• Output Object [Renderable]: Outputs to the viewer. NOT REQUIRED when the View port is used.

Text Formatting:

Text formatting can be performed with a limited subset of Markdown Syntax.

• If you need multiple spaces or need to indent with spaces, you must use this instead of a space: ** **

  • 4 spaces in a row would be: ** ** ** ** ** ** ** **

• **bold** = bold

• _italics_ = italics

• Numbered List

  • 1. First Item
    2. Second Item
    3. Third Item
  • Only works with Left Justified text

• Bulleted List

  • • First Item
    • Second Item
    • Third Item
  • Only works with Left Justified text

• Monospaced the text to be monospaced is surrounded by *tick* marks

  • Note: This uses the Tick mark which is the character below the tilde "~"

• Horizontal Rule (line across entire width) ___

  • Note: three underscore characters

• Colored Text

• This is the default text, but<font color="#FF0000">these words are red.</font>

• Font Size

• Some big text in the middle

Font Change

• Some larger Monospaced Font text in the middle.
• <h?> … </h?> Heading (?= 1 for largest to 6 for smallest, eg h1)
• ** … ** Bold Text
• • … * Italic Text
• … Underline Text
• … Strikeout
• ^… Superscript - Smaller text placed below normal text
• _… Subscript - Smaller text placed below normal text
• … Small - Fineprint size text

3d titles

3d titles connects to the red port on the viewer and provides a means to place text in 3D space of your model. The text is transformed by viewer transformations and is positioned using X, Y & Z sliders in the Titles user interface.

Module Input Ports

• Input String [String] Accepts the string to display.

Module Output Ports

• Output Object [Renderable]: Outputs to the viewer. NOT REQUIRED when the View port is used.

place_text

place_text replaces both Text3D and MultiText3D and provides a means to interactively place 2D and 3D renderable text strings or to read a .PT File (or legacy .EMT file) to place the text.

Module Input Ports

• View [View] This is the primary Purple port which connects to the viewer to receive the extent of all objects in the viewer AND outputs the test.
• This port can be used as your only connection from place_text to the viewer and no other connections are needed.
• Minor Ports not needed for most all cases
  • Z Scale [Number] Accepts Z Scale (vertical exaggeration) from other modules
  • Explode [Number] Accepts the Explode distance from other modules

Module Output Ports

• Output For Transform [Renderable] Provides an additional output port if you want to duplicate place_text’s output via a transform_group module.
• Minor Ports not needed for most all cases
  • Z Scale [Number] Outputs Z Scale (vertical exaggeration) to other modules
  • Explode [Number] Outputs the Explode distance to other modules

interactive_labels

The interactive_labels module allows the user to place formatted labels at probed locations within the viewer. The data displayed is the data at the probed location

Module Input Ports

• Z Scale [Number / minor] Accepts Z Scale (vertical exaggeration) from other modules
• Number Variable [Number / minor] Accepts a number to be used in the expression
• Input String Variable [String / minor] Accepts a string to be used in the expression
• View [View / minor] Connects to the viewer to allow probing on all objects.

Module Output Ports

• Z Scale [Number / minor] Outputs Z Scale (vertical exaggeration) to other modules
• Output Number Variable [Number / minor] Outputs a number to be used in the expression
• Output String Variable [String / minor] Outputs a string to be used in the expression
• Output Object [Renderable] Outputs to the viewer.

format_string

format_string allows you to construct a complex string (for use in titles or as file names) using multiple string and numeric inputs. An expression determines the content of the output.

The Expression is treated as Python f-string which allows for the use of the variables with Python expressions.

Module Input Ports

• Date [Number] Accepts a date
• Number 1 [Number] Accepts a number
• Number 2 [Number] Accepts a number
• Number 3 [Number] Accepts a number
• Number 4 [Number] Accepts a number
• String 1 [String] An input string
• String 2 [String] An input string
• String 3 [String] An input string

Module Output Ports

• Output String [String] The resultant string output

Note: Strings cannot be formatted or subsetted

The available floating point presentation types are:

• ’e’ - Exponent notation. Prints the number in scientific notation using the letter ’e’ to indicate the exponent.
• ‘E’ - Exponent notation. Same as ’e’ except it converts the ’e+XX’ to uppercase ‘E+XX’ .
• ‘f’ - Fixed point. Displays the number as a fixed-point number.
• ‘g’ - General format. For a given precision p >= 1, this rounds the number to p significant digits and then formats the result in either fixed-point format or in scientific notation, depending on its magnitude.

  • The precise rules are as follows: suppose that the result formatted with presentation type ’e’ and precision p-1 would have exponent exp. Then if -4 <= exp < p, the number is formatted with presentation type ‘f’ and precision p-1-exp. Otherwise, the number is formatted with presentation type ’e’ and precision p-1. In both cases insignificant trailing zeros are removed from the significant, and the decimal point is also removed if there are no remaining digits following it.

    • Positive and negative infinity, positive and negative zero, and nans, are formatted as inf, -inf, 0, -0 and nan respectively, regardless of the precision.
    • A precision of 0 is treated as equivalent to a precision of 1.
    • The default precision is 6.
• ‘G’ - General format. Same as ‘g’ except switches to ‘E’ if the number gets to large.
• ’n’ - Number. This is the same as ‘g’, except that it uses the current locale setting to insert the appropriate number separator characters.
• ‘%’ - Percentage. Multiplies the number by 100 and displays in fixed (‘f’) format, followed by a percent sign.
• ’’ (None) - similar to ‘g’, except that it prints at least one digit after the decimal point.

The following are example formats and the resultant output:

• N1 = 3.141592654 | Expression set to {N1:.4f} | Result is 3.1416
• N1 = 12345.6789 | Expression set to {N1:.6e} | Result is 1.234568e+04
• N1 = 123456789.0123 | Expression set to {N1:.6G} | Result is 1.23457E+08
• N1 = 123456789.0123 | Expression set to {N1:.6g} | Result is 1.23457e+08
• N1 = 123456.0123 | Expression set to {N1:.6G} | Result is 123456
• N1 = 123456.0123 | Expression set to {N1:.9G} | Result is 123456.012
• N1 = 123456.0123 | Expression set to {N1:.5f} | Result is 123456.01230
• N1 = 0.893 | Expression set to {N1:.2%} | Result is 89.30%
• N1 = 3.141592654 | Expression set to {N1} | Result is 3.141592654

f-string examples:

• N1 = 3.06 | S1 = “TOTHC Above 3.060 mg/kg”

  • Expression set to {S1.split()[0]} above {N1*1000:,.0f} ug/kg
  • Result is TOTHC above 3,060 ug/kg

REFERENCE: https://www.python.org/dev/peps/pep-3101/

F-STRING REFERENCE: https://www.python.org/dev/peps/pep-0498/

Notes:

1. Because the format depends on the current locale, care should be taken when making assumptions about the output value. Field orderings will vary (for example, “month/day/year” versus “day/month/year”), and the output may contain Unicode characters encoded using the locale’s default encoding (for example, if the current locale is , the default encoding could be any one of , , or ; use to determine the current locale’s encoding).

2. The method can parse years in the full [1, 9999] range, but years < 1000 must be zero-filled to 4-digit width.

   Changed in version 3.2: In previous versions, method was restricted to years >= 1900.

   Changed in version 3.3: In version 3.2, method was restricted to years >= 1000.

3. When used with the method, the directive only affects the output hour field if the directive is used to parse the hour.

4. Unlike the module, the module does not support leap seconds.

5. When used with the method, the directive accepts from one to six digits and zero pads on the right. is an extension to the set of format characters in the C standard (but implemented separately in datetime objects, and therefore always available).

6. For a naive object, the and format codes are replaced by empty strings.

   For an aware object:

• • is transformed into a 5-character string of the form +HHMM or -HHMM, where HH is a 2-digit string giving the number of UTC offset hours, and MM is a 2-digit string giving the number of UTC offset minutes. For example, if returns , is replaced with the string .
• • If returns , is replaced by an empty string. Otherwise is replaced by the returned value, which must be a string.

  Changed in version 3.2: When the directive is provided to the method, an aware object will be produced. The of the result will be set to a instance.

7. When used with the method, and are only used in calculations when the day of the week and the year are specified.

Copyright ^© 2001-2014 Python Software Foundation; All Rights Reserved