Description

A standard interface to the filter standalone engine executable.

Standard Definitions

point_list:

A list of points, defined as: [[x0, y0, z0], ..., [xN, yN, zN]].

coded_point_list:

A tuple containing two items: the first item is a code (string), the second is the corresponding point_list. This data type is intended to mimic the srv file format. The code should match with an accompanying parameter file (survey code file). For example, ['BENCH', [[x0, y0, z0], ..., [xN, yN, zN]]]

face_list:

All face lists are described such that the first index indicates how many faces are in the face. For example,

[3, 1, 2, 3, 3, 4, 5, 6]

States that there are 3 vertexes in the first face, and those vertexes are 1, 2, 3. Then the next face contains 3 vertexes, which are 4, 5, 6. This may seem a bit confusing, but using this structure buys us some definite efficiencies. Note that all faces in MineSight® products have 3 vertexes.

Functions

filter(pointList, faceList, dir, angle, length, debug)

Filter removes unwanted data from triangulation. The function returns the filtered solid/surface.

Arguments:

pointList : point_list

Points of the triangulated surface.

faceList : face_list

Faces of the triangulated surface.

dir : string

Define a directory with input files.

angle : integer

Delete triangles that have angle less than this value.

length : integer

Delete triangles that have side longer than this value.

debug : integer

Debug option will output the command string used to call the engine executable and will relay any output messages from the engine. Set value to 1 to turn on this option.

Returns:

A tuple containing: point_list, face_list (see Standard Definitions).

Example:

from grail.engines import filter

pts = [[76.0, 2085.0, 2261.0],[98.0, 2074.0, 2242.0],[261.0, 2074.0, 2240.0],[91.0, 2074.0, 2269.0]]
fcs = [3,2,1,3,3,3,1,0]

#use keyword arguments in function call
points, faces = filter.filter(pointList=pts, faceList=fcs, length=50)