The site planning module is used to perform 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 algorithm. The module supports fixed user-specified points and can filter output by cell set type. Results can be displayed as vertices or 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 add fixed points manually and additionally 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 red port will output 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 your 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 you to position the output at the most convenient elevation.