Calculate the volumes and masses of soil, and chemicals in soils and ground water.
Calculate the volumes and masses of soil, and chemicals in soils and ground water at each cell.
Calculate the surface area of the entire field input.
Calculate and display statistics about the data contained in the selected file.
Analyze the statistical distribution of a single data from a field.
Perform initial site assessment and well location planning.
Subsections of Analysis
volumetrics
The volumetrics module calculates the volumes and masses of soil, water, air, and chemicals within a user specified domain (typically a constant concentration shell intersected with a set of geologic layers). The user selects the basis (Soil, Groundwater, Soil Vapor, or Volume Only), the analyte and coordinate units, and the soil and chemical properties used in the calculation. The module integrates volumes and masses across all cells in the input field and reports results in the EVS Information Window and the module Properties panel.
The volumetrics module computes the volume and mass of everything passed to it. To compute the volume/mass of a plume, you must first use a module like plume or intersection to subset your model.
NOTE: Do not use plume shell or intersection shell upstream of volumetrics since their output is a hollow shell without any volume.
The volumetrics module computes volumes and masses of analytes using the following method:
- Each cell within the selected geologic units is analyzed.
- The mass of analyte within the cell is integrated based on concentrations at all nodes (and computed cell division points).
- The volumes and masses of all cells are summed.
- Centers of mass and eigenvectors are computed.
- For Soil basis, the mass of analyte is directly computed from the computed mass of soil (e.g. mg/kg). This is affected by the soil density parameter (all densities should be entered in g/cm³).
- For Groundwater basis, the mass of analyte (Chemical Mass) is computed by first determining the volume of water in each cell using the Water Filled Porosity parameter and each individual cell’s volume. From the cell’s water volume, the mass of analyte is directly computed (e.g. mg/L).
- The volume of analyte (Chemical Volume) is computed from the Chemical Mass using the Chemical Density parameter.
Connecting the Output Second Moment Object port to the viewer displays the second moment ellipsoid and the eigenvector lines (when enabled). Spatial moment analysis involves computing the zeroth, first, and second moments of a plume to provide measures of the mass, location of the center of mass, and spread of the plume.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Field | Field | The field to use for subsetting and calculations. |
| Input | String For Output | String | String to be added at the beginning of the Output Results file. |
| Input | Trigger | Other | Port that when changed causes the module to run. |
| Output | Numeric Output 1 | Number | A numeric value computed from the expression. |
| Output | Numeric Output 2 | Number | A numeric value computed from the expression. |
| Output | Numeric Output 3 | Number | A numeric value computed from the expression. |
| Output | String Output 1 | String | A string value computed from the expression. |
| Output | String Output 2 | String | A string value computed from the expression. |
| Output | Output Second Moment Object | Renderable | A renderable object displaying the second moment ellipse and mass lines. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | When the Allow Run toggle is set to on the module will run every time a setting is changed. |
| 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. |
| Z Scale | Double | The Z exaggeration factor applied to the input field. |
| Explode | Double | The Explode factor applied to the input field. |
| Update Information Window | Boolean | When on, the Information window receives a report every time the module is run. |
Input Settings
| Property | Type | Description |
|---|---|---|
| Nodal Data Component | Choice | The Nodal Data Component used to subset the input. Options are populated from the input field. |
| Nodal Units | Linked Analyte Unit | The Nodal Units are set based on the input data and the selected Nodal Data Component. The Multiplier is the ratio of the user’s input units to grams/grams (for example, 1e-6 for mg/kg/ppm). The Calculation Type determines what type of units to process the Nodal Data Component in. |
| Coordinate Units | Linked Coordinate Unit | The Coordinate Units are set based on the coordinate units of the input model. The Multiplier is the ratio of the user’s input units to liters (for example, 1000 for cubic meters). |
Processing Settings
| Property | Type | Description |
|---|---|---|
| Water Filled Porosity | Double | The fraction of total volume occupied by water. Used for Soil and Groundwater basis mass calculations. For Soil basis this is treated as the total water content of the soil matrix; for Groundwater it is the pore water fraction. |
| Air Filled Porosity | Double | The fraction of total volume occupied by air. Used for Soil Vapor basis mass and activity calculations. |
| Soil Density | Double | The Soil Density value allows the user to input the properties of the soil matrix in which the chemicals reside. If a combined soil and ground water plume is being estimated, set up a geologic boundary at the water table position so the soil and groundwater domains can be calculated separately. |
| Chemical Density | Double | The Chemical Density value allows the user to input the density of the chemical constituent for which mass estimates are being completed. This value is used to calculate the volume of chemical in the specified isosurface, as the mass units are calculated directly from the nodal data. |
| Water Density | Double | The Water Density value allows the user to specify the density of water. The default of 0.9999720 g/mL is the density of water at 4.5 degrees Celsius. |
| Volume Dollars | Double | The Volume Dollars value is used along with the total volume of the chemical to indicate the cost of the removal of the chemical. |
| Mass Dollars | Double | The Mass Dollars value is used, along with the total chemical mass, to determine the value of the chemical mass. |
Output Settings
| Property | Type | Description |
|---|---|---|
| Volume Units | Choice: Cubic Feet, Cubic Yards, Cubic Meters, Liters, Acre Feet, Barrels, Specify | Volume Units is used to select which units the volume should be calculated in. |
| Volume Units Ratio | Double | If the Volume Units is set to Specify, the user must set the Volume Units Ratio. The ratio should be the factor needed to convert between the user-specified units and liters. For example, for cubic meters the ratio would be 1000. |
| Volume Specified Units | String | If the Volume Units is set to Specify, the user must set the Volume Specified Units label. This label will be used in the output. |
| Mass Units | Choice: Kilograms, Metric Tons, Pounds, U.S. Short Tons, Ounces (Troy), Specify | Mass Units is used to select which units the mass should be calculated in. |
| Mass Unit Ratio | Double | If the Mass Units is set to Specify, the user must set the Mass Unit Ratio. The ratio should be the factor needed to convert between the user-specified units and kilograms. |
| Mass Specified Units | String | If the Mass Units is set to Specify, the user must set the Mass Specified Units label. This label will be used in the output. |
| Output Results To File | Boolean | The Output Results To File toggle causes volumetrics to write a file, specified by the Filename, that contains all volumetrics information in a format suitable for input to programs like Excel (tab delimited .txt file). The file is opened in append mode and will grow as volumetrics is run. Delete or move the file when finished with it. |
| Output String | String | The Output String will output a leading string for every entry into the output file. |
| Filename | String | If the Output Results To File toggle has been selected, the output filename must be set. |
| Output Filetype | Choice: Tabbed File (Excel), Mirror Display, Tabbed Multi-Line | The Output File Type choice is used to select the format of the output file. The default is a tab spaced single line output, the second choice formats the output the same as the display window, and the third option formats the output separated by tabs on multiple lines. |
| Overwrite File | Boolean | The Overwrite File toggle causes the output file to be written over instead of appended to. |
Area Moment Of Inertia
| Property | Type | Description |
|---|---|---|
| Display Mass Along Major Eigen Vector | Boolean | The Display Mass Along Major Eigen Vector toggle controls visibility of the mass-line along the major eigenvector. |
| Display Mass Along Minor Eigen Vector | Boolean | The Display Mass Along Minor Eigen Vector toggle controls visibility of the mass-line along the minor eigenvector. |
| Display Mass Along Interm Eigen Vector | Boolean | The Display Mass Along Interm Eigen Vector toggle controls visibility of the mass-line along the intermediate eigenvector. |
| Segments In Lines | Integer | The Segments In Lines value controls the number of segments making up each eigenvector line. The larger the number of segments, the closer the node data along the line will match the node data of the model, but at the cost of speed. |
| Color Lines By Axis | Boolean | The Color Lines By Axis toggle strips the node data from the lines, leaving them colored by the axis they represent. |
| Ellipsoid Resolution | Integer | Ellipsoid Resolution determines the number of faces used to approximate the analytically smooth ellipsoid. The higher the resolution, the smoother the ellipsoid. The Export Results button must be used to have an output port for the ellipsoid. |
| Ellipsoid Scale | Double | The Ellipsoid Scale is a scaling factor for the second moment ellipsoid. A value of 1.0 (default) is analogous to one-sigma (67%) statistical confidence. Higher values provide an indication of the size of the eigenvalues with a higher statistical confidence. |
| Ellipsoid Color | Color | The second moment ellipse is a solid color which can be selected using this control. |
Volumetric Output
| Property | Type | Description |
|---|---|---|
| Total Volume | Double | The total geometric volume of the selected domain. |
| Soil Mass | Double | The total mass of soil in the selected domain. Only applicable to Soil and Groundwater basis calculations. |
| Water Volume | Double | The total volume of water in the selected domain. Applicable to Groundwater basis. |
| Water Mass | Double | The total mass of water in the selected domain. Applicable to Groundwater basis. |
| Air Volume | Double | The total volume of air in the selected domain. Applicable to Soil Vapor basis. |
| Air Mass | Double | The total mass of air in the selected domain. Applicable to Soil Vapor basis. |
| Total Activity | Double | The total radon activity in the selected domain. Applicable to Soil Vapor basis with radon (activity) units. |
| Chemical Volume | Double | The output chemical volume. |
| Chemical Mass | Double | The output chemical mass. |
| Average | Double | The Average Concentration of the selected analyte (units match the Nodal Units control). |
| Volume Dollars | Double | The volume in volume dollars. |
| Mass Dollars | Double | The mass in mass dollars. |
| Center Of Mass | Coordinate 3D | The Center Of Mass of the output volume. |
Output Port Settings
| Property | Type | Description |
|---|---|---|
| Numeric Expression 1 | String | Python expression for the first numeric output port. Use variable names like SoilVolume, ChemicalMass, AverageConcentration, CenterOfMassX, etc. to reference volumetrics values. |
| Numeric Expression 2 | String | Python expression for the second numeric output port. |
| Numeric Expression 3 | String | Python expression for the third numeric output port. |
| String Expression 1 | String | Python f-string expression for the first string output port. Use {VariableName} placeholders such as {VolumeUnits}, {MassUnits}, {AnalyteName}, etc. to reference volumetrics values. |
| String Expression 2 | String | Python f-string expression for the second string output port. |
cell volumetrics
The cell volumetrics module provides cell-by-cell volumetrics data. It produces an output field with volume, mass, cell-center, and contaminant data attached to every cell in the grid. The user selects the analyte, basis, units, and soil properties, and the module computes volumetric data on a per-cell basis. Aggregate values across all selected cells are also reported in the Information window, and results can optionally be written to a tab-delimited file suitable for import into programs like Excel.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Field | Field | The field to use for calculations. |
| Input | String For Output | String | String to be added at the beginning of the Output Results file. |
| Output | Output Field | Field | The main output field with cell volumetric data. |
| Output | Numeric Output 1 | Number | A numeric value computed from the expression. |
| Output | Numeric Output 2 | Number | A numeric value computed from the expression. |
| Output | Numeric Output 3 | Number | A numeric value computed from the expression. |
| Output | String Output 1 | String | A string value computed from the expression. |
| Output | String Output 2 | String | A string value computed from the expression. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | When the Allow Run toggle is set to on the module will run every time a setting is changed. |
| 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. |
| Z Scale | Double | The Z exaggeration factor applied to the input field. |
| Explode | Double | The Explode factor applied to the input field. |
| Update Information Window | Boolean | When on, the module sends a structured aggregate report to the Information window every time it runs. |
Input Settings
| Property | Type | Description |
|---|---|---|
| Nodal Data Component | Choice | The Nodal Data Component used to subset the input. Options are populated from the input field. |
| Nodal Units | Linked Analyte Unit | The Nodal Units are set based on the input data and the selected Nodal Data Component. The Multiplier is the ratio of the user’s input units to grams/grams (for example, 1e-6 for mg/kg/ppm). The Calculation Type determines what type of units to process the Nodal Data Component in. |
| Coordinate Units | Linked Coordinate Unit | The Coordinate Units are set based on the coordinate units of the input model. The Multiplier is the ratio of the user’s input units to liters (for example, 1000 for cubic meters). |
Output Settings
| Property | Type | Description |
|---|---|---|
| Volume Units | Choice: Cubic Feet, Cubic Yards, Cubic Meters, Liters, Acre Feet, Barrels, Specify | Volume Units is used to select which units the volume should be calculated in. |
| Volume Units Ratio | Double | If the Volume Units is set to Specify, the user must set the Volume Units Ratio. The ratio should be the factor needed to convert between the user-specified units and liters. For example, for cubic meters the ratio would be 1000. |
| Volume Specified Units | String | If the Volume Units is set to Specify, the user must set the Volume Specified Units label. This label will be used in the output. |
| Mass Units | Choice: Kilograms, Metric Tons, Pounds, U.S. Short Tons, Ounces (Troy), Specify | Mass Units is used to select which units the mass should be calculated in. |
| Mass Unit Ratio | Double | If the Mass Units is set to Specify, the user must set the Mass Unit Ratio. The ratio should be the factor needed to convert between the user-specified units and kilograms. |
| Mass Specified Units | String | If the Mass Units is set to Specify, the user must set the Mass Specified Units label. This label will be used in the output. |
| Output Field Data | Multi-select: Current Cell, Cell Center X, Cell Center Y, Cell Center Z, Soil Volume, Soil Mass, Chem Volume, Chem Mass, Average Concentration, Water Volume, Water Mass, Air Volume, Air Mass, Total Activity | The Output Field Data selection determines which cell data components are included in the Output Field. |
| Output Results To File | Boolean | The Output Results To File toggle causes cell volumetrics to write a file, specified by the Filename, that contains all volumetrics information in a format suitable for input to programs like Excel (tab delimited .txt file). The file is opened in append mode and will grow as cell volumetrics is run. Delete or move the file when finished with it. |
| Overwrite File | Boolean | The Overwrite File toggle creates a new file when on, or appends to an existing file when off. |
| Filename | String | The filename for output. |
Output Port Settings
| Property | Type | Description |
|---|---|---|
| Numeric Expression 1 | String | Python expression for the first numeric output port. Use variable names like SoilVolume, ChemicalMass, AverageConcentration, CenterOfMassX, etc. to reference cell volumetrics aggregate values. |
| Numeric Expression 2 | String | Python expression for the second numeric output port. |
| Numeric Expression 3 | String | Python expression for the third numeric output port. |
| String Expression 1 | String | Python f-string expression for the first string output port. Use {VariableName} placeholders such as {VolumeUnits}, {MassUnits}, {AnalyteName}, etc. to reference cell volumetrics values. |
| String Expression 2 | String | Python f-string expression for the second string output port. |
compute surface area
The compute surface area module calculates the area of the entire field input. The input data must be a two-dimensional data field output from a 2D estimation, slice, or any subsetting module that outputs two-dimensional data (slice, plume with 2D input, or plume shell). The module can compute either the full 3D surface area or the projected 2D plan area, and the result is updated each time the input changes.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Field | Field | The field to use for subsetting. |
| Output | Output Area | Number | The integrated area. |
| Output | Units | String | The integrated area units. |
Properties
| Property | Type | Description |
|---|---|---|
| Z Scale | Double | The Z Scale is required to assure that the computed area is conformal to the scaled input data. |
| Area To Compute | Choice: 3D Surface Area, 2D Plan Area | Controls whether the 3D surface area of the input field or the projected 2D area is computed. |
| Integrated Area | Double | The integrated area of the input field. Read-only output value. |
| Area Units | String | The units of the input field squared. Read-only output value. |
file statistics
The file statistics module reads an analytical, lithology, or geologic file (.apdv, .aidv, .pgf, .geo, .gmf, .lpdv, .lsdv, .dg) and reports summary statistics and a frequency distribution for a selected data component. During execution, the module reads the file, displays an error message if the file contains errors in format or numeric values, and then displays the statistical results in the EVS Information window. The sample data and a glyphed renderable can be passed downstream from the output ports for visualization.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Filename | String | File used to display data. |
| Output | Output Filename | String | File used to display data. |
| Output | Sample Data | Field | A field containing the sample point data. |
| Output | Sample Object | Renderable | A renderable object displaying the sample data. |
| Output | Numeric Output 1 | Number | A numeric value computed from the expression. |
| Output | Numeric Output 2 | Number | A numeric value computed from the expression. |
| Output | String Output | String | A string value computed from the expression. |
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. |
| Filename | String | The file name to process for display. |
| Use Application Origin | Boolean | When true, the module will apply the Application Origin. When false, data will be left in internal model space. Turn off when loading data intended to use as a glyph or similar. |
Data Processing
| Property | Type | Description |
|---|---|---|
| Component Or Layer | Integer | The Data Component is used to select which file data component to process for display. |
| Data Processing | Choice: Linear Processing, Log Processing | Data Processing allows the module to be run in either linear or log space. |
| Z Scale | Double | The Z Scale is the vertical exaggeration to be applied to the output object. |
| Log Post Processing Clip Min | Double | Log Post Processing Clip Min replaces, after data processing, any sample property value that is less than the specified number in log space. |
| Linear Post Processing Clip Min | Double | Linear Post Processing Clip Min replaces, after data processing, any sample property value that is less than the specified number in linear space. |
| Detection Limit | Double | The Detection Limit value affects any file values set with the ‘ND’ or other non-detect flags (for a list of these flags open the help for the APDV file format). When the module encounters this flag in the file it will insert a value equal to (Detection Limit * LT Multiplier). |
| Less Than Multiplier | Double | The Less Than Multiplier is the value applied to any sample with the ‘<’ less than flag. |
Statistic Settings
| Property | Type | Description |
|---|---|---|
| Minimum Data Level | Double | The Minimum Data Level is used to set the lower limit on the data bins for statistical analysis. The default value is the minimum in the selected data component. If the statistical distribution should focus on only a portion of the data, this value can be changed to reflect only that desired range of data. |
| Maximum Data Level | Double | The Maximum Data Level is used to set the upper limit on the data bins for statistical analysis. The default value is the maximum in the selected data component. If the statistical distribution should focus on only a portion of the data, this value can be changed to reflect only that desired range of data. |
| Number Of Bins | Integer | The Number of Bins is used to set the number of distribution bins to be used in the analysis. The default is 10 and the range is from 2 to 255. |
| Summary Statistics | Statistics | A compound control that opens the full statistics view (histogram, percentiles, summary table) and exposes the computed values to the read-only fields below. |
| Data Min | Double | The minimum value in the selected data component. Read-only display field. |
| Data Max | Double | The maximum value in the selected data component. Read-only display field. |
| Processing | String | The data processing mode (Linear or Log). Read-only display field. |
| Mean | Double | The mean of the selected data component. Read-only display field. |
| Median | Double | The median of the selected data component. Read-only display field. |
| Std Dev | Double | The standard deviation of the selected data component. Read-only display field. |
Time Settings
| Property | Type | Description |
|---|---|---|
| Chem File Is Time Domain | Boolean | The Chem File Is Time Domain toggle turns on date interpolation for time-domain analyte (e.g. chemistry) files. |
| Specify Date By Component | Boolean | The Specify Date By Component toggle causes the Date field to be ignored and the date to be selected using the Data Component. |
| Date For Interpolation | Date | The Date For Interpolation field is the date being interpolated to. For example, if there is an analyte value of 2 on 1/01/05 and a value of 4 on 1/03/05 and the date is set to 1/02/05 with Direct Interpolation, the value would be 3. The Date can be either set here or passed in via the Date port. |
| Analyte Name | String | The Analyte Name field is used for AIDV and APDV time files, where the dates take up the spots in these files usually reserved for analyte names. |
| Interpolation Type | Choice: Direct Interpolation Only, Interpolate Only, Interpolate and Extrapolate Beyond, Interpolate and Extrapolate | The interpolation method defines how to interpolate analyte values to the chosen date. See Interpolation Methods below for a complete description of each option. |
| Use Nearest Measured Data | Boolean | The Use Nearest Measured Data toggle causes the sample at the interpolated date to take the value of the nearest measured date instead of an interpolated value. |
Interpolation Methods
Each interpolation method defines how to interpolate when given Missing values in a file. Non-Detect values are equal to either the Detection Limit or the Pre Clip Min. If the Date is set to the same time as a Non-Detect in the file, the sample will be a Non-Detect and not an interpolated value.
- Direct Interpolation Only: The most basic interpolation method, and the most accurate in terms of representing the data as it has been entered. Looks at the two dates surrounding the input Date. If either date, or both dates, have Missing as values, the value for that sample will be Missing and no interpolation will occur.
- Interpolate Only: Looks through the date columns both before and after the set Date for values that are not Missing, then interpolates between those numbers. If it fails to find a non-Missing value before and after the set date, it sets the data to Missing. Useful for files with a small amount of Missing values.
- Interpolate and Extrapolate Beyond: Looks through the date columns both before and after the set Date for the first instance of a value that is not Missing. If it does not find a valid non-Missing date after the input Date, it extrapolates beyond the last useable date to the input Date.
- Interpolate and Extrapolate: Looks through the date columns both before and after the set Date for the first instance of a value that is not Missing. If it fails to find one, it extrapolates the first value backwards to the input Date. If the date after the input Date is Missing, it looks forward through the time columns until it finds a date that is not Missing. It also extrapolates beyond the last valid date in the file.
Glyph Settings
| Property | Type | Description |
|---|---|---|
| Points As Glyphs | Boolean | The Points As Glyphs toggle causes the points to be displayed as a user-selected glyph. |
| Point Width | Integer | The Point Width sets the size of the rendered pixels. The default is 0, which is equivalent to 1. |
| Glyph Size | Double | The Glyph Size value is used to scale the glyphs in all directions. The default is automatically computed based on the input data. |
| Priority | Choice: Maximum, Minimum | The Priority of the glyph reverses the scaling so that the smallest sample values have the largest size. |
| Minimum Scale Factor | Double | The Minimum Scale Factor scales the sample values with the least Priority. |
| Maximum Scale Factor | Double | The Maximum Scale Factor scales the sample values with the greatest Priority. |
| Use Log Data | Boolean | The Use Log Data toggle forces the size of the glyph to be based on the log10 of the selected data. |
| Generated Glyph | Choice: Sphere, Cube, Cone, Cylinder, Polygon, Disk | The Generated Glyph choice selects the type of glyph that is automatically generated. |
| Sphere Subdivisions | Integer | The Sphere Subdivisions value defines how finely the sample spheres are rendered. Higher values mean smoother spheres but at a higher memory cost. |
| Glyph Resolution | Integer | The resolution for generated cone, polygon, cylinder, and disk glyphs. |
| Primary Axis Factor | Double | The scale factor for the primary axis of the glyph. |
| Secondary Axis Factor | Double | The scale factor for the secondary axis of the glyph. |
| Heading Dip | Heading/Dip | The Heading and Dip values are used to align the glyphs to a constant orientation. |
| Roll | Double | The roll of the glyph along its primary axis. |
Output Port Settings
| Property | Type | Description |
|---|---|---|
| Numeric Expression 1 | String | Python expression for the first numeric output port. Use variable names like Mean, Median, DataMin, DataMax, StdDev, Variance, FirstQuartile, ThirdQuartile, IQR, NumberOfPoints, NumberOfCells to reference statistics values. |
| Numeric Expression 2 | String | Python expression for the second numeric output port. |
| String Expression | String | Python f-string expression for the string output port. Use {VariableName} placeholders such as {Processing}, {Units}, {Report} to reference statistics values. |
statistics
The statistics module analyzes the statistical distribution of a single data component from an input field. The data field can contain any number of components, but statistical analyses can only be performed on scalar data; an error occurs if a statistical analysis is attempted on vector data. Output appears in the EVS Information Window and includes the calculated min and max values, mean, standard deviation, and the distribution of the data set, along with the coordinate extents of the model.
The first port (the leftmost one) should contain a mesh with nodal or cell data. If no data is present, statistics will only report the extents and centroid of the mesh. Data sent to the statistics module reflects any data transformation or manipulation performed in upstream modules.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Field | Field | The field to use for statistic calculations. |
| Output | Numeric Output 1 | Number | A numeric value computed from the expression. |
| Output | Numeric Output 2 | Number | A numeric value computed from the expression. |
| Output | String Output | String | A string value computed from the expression. |
Properties
| Property | Type | Description |
|---|---|---|
| Allow Run | Boolean | When the Allow Run toggle is set to on the module will run every time a setting is changed. |
| 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. |
Statistic Settings
| Property | Type | Description |
|---|---|---|
| Statistics On | Choice: Node Data, Cell Data | Choose whether to compute statistics on node data or cell data. |
| Data Component | Choice | The node data component on which the statistical analysis is to be performed. Options are populated from the input field. Enabled when Statistics On is set to Node Data. |
| Cell Data Component | Choice | The cell data component on which the statistical analysis is to be performed. Options are populated from the input field. Enabled when Statistics On is set to Cell Data. |
| Minimum Data Level | Double | The Minimum Data Level is used to set the lower limit on the data bins for statistical analysis. The default value is the minimum in the data component. If the statistical distribution should focus on only a portion of the data, this value can be changed to reflect only that desired range of data. |
| Maximum Data Level | Double | The Maximum Data Level is used to set the upper limit on the data bins for statistical analysis. The default value is the maximum in the data component. If the statistical distribution should focus on only a portion of the data, this value can be changed to reflect only that desired range of data. |
| Number Of Bins | Integer | The Number of Bins is used to set the number of distribution bins to be used in the analysis. The default is 10 and the range is from 2 to 255. This value is generally changed to get unary or aesthetically pleasing bin values. For example, if the data min is -3.0 and the data max is 2.0, setting the Number of Bins to 6 will result in unary bin values (e.g. -3, -2, -1, etc.). |
| Summary Statistics | Statistics | A compound control that opens the full statistics view (histogram, percentiles, summary table) and exposes the computed values to the read-only fields below. |
| Data Min | Double | The minimum value in the selected data component. Read-only display field. |
| Data Max | Double | The maximum value in the selected data component. Read-only display field. |
| Processing | String | The data processing mode (Linear or Log). Read-only display field. |
| Mean | Double | The mean of the selected data component. Read-only display field. |
| Median | Double | The median of the selected data component. Read-only display field. |
| Std Dev | Double | The standard deviation of the selected data component. Read-only display field. |
Output Port Settings
| Property | Type | Description |
|---|---|---|
| Numeric Expression 1 | String | Python expression for the first numeric output port. Use variable names like Mean, Median, DataMin, DataMax, StdDev, Variance, FirstQuartile, ThirdQuartile, IQR, NumberOfPoints, NumberOfCells to reference statistics values. |
| Numeric Expression 2 | String | Python expression for the second numeric output port. |
| String Expression | String | Python f-string expression for the string output port. Use {VariableName} placeholders such as {Processing}, {Units}, {Report} to reference statistics values. |
site planning
The site planning module supports initial site assessment and well location planning. It generates and distributes a specified number of points within the bounds of an input field using an iterative Lloyd’s algorithm, optionally honoring fixed points (from the Fixed Points port and/or a manual coordinate list). Output cells can be filtered by site type, and the result can be displayed as vertices or as sphere glyphs.
Ports
| Direction | Name | Type | Description |
|---|---|---|---|
| Input | Input Bounds | Field | The input field defining the spatial bounds for site planning. |
| Input | Fixed Points | Field | Optional fixed points that remain in place during the iterative distribution. |
| Output | Output Field | Field | The output points. |
| Output | Output Renderable | 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 | If Allow Run is turned off, the Execute button will force the module to run once with the current settings. |
Settings
| Property | Type | Description |
|---|---|---|
| Number Of Points | Integer | The number of points to generate and distribute within the bounds. |
| Iterations | Integer | The number of steps the iterative point distribution performs. Up to a certain point, a higher value usually yields better results, at the cost of speed. |
| Fixed User Points | Coordinate Array 2D | The Fixed User Points option is used to add fixed points manually, in addition to the fixed points from the Fixed Points port. |
| Select Cell Sets | Multi-select | The Select Cell Sets control allows the user to select the site types to output. |
Display Settings
| Property | Type | Description |
|---|---|---|
| Display As Spheres | Boolean | When the Display As Spheres toggle is enabled, the renderable port outputs the sites as sphere glyphs. Otherwise, the output will be vertices. |
| Glyph Size | Double | The Glyph Size value is used to scale the glyphs in all directions. The default is automatically computed based on the input data. |
| Z Scale | Double | The Z Scale is required to assure that generated sites are matched to scaled input. |
| Z Position | Double | Z Position determines the Z location of the output. This allows the output to be positioned at the most convenient elevation. |