Complete Python Module List

arrow

Interface for Vulcan design arrows.

set_auto_scale (arrow self, bool autoscale=True): Sets the arrow auto scale setting.

get_arrow_type (arrow self) → std::string: Gets the arrow type (2D/3D).

set_arrow_type (arrow self, std::string const & type): Sets the arrow type.

get_end (arrow self) → point: Gets the arrow end point.

set_end (arrow self, point point): Sets the arrow end point.

is_filled (arrow self) → bool: Returns the arrow fill setting.

set_filled (arrow self, bool filled=True): Sets the arrow fill setting.

get_head_length (arrow self) → double: Gets the arrow head length.

set_head_length (arrow self, double percentage): Sets the arrow head length.

get_head_width (arrow self) → double: Gets the arrow head width.

set_head_width (arrow self, double percentage): Sets the arrow head width.

get_normal (arrow self) → point: Gets the arrow normal.

set_normal (arrow self, point point): Sets the arrow normal.

get_num_facets (arrow self) → int: Gets the number of facets.

set_num_facets (arrow self, int facets): Sets the number of facets.

get_relative_head_length (arrow self) → double: Gets the relative arrow head length.

set_relative_head_length (arrow self, double percentage): Sets the relative arrow head length.

get_relative_head_width (arrow self) → double: Gets the relative arrow head width.

set_relative_head_width (arrow self, double percentage): Sets the relative arrow head width.

get_scale (arrow self) → std::string: Gets the arrow scale.

set_scale (arrow self, std::string const & scale): Sets the arrow scale.

get_scaled_head_length (arrow self) → double: Gets the scaled head length of the arrow.

get_scaled_head_width (arrow self) → double: Gets the scaled head width of the arrow.

get_start (arrow self) → point: Gets the arrow starting point.

set_start (arrow self, point point): Sets the arrow starting point.

attributes

Class for accessing object attribute data.

template_list ( attributes self ) → str_list: List of templates defined for the object.

attribute_list ( attributes self, std::string const & temp ) → str_list: List of attributes in a given template.

get_template ( attributes self, std::string const & temp ) → MVariant: Gets the dictionary for a given template.

set_template ( attributes self, std::string const & temp, MVariant & data ): Sets the attributes of a template from a dictionary.

get_attribute ( attributes self, std::string const & temp, std::string const & attribute ) → MVariant: Gets a single attribute.

get_date_attribute ( attributes self, std::string const & temp, std::string const & attribute ) → mtk::datetime::DateTime: Gets a date attribute as a Python datetime object.

set_attribute ( attributes self, std::string const & temp, std::string const & attribute, MVariant & value ): Sets a single attribute.

as_dict ( attributes self ) → MVariant: Gets the attribute data as a dictionary.

from_dict ( attributes self, MVariant & data ): Sets the attribute data from a dictionary.

block_model

Interface for Vulcan block models.

add_block(self, x0, y0, z0, x1, y1, z1) -> int: Add a new block to the model.

add_variable(self, *args, **kwargs) -> int: Add a variable to a block model.

block_extent(self) -> list: Get the extent of the currently selected block.

close(self) -> int: Close the block model file.

create_irregular(self, name, x0, y0, z0, x1, y1, z1, nx, ny, nz, sub_nx, sub_ny, sub_nz) -> int: Create a new irregular block model optionally with a sub schema.

create_regular(self, name, x0, y0, z0, x1, y1, z1, nx, ny, nz) -> int: Create a new regular block model.

create_strat(self, name, x0, y0, z0, x1, y1, z1, nx, ny) -> int: Create a new stratigraphic block model.

creation_date(self) -> string: Check when the block model was created.

delete_variable(self, name) -> int: Remove a variable from the block model.

description(self) -> string: Get the description of the block model.

field_default(self, name) -> float: Get the default value of a numeric variable.

field_default_string(self, name) -> string: Get the default value of a string variable.

field_description(self, name) -> string: Get the description of a variable.

field_index(self, name) -> int: Get the index of a given variable in the block model.

field_list(self) -> list: Get the list of variables for the block model.

field_list_numbers(self) -> list: Get the list of numeric variables for the block model.

field_list_strings(self) -> list: Get the list of string variables for the block model.

field_predefined(self, name) -> int: Check if a variable is a predefined field.

field_type(self, name) -> string: Get the type of a field.

find_world_xyz(self, x, y, z) -> int: Find a block at given real world coordinates and set the record position.

find_world_xyz_seam(self, p, seam) -> int
find_world_xyz_seam(self, x, y, z, seam) -> int: Find the seam at given real world coordinates.

find_xyz(self, x, y, z) -> int: Find a block at given model coordinates and set the record position.

find_xyz_seam(self, p, seam) -> int find_xyz_seam(self, x, y, z, seam) -> int: Find the seam at given model coordinates.

get(self, name) -> float get(self, k) -> float: Get the numeric value of a variable, either by name or by index.

get_data( self, var, sel=None) -> numpy.array: Gets the values of a set of blocks, or all blocks if no selection is provided.

get_grid( self, var ) -> numpy.array: Returns a 3D i/j/k grid of block model values for a regular block model.

get_matches(self, match_string) -> numpy.ndarray[Int64]: Get the blocks that match the given match arguments.

get_matches_extent(self, match_string) -> tuple[numpy.ndarray]: Get a list of NumPy arrays containing the block IDs and extents of each block selected in the match.

get_multiple(self, fields) -> list: Get the values of a list of numeric variables.

get_multiple_string(self, fields) -> list: Get the values of a list of string variables.

get_pandas( self, vars=None, select=None ) -> pandas.DataFrame: Gets block model data as a pandas.DataFrame.

get_pandas_extent( self, vars=None, select=None ) -> pandas.DataFrame: Gets all matches within an extent.

get_regular_indices(self) -> numpy.ndarray[Int64]: Get the indices of a regular block model, in i/j/k order.

get_translation_values(self, field_name) -> list: Get the translation values for a field.

get_variable_index(self, name) -> int: Get the index of a variable.

index_model(self) -> int: Build the index for the block model.

is_field(self, field) -> bool: Check if the given variable exists on the block model.

is_indexed(self) -> int: Check whether the block model is indexed.

is_number(self, field) -> bool: Check if the given variable exists as a numeric variable in the block model.

is_open(self) -> bool: Check if given block model is open.

is_regular(self) -> bool: Check if the model is a regular model.

is_string(self, field) -> bool: Check if the given variable exists as a string variable on the block model.

is_tb_model(self) -> bool: Check if the model is an extended format model.

match_extent(self) -> list: Get the extent of the current match selection.

match_volume(self) -> float: Calculates the volume of the current match selection.; Returns the calculated volume.

model_extent(self) -> list: Returns list in the form [Xmin, Ymin, Zmin, Xmax, Ymax, Zmax] where the min values are the coordinates of the lower extent, and the max values are the coordinates of the upper extent.

model_n_schemas(self) -> int: Get the number of schemas associated with the model.

model_orientation(self) -> list: Get the orientation of the model.

model_origin(self) -> list: Get the origin of the model.

model_schema_extent(self, k) -> list: Get the extent of a schema within the model.

model_schema_dimensions(self, k) -> list: Get the dimensions of a schema within the model.

model_schema_size(self, k) -> list: Get the size of a schema within the model.

modified_date(self) -> string: Check when the block model was last modified.

move_block(self, x0, y0, z0, x1, y1, z1) -> 0 if successful, 1 otherwise: Move the block at the current record to the given coordinates.

n_blocks(self) -> int: Get the number of blocks in the model.

select(self, selection) -> int: Specify block selection criteria for a block model.

to_model(self, p) -> Point_type: Convert a set of real world coordinates to model coordinates.

translate(self, x, y, z) ->: Translate a block model.

compare_blockmodels

Proxy of C++ compare_blockmodels class.

compare_blockmodels.clear()

compare_blockmodels.compare()

compare_blockmodels.get_check_extent()

compare_blockmodels.get_check_nblocks()

compare_blockmodels.get_check_origin()

compare_blockmodels.get_check_rotation()

compare_blockmodels.get_check_schema()

compare_blockmodels.get_check_variable_list()

compare_blockmodels.get_check_variable_value()

compare_blockmodels.get_extent_tolerance()

compare_blockmodels.get_origin_tolerance()

compare_blockmodels.get_rotation_tolerance()

compare_blockmodels.get_schema_tolerance()

compare_blockmodels.get_specific_check_variable()

compare_blockmodels.get_variable_value_tolerance()

compare_blockmodels.get_verbose_level()

compare_blockmodels.set_blockmodels()

compare_blockmodels.set_check_extent()

compare_blockmodels.set_check_nblocks()

compare_blockmodels.set_check_origin()

compare_blockmodels.set_check_rotation()

compare_blockmodels.set_check_schema()

compare_blockmodels.set_check_variable_list()

compare_blockmodels.set_check_variable_value()

compare_blockmodels.set_specific_variable_check()

compare_blockmodels.set_verbose_level()

compare_dgds

Proxy of C++ compare_dgds class.

compare_dgds.clear()

compare_dgds.compare()

compare_dgds.get_check_colours()

compare_dgds.get_check_object_description()

compare_dgds.get_check_object_name()

compare_dgds.get_tolerance()

compare_dgds.get_verbose_level()

compare_dgds.set_check_colours()

compare_dgds.set_check_object_description()

compare_dgds.set_check_object_name()

compare_dgds.set_dgds()

compare_dgds.set_tolerance()

compare_dgds.set_verbose_level()

compare_grids

Proxy of C++ compare_grids class.

compare_grids.clear()

compare_grids.compare()

compare_grids.get_cell_spacing_tolerance()

compare_grids.get_check_cell_spacing()

compare_grids.get_check_extents()

compare_grids.get_check_mask()

compare_grids.get_check_origin()

compare_grids.get_check_value()

compare_grids.get_extents_tolerance()

compare_grids.get_origin_tolerance()

compare_grids.get_value_tolerance()

compare_grids.get_verbose_level()

compare_grids.set_check_cell_spacing()

compare_grids.set_check_extents()

compare_grids.set_check_mask()

compare_grids.set_check_origin()

compare_grids.set_check_value()

compare_grids.set_grids()

compare_grids.set_verbose_level()

compare_isis

Proxy of C++ compare_isis class.

compare_isis.add_field_to_test()

compare_isis.clear()

compare_isis.compare()

compare_isis.get_check_design()

compare_isis.get_check_fields()

compare_isis.get_check_fields_tolerance()

compare_isis.get_check_key()

compare_isis.get_check_key_match()

compare_isis.get_number_of_fields_to_test()

compare_isis.get_test_field()

compare_isis.get_test_field_table()

compare_isis.get_verbose_level()

compare_isis.set_check_design()

compare_isis.set_check_fields()

compare_isis.set_check_key()

compare_isis.set_isis()

compare_isis.set_verbose_level()

compare_tris

Proxy of C++ compare_tris class.

compare_tris.clear()

compare_tris.compare()

compare_tris.get_check_extents()

compare_tris.get_check_properties()

compare_tris.get_check_surface_area()

compare_tris.get_check_triangles()

compare_tris.get_check_volume()

compare_tris.get_extents_tolerance()

compare_tris.get_surface_area_tolerance()

compare_tris.get_verbose_level()

compare_tris.get_volume_tolerance()

compare_tris.set_check_extents()

compare_tris.set_check_properties()

compare_tris.set_check_surface_area()

compare_tris.set_check_triangles()

compare_tris.set_check_volume()

compare_tris.set_tris()

compare_tris.set_verbose_level()

dgd

Interface for Vulcan design databases.

dgd.append()

dgd.close()

dgd.delete_layer()

dgd.get_layer()

dgd.is_layer()

dgd.is_locked()

dgd.is_open()

dgd.list_layers()

dgd.num_layers()

dgd.save_layer()

dgd.save_layer_as()

dgd.layers

dgd.locked

dgd.open

dim_angle

Interface for Vulcan design dimension angles.

dim_angle.get_origin()

dim_angle.get_radius()

dim_angle.get_sweep()

dim_angle.set_origin()

dim_angle.set_radius()

dim_angle.set_sweep()

dim_angle.swap_points()

dim_angle.origin

dim_angle.radius

dim_angle.sweep

dim_arc

Interface for Vulcan design dimension arcs.

dim_arc.get_origin()

dim_arc.set_origin()

dim_arc.get_radius()

dim_arc.set_radius()

dim_arc.get_sweep()

dim_arc.set_sweep()

dim_arc.swap_points()

dim_arc.origin

dim_arc.radius

dim_arc.sweep

dim_line

Interface for Vulcan design dimension lines.

dim_line.get_start()

dim_line.set_start()

dim_line.get_end()

dim_line.set_end()

dim_line.midpoint()

dim_line.get_normal()

dim_line.set_normal()

dim_line.swap_points()

dim_line.start

dim_line.end

dim_line.normal

dim_radius

Interface for Vulcan design dimension radii.

dim_radius.get_start()

dim_radius.set_start()

dim_radius.get_end()

dim_radius.set_end()

dim_radius.get_normal()

dim_radius.set_normal()

dim_radius.swap_points()

dim_radius.start

dim_radius.end

dim_radius.normal

dimension

Base class for Vulcan design dimensions.

dimension.get_arrow_length()

dimension.get_arrow_width()

dimension.get_font()

dimension.get_label()

dimension.get_scale()

dimension.get_scale_factor()

dimension.get_scaled_text_height()

dimension.get_text_height()

dimension.get_text_map_size()

dimension.get_tick_extent_size()

dimension.get_tick_gap()

dimension.get_tick_offset()

dimension.is_mirrored_horizontally()

dimension.is_mirrored_vertically()

dimension.set_arrow_length()

dimension.set_arrow_width()

dimension.set_font()

dimension.set_label()

dimension.set_mirrored_horizontally()

dimension.set_mirrored_vertically()

dimension.set_scale()

dimension.set_text_height()

dimension.set_text_map_size()

dimension.set_tick_extent_size()

dimension.set_tick_gap()

dimension.set_tick_offset()

dimension.arrow_length

dimension.arrow_width

dimension.font

dimension.label

dimension.mirrored_horizontally

dimension.mirrored_vertically

dimension.scale

dimension.text_height

dimension.text_map_size

dimension.tick_extent_size

dimension.tick_gap

dimension.tick_offset

grid

Interface for Vulcan grids.

load_spec()

python_authorise()

save_formatted_spec()

save_spec()

shutdown_python_auth()

isisdb

Interface for Vulcan isis databases.

isisdb.__iter__()

isisdb.append()

isisdb.append_buffer()

isisdb.close()

isisdb.delete_key()

isisdb.delete_record()

isisdb.field_index()

isisdb.field_list()

isisdb.field_list_numbers()

isisdb.field_list_strings()

isisdb.field_size()

isisdb.find_key()

isisdb.get()

isisdb.get_buffer()

isisdb.get_coordinate()

isisdb.get_default()

isisdb.get_default_string()

isisdb.get_field_index()

isisdb.get_key()

isisdb.get_position()

isisdb.get_raw_header()

isisdb.get_raw_layer()

isisdb.get_string()

isisdb.get_subtype()

isisdb.get_table_index()

isisdb.get_table_name()

isisdb.goto_table()

isisdb.has_dsr()

isisdb.insert_after()

isisdb.insert_before()

isisdb.is_field()

isisdb.is_number()

isisdb.is_string()

isisdb.key()

isisdb.key_list()

isisdb.keys

isisdb.next()

isisdb.next_key()

isisdb.next_same_key()

isisdb.open()

isisdb.put()

isisdb.put_string()

isisdb.put_table_name()

isisdb.rewind()

isisdb.set_position()

isisdb.synonym()

isisdb.table_list()

isisdb.this_key

isisdb.this_table()

isisdb.write()

layer

Interface for Vulcan layers.

append(layer self, obj object): Appends an object to the layer.

clear_objects(layer self): Deletes all objects from the layer.

delete_object(layer self, int index) → bool: Deletes an object by index from the layer.

find_object(layer self, std::string name) → VulcanObj: Finds an object by name.

get_name(layer self) → std::string: Gets the layer name.

get_description(layer self) → std::string: Gets the layer description.

get_object(layer self, int index) → VulcanObj: Gets an object from a layer by index.

get_objects(types: list): Gets the objects of a layer by type. This is not suitable for putting objects back into layers with enumerate() since the objects are filtered and indices are unknown. To have indices for modifying objects, use get_objects_enumerate().

get_objects_enumerate(types: list): Gets objects by type from a layer along with layer indices.

num_objects(layer self) → int: Returns the number of objects in the layer.

set_name(layer self, std::string const & name): Sets the layer name.

set_description(layer self, std::string const & description): Sets the layer description.

set_object(layer self, int index, obj object) → bool: Sets an object by index.

mapio

Proxy of C++ mapio class.

mapio.__iter__()

mapio.append()

mapio.close()

mapio.field_index()

mapio.field_list()

mapio.field_list_numbers()

mapio.field_list_strings()

mapio.field_size()

mapio.find_key()

mapio.get()

mapio.get_position()

mapio.get_string()

mapio.is_field()

mapio.is_number()

mapio.is_string()

mapio.next()

mapio.next_key()

mapio.open()

mapio.put()

mapio.put_string()

mapio.rewind()

mapio.set_position()

mapio.write()

metadata

Class for manipulating object metadata.

metadata.as_dict()

metadata.field_list()

metadata.from_dict()

metadata.get_timestamp()

metadata.get_value()

metadata.has_field()

metadata.num_fields()

metadata.remove_field()

metadata.set_field()

obj

Base class for shared methods in design object datatypes.

obj.__eq__()

obj.__ne__()

obj.clear()

obj.get_attributes()

obj.get_colour()

obj.get_description()

obj.get_feature()

obj.get_group()

obj.get_layer()

obj.get_link()

obj.get_linkdata()

obj.get_linktype()

obj.get_metadata()

obj.get_name()

obj.get_primitive()

obj.get_section_widths()

obj.get_type()

obj.get_value()

obj.num_links()

obj.object_details()

obj.set_attributes()

obj.set_colour()

obj.set_description()

obj.set_feature()

obj.set_feature_with_file()

obj.set_group()

obj.set_link()

obj.set_linkdata()

obj.set_metadata()

obj.set_name()

obj.set_primitive()

obj.set_section_widths()

obj.set_value()

obj.attributes

obj.colour

obj.description

obj.feature

obj.group

obj.layer

obj.linkdata

obj.metadata

obj.name

obj.section_widths

obj.type

obj.value

point

Interface for Vulcan design points.

distance(self, other: "point") -> double: Use this to find the distance between two points and return as a double.

name(self) -> std::string: Get the name of a point and return as a string.

xyz(self) -> double: Generator for the x/y/z portion of a point. This function is written to be used in a loop.

w(self) -> double: Property: w value.

x(self) -> double: Property: x value.

y(self) -> double: Property: y value.

z(self) -> double: Property: z value.

t(self, t: "int const &") -> void: Property: Point t (0/1 = connection)

polyline

Interface for Vulcan design polylines.

get_linetype(polyline self) → int_list: Gets the linetype as an integer list of indices (style, thickness).

set_linetype(polyline self, int_list & style): Sets the linetype from a style and thickness.

get_pattern(polyline self) → int: Gets the pattern index of a polygon.

set_pattern(polyline self, int pattern): Sets the pattern index of a polygon. Indices range from 0 - 47.

append(polyline self, point pt) → bool: Adds a point to the end of a line.

delete_point(polyline self, int k) → bool: Deletes a point from a line by using the index.

num_points(polyline self) → int: Returns the number of points in a polyline.

get_coordinates(polyline self) → double_double_list: Gets a list of coordinates from a polyline in x/y/z.

set_coordinates(polyline self, point_list pl=None) → bool: Sets the coordinates of a line from a list of x/y/z or vulcan.point

set_connected(polyline self, int const start=-1, int const end=-1, bool connected=True): Sets the connection of a polyline.

is_clockwise(polyline self) → bool: Returns true if the polyline is clockwise.

set_direction(polyline self, int const dir=0): Sets the direction of a polyline.

make_clockwise(polyline self): Makes a polyline clockwise.

make_counter_clockwise(polyline self): Makes a polyline counter clockwise.

is_closed(polyline self) → bool: Returns true if a polyline is closed.

set_closed(polyline self, bool closure=True): Sets the polyline to closed.

shift(polyline self, double const & x, double const & y, double const & z): Shifts a polyline by an x/y/z distance.

scale(polyline self, double const & factor, point center=None): Scales a polyline based on a scale and center point.

planar_area(polyline self, bool plan=True) → double: Gets the planar area of a polyline (in plan or a best fit plane).

length(polyline self, bool plan=False) → double: Gets the length of a polyline (in plan or 3D).

centroid(polyline self) → point: Gets the centroid of a polyline.

center_average(polyline self) → point: Gets the center of a polyline by an average of the points.

change_xyz(polyline self) → point: Get the change in x/y/z directions between the start and end points of a polyline.

filter(polyline self, double distance): Filters a polyline by a distance tolerance.

point_inside(polyline self, point pt, bool plan=True) → bool: Returns true if a point is inside the polyline.

linetype: Polyline linetype.

pattern: Polyline pattern.

closed: Polyline closure (bool)

clockwise: Polyline direction (bool)

coordinates: Polyline coordinates

python_datetime

Translation utility class for Maptek DateTime class.

python_datetime.as_datetime()

python_datetime.convert()

section_widths

Controls section widths of an object.

section_widths.__str__()

section_widths.enable_section_width()

section_widths.get_back_width()

section_widths.get_cross_sections()

section_widths.get_front_width()

section_widths.set_back_width()

section_widths.set_cross_sections()

section_widths.set_front_width()

section_widths.use_section_width()

section_widths.back_width

section_widths.cross_points

section_widths.cross_sections

section_widths.enable

section_widths.front_width

text

Interface for Vulcan design text (2D).

text.append()

text.delete_all_lines()

text.delete_line()

text.get_angle()

text.get_font()

text.get_height()

text.get_line()

text.get_origin()

text.get_scale()

text.get_width()

text.is_framed()

text.num_lines()

text.set_angle()

text.set_font()

text.set_framed()

text.set_height()

text.set_line()

text.set_origin()

text.set_scale()

text.set_width()

text.angle

text.font

text.framed

text.height

text.origin

text.scale

text.width

text3d

Interface for Vulcan design text (3D)

text3d.append()

text3d.delete_all_lines()

text3d.delete_line()

text3d.get_direction()

text3d.get_font()

text3d.get_height()

text3d.get_horizontal_align()

text3d.get_line()

text3d.get_normal()

text3d.get_origin()

text3d.get_scale()

text3d.get_vertical_align()

text3d.get_width()

text3d.is_italic()

text3d.is_mirrored_horizontal()

text3d.is_mirrored_vertical()

text3d.num_lines()

text3d.set_direction()

text3d.set_font()

text3d.set_height()

text3d.set_horizontal_align()

text3d.set_italic()

text3d.set_line()

text3d.set_mirrored_horizontal()

text3d.set_mirrored_vertical()

text3d.set_normal()

text3d.set_origin()

text3d.set_scale()

text3d.set_vertical_align()

text3d.set_width()

text3d.direction

text3d.font

text3d.height

text3d.horizontal_align

text3d.italic

text3d.mirrored_horizontal

text3d.mirrored_vertical

text3d.normal

text3d.origin

text3d.scale

text3d.vertical_align

text3d.width

tri_attributes

Interface for Vulcan triangulation attributes.

clear(tri_attributes self): Clear all attributes from a triangulation.

delete_key(tri_attributes self, std::string const & name): Delete a key (attribute) from a triangulation.

exists(tri_attributes self, std::string const & name) → bool: Check if an attribute exists. Return True if exists, False is it does not exist.

get_hash(tri_attributes self) → dictionary: Create a dictionary of attributes and values {'attribute' : 'value'}.

get_keys(tri_attributes self) → string_list: Create a list of keys from the dictionary of attributes for a triangulation. The key is the attribute name.

get_last_error(tri_attributes self) → std::string: Get the last error thrown by an attribute method.

get_string(tri_attributes self, std::string const & name) → std::string: Return attribute values as a list of strings..

get_type(tri_attributes self, std::string const & name) → std::string: Returns the attribute type as a string.

get_types(tri_attributes self) → string_list: Returns a list of attribute types.

get_values(tri_attributes self) → string_list: Create a list of attribute values for a triangulation.

is_ok(tri_attributes self) → bool: Verify if triangulation is open and can be read by Python.

put(tri_attributes self, std::string const & name, int value, std::string const & type) → bool put(tri_attributes self, std::string const & name, std::string const & value, std::string const & type) → bool: Add attributes to a triangulation and return True if successful. There are two versions of this function and both use the same format for passing arguments: put(attribute name, attribute value, attribute type).

save(tri_attributes self): Save changes to triangulation attributes.

triangulation

Interface for Vulcan triangulations.

class faces(object):: Generator to move through each facet of a triangulation.

class nodes(object):: Generator to move through each node of a triangulation.

add_face(triangulation self, int n1, int n2, int n3) -> int
add_node(triangulation self, double x, double y, double z) -> int: Add a facet / node to the triangulation, and returns the index number of that facet or node.

append_faces(triangulation self, n0: int) -> void
append_vertices(triangulation self, n0: int) -> void: Appends a NumPy array of facets/nodes to a triangulation.

centroid(triangulation self) -> point: Gets the centroid of a triangulation.

clean(triangulation self) -> void: Cleans a triangulation, trying to remove consistency and crossing errors.

clear(triangulation self) -> void: Clears all data from the triangulation, including all points, triangles, attributes, etc. This function is used to reset a triangulation by removing all the data.

clear_triangles(triangulation self) -> void: Clears all triangle data, leaving attributes intact. This function could be used to copy an existing triangulation, clear out the points, make a new shape, then update the required attributes while leaving the rest intact. For example, building numerous stope solids, you could copy a base set of attributes such as level, mining area, etc., then input each stope's new points/vertices.

close(triangulation self) -> bool: Attempts to close a solid triangulation. This is the same operation as right-clicking on a triangulation and selecting Close Solid.

contour(triangulation self, double z) -> obj_list: Gets the contours of a triangulation at a specified Z elevation.

delete_face(triangulation self, facet index number, bool purge_points=False) -> void: Deletes a facet from the triangulation. (Optional) Purges points no longer used.

delete_node(triangulation self, node index number) -> void: Deletes a node from the triangulation.

extent(triangulation self) -> 2D list: Get the triangulation extent as a list. This will return a list of the coordinates for the lower left and upper right corners of the extent perimeter.

extent_pts(triangulation self) -> point_list: Gets the triangulation extent as points. This will return a list of point information for the lower left and upper right corners of the extent perimeter.

face_direction(triangulation self, facet index number) -> point: Gets the facet direction and returns a point as a unit vector.

face_neighborhood(triangulation self, facet index number) -> int_list: Get indices of neighbouring facets.

get_colour_index(triangulation self) -> int: Gets the triangulation colour (index).

get_elevation(triangulation self, double x, double y) -> double: Gets the elevation of an x,y location.

get_elevations(triangulation self, double x, double y) -> double_list: Gets any intersection elevations of an x,y location.

get_face(triangulation self, facet index number) -> int_list: Gets a facet and its point indices by index.

get_faces(triangulation self) -> 2D array: Gets the facets of a triangulation as a NumPy array.

get_node(triangulation self, node index number) -> double_list: Creates list of x,y,z coordinates for the node of a triangulation.

get_properties(triangulation self) -> dictionary: Create a dictionary of triangulation properties.

get_rgb(triangulation self) -> int_list: Gets the triangulation colour (RGB).

get_translucency(triangulation self) -> double: Gets the triangulation translucency.

get_vertices(triangulation self) -> 2D array: Gets the node (vertex) coordinates of a triangulation as a NumPy array.

is_closed(triangulation self) -> bool: Reports the triangulation closure state of a solid triangulation.

is_consistent(triangulation self) -> bool: Reports the existence of inconsistent triangles. Returns True if passed, False if it does not pass.

is_crossing(triangulation self) -> bool: Runs check for crossing triangles. Returns True if triangles are crossing, False if no crossing.

is_ok(triangulation self) -> bool: Reports the triangulation load status (true if new). This can be placed at the beginning of an operation to check that a triangulation was properly loaded.

is_rgb(triangulation self) -> bool: Returns True if the triangulation color is RGB.

load_grid(triangulation self, grid) -> void: Loads a grid into a triangulation.

n_faces(triangulation self) -> int: Returns the number of facets in the triangulation.

n_nodes(triangulation self) -> int: Returns the number of nodes in the triangulation.

neighbors(triangulation self, facet index number) -> int_list: Gets the triangle neighbours. Pass the index of the facet of interest and returns a list of neighbouring facet indices.

node_neighborhood(triangulation self, node index number) -> int_list: Gets the node neighbours. Pass the index of the node of interest and returns a list of neighbouring node indices.

normalise(triangulation self) -> void: Normalizes the triangulation faces so that they all face the same direction (out). Generally, there is no reason to call this method since any method that needs it will call it on its own.

point_inside(triangulation self, double x, double y, double z) -> bool: Checks if a point is inside a closed triangulation.

put_faces(triangulation self, facet index number) -> void put_vertices(triangulation self, int n0) -> void: put_faces() stores a NumPy array of facets in a triangulation.; put_vertices() stores a NumPy array of nodes in a triangulation.

save(triangulation self, std::string const name="") -> bool: Saves the triangulation.

scale(triangulation self, point xyz_scale, point xyz_reference) -> bool: Scales a triangulation by a factor in the x/y/z directions based on a reference point.

segment_intersections(triangulation self, double x0, double y0, double z0, double x1, double y1, double z1) -> double_double_list: Gets the intersections of a line segment as a list.

segment_intersections_pt(triangulation self, point a, point b) -> point_list: Gets the intersections of a line segment as points.

set_colour(val) -> void: Sets the colour of the triangulation to RGB(list) or colour index(int).

set_colour_index(triangulation self, int colour) -> void: Sets the triangulation colour (index).

set_face(triangulation self, facet index, node 1, node 2, node 3) -> void: Add a facet using existing nodes as reference points.

set_node(triangulation self, int k, double x, double y, double z) -> void: Sets a triangulation vertex by coordinates.

set_properties(triangulation self, dictionary of props): Set the properties of a triangulation.

set_rgb(triangulation self, int_list const & rgb) -> Void: Set the RGB colour value of a triangulation

set_translucency(triangulation self, double const value) -> Void: Set the translucency value of a triangulation

shortest_path(triangulation self, point start, point end) -> VulcanObj: Creates a polyline object denoting the shortest path between two points.

solid_from_polygon(triangulation self, double width, int poly_position) -> Void: Creates a solid from points of a polygon, projecting them vertically.

surface_area(triangulation self) -> double: Get the surface area of a triangulation.

translate(triangulation self, point translation) -> bool: Translate a triangulation by an x/y/z shift.

update_grid(triangulation self, VGD_grid_t grid) -> void: Updates a grid with the current triangulation.

volume(triangulation self) -> double: Returns the volume of a closed triangulation.

variant

Class to access Vulcan specification files from Variant formats. This implementation behaves like a dictionary with the additional ability to load and save the specfile to the original specification file type.

variant.load()

variant.save()

variant.save_as()

VGD_grid_cell_t

Proxy of C++ VGD_grid_cell_t class.

VGD_grid_cell_t.copy()

VGD_grid_cell_t.get_mask()

VGD_grid_cell_t.get_w()

VGD_grid_cell_t.get_w_and_mask()

VGD_grid_cell_t.put_mask()

VGD_grid_cell_t.put_w()

VGD_grid_cell_t.set_mask()

VGD_grid_cell_t.set_w()

VGD_grid_t

Proxy of C++ VGD_grid_t class.

VGD_grid_t.__call__()

VGD_grid_t.basic_stats()

VGD_grid_t.clear()

VGD_grid_t.copy()

VGD_grid_t.get_dx()

VGD_grid_t.get_dy()

VGD_grid_t.get_elevation()

VGD_grid_t.get_elevation_mask()

VGD_grid_t.get_elevation_missing()

VGD_grid_t.get_elevation_missing_mask()

VGD_grid_t.get_grid()

VGD_grid_t.get_grid_mask()

VGD_grid_t.get_grid_x()

VGD_grid_t.get_grid_y()

VGD_grid_t.get_mask()

VGD_grid_t.get_nx()

VGD_grid_t.get_ny()

VGD_grid_t.get_pandas()

VGD_grid_t.get_values()

VGD_grid_t.get_values_mask()

VGD_grid_t.get_w()

VGD_grid_t.get_w_missing()

VGD_grid_t.get_x()

VGD_grid_t.get_x0()

VGD_grid_t.get_x_coordinates()

VGD_grid_t.get_y()

VGD_grid_t.get_y0()

VGD_grid_t.get_y_coordinates()

VGD_grid_t.get_z()

VGD_grid_t.ij_to_pos()

VGD_grid_t.load()

VGD_grid_t.load_esri()

VGD_grid_t.n_data()

VGD_grid_t.ok

VGD_grid_t.pandas

VGD_grid_t.put_grid()

VGD_grid_t.put_grid_mask()

VGD_grid_t.put_mask()

VGD_grid_t.put_pandas()

VGD_grid_t.put_values()

VGD_grid_t.put_values_mask()

VGD_grid_t.put_w()

VGD_grid_t.save()

VGD_grid_t.save_esri_ascii()

VGD_grid_t.set_dx()

VGD_grid_t.set_dy()

VGD_grid_t.set_size()

VGD_grid_t.set_x0()

VGD_grid_t.set_y0()

check_python_auth()

get_spec_type()

swig_callback

C++ underlying callback handler. Use class ‘callback’ to create callbacks.

swig_callback.__call__()

callback

Callback creator for Vulcan utilities. Create a callback and pass it to a function that uses it.

callback.set_callback()

callback.__call__()

maptek.drillholes

An interface to create and edit data within drillhole tables. This includes classes for managing the database itself, the holes within the database, as well as tables, fields and intervals associated with individual drillholes.

collar_scheme

Class containing information about the collar scheme, including the database table name of the collar table, as well as the names of the HoleId, Easting, Northing, Elevation and Total Depth fields.

db_table_name

holeid_field

easting_field

northing_field

elevation_field

total_depth_field

desurvey_interval

Class containing depth, bearing and inclination information for a desurvey measurement.

depth

bearing

inclination

drillhole_database

An interface to create and edit data within drillhole databases.

read()

edit()

create()

is_read_only()

add_drillhole()

delete_drillhole()

drillhole_ids()

get_drillhole()

database_table_names()

list_fields()

interval_table_names()

tables()

add_assay_table()

add_geology_table()

add_analytical_table()

add_text_field_to_table()

add_float_field_to_table()

add_int_field_to_table()

save_drillhole()

def __enter__()

def collar_fields()

def collar_scheme()

def collar_scheme()

def drillhole_count()

table_information

Class representing the mapping of fields to tables in the database.

fields()

name()

drillhole

Class representing a single drillhole object within a database. All drillholes that originate from the same database will have the same tables and fields, but have no restrictions on containing the same intervals.

get_interval_table()

raw_collar()

raw_collar()

point_at_depth()

get_dsr()

total_depth()

total_depth()

interval_count()

set_collar_field()

add_dsr()

add_dsr()

get_collar_field()

get_interval_value()

dsr_entry_count()

drillhole_table

Class representing a table in a drillhole database which contains interval data.

name()

get_interval()

append_interval()

remove_interval()

get_field_values()

intervals()

field_names()

interval_count()

interval

def has_field()

is_field_numeric()

is_field_empty()

set_field()

set_name()

__getitem__()

__setitem__()

get_field()

from_depth()

to_depth()

maptek.vulcan_gui module

This module provides an interface to the Vulcan GUI functionality.

maptek.vulcan_gui.message(msg): Displays a message box.

maptek.vulcan_gui.error(msg): Displays an error message in Vulcan.

maptek.vulcan_gui.confirm(msg, ok (first choice), cancel (second choice))→ bool: Displays a confirmation prompt. Returns True for first choice; False for second choice.

maptek.vulcan_gui.start_busy_message(msg, time=-1)
maptek.vulcan_gui.end_busy_message(): Start and stop a busy message (small non-interactive message). Use this to notify users that there are processes running in the background even though there may seem to be nothing happening.

maptek.vulcan_gui.globals()→ MVariant: Access to current data items in Vulcan and returns a dictionary.

maptek.vulcan_gui.save(): Issues a save command to Vulcan when working with interactive code.

maptek.vulcan_gui.get_main_window_handle()→ unsigned int: Get the main window handle of the Workbench

maptek.vulcan_gui.get_current_dgd_attribute_templates()→ MVariant: Gets the attribute templates from the currently opened design database.

maptek.vulcan_gui.get_resource_attribute_templates()→ MVariant: Gets the attribute templates from the resource template file.

maptek.vulcan_gui.pick_triangulation(prompt)→ std::string: Prompt informing users to pick a triangulation that has been loaded onto the screen.

maptek.vulcan_gui.get_layer(layerName)→ layer: Loads a layer from Vulcan by name.

maptek.vulcan_gui.add_layer(lyr, loadMethod='LOAD_IF_EXISTS')→ bool: Adds a layer to the active design database (dgd).

maptek.vulcan_gui.load_triangulation(file, interactive=False)→ bool: Load triangulation into Vulcan.

maptek.vulcan_gui.load_triangulations(files)→ bool: Load a list of triangulations into Vulcan.

maptek.vulcan_gui.reload_triangulation(file): Reloads a triangulation in Vulcan after first displaying the triangulation Properties panel.

maptek.vulcan_gui.remove_layers(layer_names)→ bool: Remove a list of layers from Vulcan.

maptek.vulcan_gui.remove_triangulations(files)→ bool: Remove a list of triangulations from Vulcan. If any triangulations fail (not loaded or had unsaved data), it will raise a RuntimeError indicating which item(s) failed.

maptek.vulcan_gui.set_object_visibility(object, mode)→ bool: Sets the visibility of an object in Vulcan. Only supports objects from the GUI with the visibility modes of VISIBLE, SHADOW, and INVISIBLE.

maptek.vulcan_gui.get_object_visibility(object)→ std::string: Gets the visibility state of an object in Vulcan.

get_values(self)→ MVariant: Gets the values from the panel (after it has run) and saves them to a dictionary.

set_values(self, values): Preloads panel key values with input dictionary values.

save_spec(self, specName): Saves the panel data to a specification file.

load_spec(self, specName): Loads a specification file into the panel.

gui_options

Proxy of C++ gui_options class.

maptek.vulcan_gui.gui_options(*args, **kwargs): These are used as a method of validation, not for assigning parameters.

gui_options.display: Validation check for options selected.

gui_options.label: Validation check for options selected.

gui_options.layer_load: Validation check for options selected.

gui_options.selection_type: Validation check for options selected.

gui_options.selection_criteria: Validation check for options selected.

panel

Interface for building basic Vulcan panels.

maptek.vulcan_gui.panel(*args, **kwargs): To use this class, create a panel object by defining an object using the method call vulcan_gui.panel() like so:

display(self, values=None)→ bool: Used to display a panel after it has been defined.

panel.editbox(self, tag, prompt, defaultVal=None, width=None): Create a panel showing an editbox.

panel.numberbox(self, tag, prompt, defaultVal=None, width=None): Only numbers can be entered into this box. The numbers can have up to three decimal places.

panel.integerbox(self, tag, prompt, defaultVal=None, width=None): Only whole numbers can be entered into this box.

panel.fileselector(self, tag, prompt, filter, width=None): Create a combobox with a built in file filter using wildcard matching.

panel.combobox(self, tag, prompt, options, width=None): Create a panel showing a combobox.

panel.filterbox(self, tag, prompt, filter, width=None): Combobox with a built in filter, using gpan filter strings.

panel.checkbox(self, tag, prompt, checked=False): Create a panel showing a checkbox.

panel.radiobutton(self, tag, prompt, initial=False, bank=0): Radiobutton to pick one of several options. Only one tag per bank will return ‘1’.

panel.colour(self, tag, prompt, defaultVal=None): Selector for colour using Vulcan colour palette. Returns the colour index as an integer.

panel.linestyle(self, tag, prompt, style=None, thickness=None): Selector for linestyle using Vulcan linestyles. Returns [line style, line thickness] as a list.

panel.pattern(self, tag, prompt, defaultVal=None): Selector for pattern using Vulcan patterns. Returns the pattern index as an integer.

panel.begin_block(self, border=False, title='')
panel.end_block(self): Creates a new area on the panel with optional border and title.

panel.pan_if(self)
panel.pan_else(self)
panel.pan_endif(self): Create 'if' statements within panels that makes the next element conditional on the previous element.

panel.staticline(self): Line drawn across panel.

panel.begin_indent(self, indent=1)
panel.end_indent(self): Indent fields a set amount.

panel.begin_same_line(self)
panel.end_same_line(self): Position elements on the same line. All elements between begin_same_line() and end_same_line() will be positioned side-by-side instead of stacked one above the other.

panel.skip_line(self): Positions an element below the previous element after skipping a line.

panel.statictext(self, prompt, bold=False): Text placed on the panel.

panel.get_values(self)→ MVariant: Gets the values from the panel (after it has run) and saves them to a dictionary.

panel.set_values(self, values): Preloads panel key values using dictionary.

panel.save_spec(self, specName): Saves the panel data to a specification file. This method call needs to be placed after the display() method call.

panel.load_spec(self, specName): Loads a specification file into the panel. This method call needs to be placed before the display() method call.

gpan

Display Vulcan gpan panels.

gpan.display()

gpan.get_values()

gpan.load_spec()

gpan.save_spec()

gpan.set_values()

gpan.values

temp_object

Class for displaying temporary objects in the GUI.

temp_object.remove()

temp_object.set_display_mode()

temp_object.set_label_mode()

pick_point

Pick points inside of Vulcan.

maptek.vulcan_gui.pick_point(self): Prompt user to pick point.

pick(self, firstPrompt, secondPrompt='')→ tuple: Gets the coordinates of a point location and returns them as a tuple of points.

property get_rubberband()→ Bool: Get display property state for rubberband when selecting points.

property set_rubberband(True = display, False = do not display)→ Bool: Set property to display or not display rubberband when selecting points.

property get_single_point()→ bool: Get property state for single point selection.

property set_single_point()→ bool: Set property to select only a single point.

selection

Class for creating object selections inside of Vulcan.

maptek.vulcan_gui.selection(prompt: std::string const &): Class for creating selection objects inside of Vulcan.

set_criteria(self, types): Sets the allowed types to be picked from a list of options.

get_criteria(self)→ str_list: Returns the list of allowed selection types.

set_single_object(self, singleObj=True): Sets the selection to single object mode.

get_single_object(self)→ bool: Returns the single object mode setting.

set_selection_type(self, type): Sets the selection type.

get_selection_type(self)→ std::string: Gets the selection type (Default=ALL).

set_display_mode(self, type): Sets the display mode of selected data.

get_display_mode(self)→ std::string: Gets the display mode of selected data.

set_ignore_preselected(self, ignore=True): Sets the flag to ignore preselected data.

get_ignore_preselected(self)→ bool: Returns the option for allowing preselected data.

pick(self, layername=None, group=None, feature=None): Non-interactive selection an object in Vulcan.

get_object(self, index)→ VulcanObj: Gets an object from the selection by index.

num_obj(self)→ int: Returns the number of objects in the selection.

replace(self, object)→ bool: Replaces an object (If it originated from Vulcan) and update on the screen after changes have been made.

property criteria: str_list: Get/Set for selection criteria.

property single_object: bool: Get/Set for single object mode.

property selection_type: string: Get/Set for selection type.

property display_mode: string: Get/Set for selection display mode.

property ignore_preselected: bool: Get/Set for ignore preselected mode.

run_menu

Class used for running recorded macros.

get_report_window()

set_view()

set_window()

workbench_macro()

macro

Macro class for interacting with Vulcan.

macro.begin_menu_command()

macro.command()

macro.end_menu_command()

macro.panel_results()

macro.point_absolute()

macro.point_relative()

macro.run()

macro.select_by_attr()

macro.select_interactive()

macro.set_view()

macro.set_window()

macro.triangulation()

macro.workbench_macro()

maptek.vulcan_gui.gfx module

This module provides an interface to the Vulcan GUI GFX functionality.

Functionality includes:

Window listing/setting
View control
View feature control

load_window_from_definition()

set_current_window()

view_fit_to_world()

view_pan()

view_reset()

view_reset_and_fit_to_world()

view_rotate_relative()

view_screen_dump()

window_info()

zoom_to_object_list()

zoom_to_selection()

clip_mode

Section clipping modes for section_settings.clip property.

clip_mode.BACKWARDS

clip_mode.BY_WIDTH

clip_mode.FORWARDS

clip_mode.NO_CLIPPING

intersection_draw

Section intersection drawing modes for section_settings.draw property.

intersection_draw.HIGHLIGHT

intersection_draw.NONE

intersection_draw.PATTERN

section_settings

Settings for section display.

move_section_plane()

section_by_plane_equation()

section_by_strike_dip()

section_by_three_points()

section_settings.back_width

section_settings.clip

section_settings.draw

section_settings.front_width

section_settings.reverse_view

section_settings.step

step_section_plane()

cursor_snap_mode

Class to set cursor mode.

cursor_snap_mode.DRAW

cursor_snap_mode.ELEVATION

cursor_snap_mode.GRID

cursor_snap_mode.INDICATE

cursor_snap_mode.OBJECT

cursor_snap_mode.POINT

cursor_snap_mode.SMART

set_cursor_snap_mode()

grid_effects

Struct for the state of grid effects for a window.

get_grid_effects()

set_grid_effects()

grid_effects.annotate

grid_effects.brightness

grid_effects.colour

grid_effects.font_size

grid_effects.label_frequency

grid_effects.label_plane

grid_effects.origin

grid_effects.show

grid_effects.snap_mode

grid_effects.step

grid_effects.type

grid_effects.visible

viewport_effects

Struct for the state of viewport effects for a window.

get_viewport_effects()

set_viewport_effects()

viewport_effects.anti_alias

viewport_effects.daylight_enable

viewport_effects.direction_dials

viewport_effects.draw_object_extents

viewport_effects.mark_end_on_lines

viewport_effects.refresh_timer

viewport_effects.show_annotations