maptek.vulcan module¶

This module allows access to Vulcan functionality that does not require Envisage interaction. This allows access to the following data classes:

Block models

Isis databases

Map files

Grids

Triangulations

Variant data (spec files, etc)

class maptek.vulcan.SwigPyIterator(*args, **kwargs)¶

Bases: object

property thisown¶: The membership flag

value() → PyObject *¶

incr(n: size_t = 1) → swig::SwigPyIterator *¶

decr(n: size_t = 1) → swig::SwigPyIterator *¶

distance(x: SwigPyIterator) → ptrdiff_t¶

equal(x: maptek.vulcan.SwigPyIterator) → bool¶

copy() → swig::SwigPyIterator *¶

next() → PyObject *¶

previous() → PyObject *¶

advance(n: ptrdiff_t) → swig::SwigPyIterator *¶

class maptek.vulcan.str_list(*args)¶

Bases: object

property thisown¶: The membership flag

iterator() → swig::SwigPyIterator *¶

pop() → std::vector< std::string >::value_type¶

append(x: std::vector< std::string >::value_type const &) → void¶

empty() → bool¶

size() → std::vector< std::string >::size_type¶

swap(v: str_list) → void¶

begin() → std::vector< std::string >::iterator¶

end() → std::vector< std::string >::iterator¶

rbegin() → std::vector< std::string >::reverse_iterator¶

rend() → std::vector< std::string >::reverse_iterator¶

clear() → void¶

get_allocator() → std::vector< std::string >::allocator_type¶

pop_back() → void¶

erase(*args) → std::vector< std::string >::iterator¶

push_back(x: std::vector< std::string >::value_type const &) → void¶

front() → std::vector< std::string >::value_type const &¶

back() → std::vector< std::string >::value_type const &¶

assign(n: std::vector< std::string >::size_type, x: std::vector< std::string >::value_type const &) → void¶

resize(*args) → void¶

insert(*args) → void¶

reserve(n: std::vector< std::string >::size_type) → void¶

capacity() → std::vector< std::string >::size_type¶

class maptek.vulcan.point_list(*args)¶

Bases: object

property thisown¶: The membership flag

iterator() → swig::SwigPyIterator *¶

pop() → std::vector< point >::value_type¶

append(x: point) → void¶

empty() → bool¶

size() → std::vector< point >::size_type¶

swap(v: point_list) → void¶

begin() → std::vector< point >::iterator¶

end() → std::vector< point >::iterator¶

rbegin() → std::vector< point >::reverse_iterator¶

rend() → std::vector< point >::reverse_iterator¶

clear() → void¶

get_allocator() → std::vector< point >::allocator_type¶

pop_back() → void¶

erase(*args) → std::vector< point >::iterator¶

push_back(x: point) → void¶

front() → std::vector< point >::value_type const &¶

back() → std::vector< point >::value_type const &¶

assign(n: std::vector< point >::size_type, x: point) → void¶

resize(*args) → void¶

insert(*args) → void¶

reserve(n: std::vector< point >::size_type) → void¶

capacity() → std::vector< point >::size_type¶

maptek.vulcan.copy_wrapper(obj)¶

maptek.vulcan.deepcopy_wrapper(obj, memo)¶

class maptek.vulcan.variant(*args, **kwargs)¶

Bases: collections.abc.MutableMapping

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.

load(specfile)¶: Loads a Vulcan specification file.

save()¶: Saves a Vulcan spec file to the original name and type.

save_as(specfile=None)¶: Saves a spec file with a new name.

class maptek.vulcan.db_common(*args, **kwargs)¶

Bases: object

Base class for shared methods with database and block model datatypes.

property thisown¶: The membership flag

select(db_common self, std::string const & selection) → int¶

close(db_common self) → int¶

table_list(db_common self) → string_list¶

field_list(db_common self, std::string const & table_name="data") → string_list¶

field_list_numbers(db_common self, std::string const & table_name="data") → string_list¶

field_list_strings(db_common self, std::string const & table_name="data") → string_list¶

is_field(db_common self, std::string const & field, std::string const & table_name="") → bool¶

is_number(db_common self, std::string const & field, std::string const & table_name="") → bool¶

is_string(db_common self, std::string const & field, std::string const & table_name="") → bool¶

get_multiple(db_common self, string_list const & list) → double_list¶

get_multiple_string(db_common self, string_list const & list) → string_list¶

get_table_name(db_common self) → std::string¶

put_table_name(db_common self, std::string const & table_name) → int¶

field_index(db_common self, std::string const & name, std::string const & table="data") → int¶

get(db_common self, std::string const & name) → double¶: get(db_common self, int k) -> double

get_string(db_common self, std::string const & name) → std::string¶: get_string(db_common self, int i) -> std::string

put(db_common self, std::string const & name, double v)¶: put(db_common self, int k, double v)

put_string(db_common self, std::string const & name, std::string const & v)¶: put_string(db_common self, int k, std::string const & v)

next(db_common self) → int¶

rewind(db_common self) → int¶

get_position(db_common self) → double¶

set_position(db_common self, double pos) → int¶

find_key(db_common self, std::string const & key) → int¶

next_key(db_common self) → int¶

write(db_common self) → int¶

eof(db_common self) → bool¶

is_open(db_common self) → bool¶

class maptek.vulcan.isisdb(*args, **kwargs)¶

Bases: maptek.vulcan.db_common

Interface for Vulcan isis databases.

property thisown¶: The membership flag

open(isisdb self, std::string const & name, std::string const & mode, std::string const & env) → int¶

select(isisdb self, std::string const & selection) → int¶

close(isisdb self) → int¶

key_list(isisdb self) → string_list¶

table_list(isisdb self) → string_list¶

field_list(isisdb self, std::string const & table_name="data") → string_list¶

field_list_numbers(isisdb self, std::string const & table_name="data") → string_list¶

field_list_strings(isisdb self, std::string const & table_name="data") → string_list¶

is_field(isisdb self, std::string const & field, std::string const & table_name="") → bool¶

is_number(isisdb self, std::string const & field, std::string const & table_name="") → bool¶

is_string(isisdb self, std::string const & field, std::string const & table_name="") → bool¶

field_index(isisdb self, std::string const & name, std::string const & table="data") → int¶

get_table_index(isisdb self, std::string const & name) → int¶

get_default(isisdb self, int field_id, int table_id) → double¶

get_default_string(isisdb self, int field_id, int table_id) → std::string¶

get_table_name(isisdb self) → std::string¶

get_subtype(isisdb self) → std::string¶

put_table_name(isisdb self, std::string const & rec_type) → int¶

get(isisdb self, std::string const & name) → double¶: get(isisdb self, int field_index) -> double

get_string(isisdb self, std::string const & name) → std::string¶: get_string(isisdb self, int field_index) -> std::string

put(isisdb self, std::string const & name, double v)¶: put(isisdb self, std::string const & name, std::string const & v) put(isisdb self, int field_index, double v)

put_string(isisdb self, std::string const & name, std::string const & v)¶: put_string(isisdb self, std::string const & name, double v) put_string(isisdb self, int field_index, std::string const & v)

get_position(isisdb self) → double¶

set_position(isisdb self, double pos) → int¶

find_key(isisdb self, std::string const & key) → int¶

next_key(isisdb self) → int¶

next_same_key(isisdb self) → int¶

delete_key(isisdb self, std::string const & key) → int¶

get_key(isisdb self) → std::string¶

synonym(isisdb self, std::string const & db_type, std::string const & name) → std::string¶

field_size(isisdb self, std::string const & field, std::string const & table_name) → int¶

next(isisdb self) → int¶

rewind(isisdb self) → int¶

write(isisdb self) → int¶

insert_after(isisdb self) → int¶

insert_before(isisdb self) → int¶

get_buffer(isisdb self) → std::string¶

append_buffer(isisdb self, std::string const & table_name, std::string const & buffer) → int¶

append(isisdb self) → int¶

delete_record(isisdb self) → int¶

has_dsr(isisdb self) → int¶

get_coordinate(isisdb self, double depth) → double_list¶

property keys¶

Generator to move from one key to the next in an isisdb

Yields

Database index for each key.

Example

>>> # Iterates through all the keys in a database and
>>> # prints the key names.
>>> for key in db.keys:
>>>     print (db.get_key())

property this_key¶

Generator to move through the records of the current key from the beginning of the key.

Yields

Database index of the records while moving through the current key.

Example

>>> # Prints the contents of the depth field for the
>>> # current key on the table SURVEY
>>> for record in db.this_key:
>>>     if db.get_table_name() == "SURVEY":
>>>         print (record['DEPTH'])

key(key)¶

This is a generator to loop through the records in the current or specified key. If no key is provided, it will loop over the current key records. If a key name is provided, it will move until that key is found and return the records of that key. If no key is found, it will raise a NameError.

Parameters

key – Key name to be looped (“” = current key)

Yields

Database index for the specified key

Example

>>> # Prints the contents of the depth field for the
>>> # key LK177 on the table SURVEY
>>> for record in db.key("LK177"):
>>>     if db.get_table_name() == "SURVEY":
>>>         print (record['DEPTH'])

this_table(table)¶

This is a generator to loop in the current or specified table of the current key. If no table is provided, it will loop over the current table. If a table name is provided, it will move until that table is found and return the results of that table. If no table is found, it will return nothing.

Parameters

table – Table name to be looped (“” = current table)

Yields

Database index for the specified table

Example

>>> # Prints the contents of the depth field for the
>>> # survey table (on the current key)
>>> for record in db.this_table("SURVEY"):
>>>     print (record['DEPTH'])

goto_table(table)¶

This is a function that will move to a specified table name by moving to the beginning of the current key and finding the start of the specified table name. If no table is found, it will raise NameError.

Parameters: table (str) – Table name to be found
Returns: True on success and position of current record is set.
Examples

>>> # Goes to a requested table name
>>> db.goto_table("SURVEY"):

class maptek.vulcan.block_model(*args)¶

Bases: maptek.vulcan.db_common

Interface for Vulcan block models

property thisown¶: The membership flag

open(block_model self, std::string const & name, std::string const & mode="w", std::string const & env="") → int¶

create_regular(block_model self, std::string const & name, double x0, double y0, double z0, double x1, double y1, double z1, int nx, int ny, int nz) → int¶

create_irregular(block_model self, std::string const & name, double x0, double y0, double z0, double x1, double y1, double z1, int nx, int ny, int nz) → int¶: create_irregular(block_model self, std::string const & name, double x0, double y0, double z0, double x1, double y1, double z1, int nx, int ny, int nz, int sub_nx, int sub_ny, int sub_nz) -> int

create_strat(block_model self, std::string const & name, double x0, double y0, double z0, double x1, double y1, double z1, int nx, int ny) → int¶

translate(block_model self, double x, double y, double z) → int¶

rotate(block_model self, double a, double b, double c) → int¶

scale(block_model self, double a, double b, double c) → int¶

select(block_model self, std::string const & selection) → int¶

select_xy_seam(block_model self, double x, double y, std::string const & seam) → int¶

push_select(block_model self, std::string const & selection) → int¶

pop_select(block_model self) → int¶

close(block_model self) → int¶

table_list(block_model self) → string_list¶

field_list(block_model self, std::string const & table_name="data") → string_list¶

field_list_numbers(block_model self, std::string const & table_name="data") → string_list¶

field_list_strings(block_model self, std::string const & table_name="data") → string_list¶

get_translation_values(block_model self, std::string const & field_name) → string_list¶

is_field(block_model self, std::string const & field, std::string const & table_name="") → bool¶

is_number(block_model self, std::string const & field, std::string const & table_name="") → bool¶

is_string(block_model self, std::string const & field, std::string const & table_name="") → bool¶

field_index(block_model self, std::string const & name, std::string const & table="data") → int¶

field_default(block_model self, std::string const & name, std::string const & table_name="") → double¶

field_default_string(block_model self, std::string const & name, std::string const & table_name="") → std::string¶

field_description(block_model self, std::string const & name, std::string const & table_name="") → std::string¶

field_type(block_model self, std::string const & name, std::string const & table_name="") → std::string¶

field_predefined(block_model self, std::string const & name, std::string const & table_name="") → int¶

get_table_name(block_model self) → std::string¶

put_table_name(block_model self, std::string const & table_name) → int¶

get(block_model self, std::string const & name) → double¶: get(block_model self, int k) -> double

get_variable_index(block_model self, std::string const & name) → int¶

get_string(block_model self, std::string const & name) → std::string¶: get_string(block_model self, int i) -> std::string

put(block_model self, std::string const & name, double v)¶: put(block_model self, std::string const & name, std::string const & v) put(block_model self, int k, double v)

put_string(block_model self, std::string const & name, std::string const & v)¶: put_string(block_model self, int k, std::string const & v)

add_block(block_model self, double x0, double y0, double z0, double x1, double y1, double z1) → int¶

move_block(block_model self, double x0, double y0, double z0, double x1, double y1, double z1) → int¶

add_variable(block_model self, std::string const & name, std::string const & type, std::string const & defalt, std::string const & description) → int¶

delete_variable(block_model self, std::string const & name) → int¶

next(block_model self) → int¶

rewind(block_model self) → int¶

get_position(block_model self) → double¶

set_position(block_model self, double pos) → int¶

find_key(block_model self, std::string const & key) → int¶

next_key(block_model self) → int¶

find_xyz(block_model self, double x, double y, double z) → int¶: find_xyz(block_model self, Point_type const & arg2) -> int

find_world_xyz(block_model self, double x, double y, double z) → int¶: find_world_xyz(block_model self, Point_type const & arg2) -> int

find_xy_seam(block_model self, double x, double y, std::string const & seam) → int¶: find_xy_seam(block_model self, Point_type const & p, std::string const & seam) -> int

find_world_xyz_seam(block_model self, Point_type const & p, std::string const & seam) → int¶: find_world_xyz_seam(block_model self, double x, double y, double z, std::string const & seam) -> int

to_world(block_model self, double x, double y, double z) → double_list¶: to_world(block_model self, Point_type const & p) -> Point_type

to_model(block_model self, double x, double y, double z) → double_list¶: to_model(block_model self, Point_type const & p) -> Point_type

model_extent(block_model self) → double_list¶

model_orientation(block_model self) → double_list¶

model_origin(block_model self) → double_list¶

set_model_origin(block_model self, double x0, double y0, double z0) → int¶

set_model_orientation(block_model self, double a1, double a2, double a3) → int¶

model_n_schemas(block_model self) → int¶

model_schema_extent(block_model self, int k) → double_list¶

model_schema_size(block_model self, int k) → double_list¶

model_schema_dimensions(block_model self, int k) → double_list¶

n_blocks(block_model self) → int¶

match_extent(block_model self) → double_list¶

match_volume(block_model self) → double¶

block_extent(block_model self) → double_list¶

index_model(block_model self) → int¶

is_indexed(block_model self) → int¶

write(block_model self) → int¶

is_tb_model(block_model self) → bool¶

get_matches(block_model self, std::string const & match_string) → ARRAY_RESULT_LONGLONG¶

get_matches_extent(block_model self, std::string const & match_string) → MATCH_EXTENT_RESULT¶

get_data_double(block_model self, std::string const & name, int n0) → ARRAY_RESULT_DOUBLE¶

get_data_float(block_model self, std::string const & name, int n0) → ARRAY_RESULT_FLOAT¶

get_data_string(block_model self, std::string const & name, int n0) → ARRAY_RESULT_STRING¶

put_data_double(block_model self, std::string const & name, int n1, int n0) → int¶

put_data_float(block_model self, std::string const & name, int n1, int n0) → int¶

put_data_string_list(block_model self, std::string const & name, string_list const & data, int n0) → int¶

get_regular_indices(block_model self) → ARRAY_RESULT_LONGLONG¶

get_pandas(vars=None, select=None)¶

Gets block model data as a pandas.DataFrame

Parameters

vars – Variable list to get from model. Defaults to all variables if None
select – Selection string to use.

Returns

pandas.DataFrame

get_pandas_extent(vars=None, select=None)¶

Gets all matches within an extent.

Parameters

vars – Variable list to get from model.
select – Selection string to use.

Returns

Block model within the match extent.

Return type

pandas.DataFrame

get_data(var, sel=None)¶

Gets the values of a set of blocks, or all blocks if no selection is provided.

Parameters

variable (str) – Variable to get data from
sel – List of block indices to get from such as the return from block_model.get_matches()

Returns

NumPy array of all values for the specified variable.

Return type

numpy.array()

Example

>>> matches = bm.get_matches("-C "rocktype eq 'oxide'"")
>>> data = bm.get_data("au", matches)

put_data(var, data, sel=None)¶

Stores the values of a numpy array into the block model.

Parameters

variable – Variable to get data from
data – Data to be stored (numpy array)
sel – List of block indices to store to such as the return from block_model.get_matches()

Returns

None

Example

>>> matches = bm.get_matches("-C "rocktype eq 'oxide'"")
>>> bm.put_data("au", data, matches)

put_data_string(var, data, sel=None)¶

Stores numpy string array to a block model string variable.

Parameters

var (str) – Variable name to write to.
data (numpy.array) – NumPy array with string data
sel – Selection of block indices to write to (from get_matches())

put_pandas(dataframe, vars=None)¶

Puts a Pandas dataframe into the block model.

Parameters

dataframe – DataFrame with block model data
vars – Variables to update (optional) DataFrame columns used when no var list is provided.

Returns

None

get_grid(var)¶

Returns a 3D i/j/k grid of block model values for a regular block model.

Parameters: var – Variable name to get data for.
Returns: 3D numpy array with block values in i/j/k or x/y/z order
Return type: numpy.array

put_grid(var, data)¶

Stores a 3D i/j/k grid of values into a regular block model.

Parameters

var – Variable name to get data for.
(numpy.array (data) – 3D numpy array of block model values for all blocks

Returns

None

class maptek.vulcan.mapio(*args, **kwargs)¶

Bases: maptek.vulcan.db_common

Proxy of C++ mapio class.

property thisown¶: The membership flag

open(mapio self, std::string const & name, std::string const mode="w", std::string const env="coal", std::string const project="abc") → int¶

select(mapio self, std::string const & selection) → int¶

close(mapio self) → int¶

table_list(mapio self) → string_list¶

field_list(mapio self, std::string const & table_name="data") → string_list¶

field_list_numbers(mapio self, std::string const & table_name="data") → string_list¶

field_list_strings(mapio self, std::string const & table_name="data") → string_list¶

is_field(mapio self, std::string const & field, std::string const & table_name="") → bool¶: is_field(mapio self, int const & field_index, std::string const & table_name=””) -> bool

is_number(mapio self, std::string const & field, std::string const & table_name="") → bool¶: is_number(mapio self, int const & field_index, std::string const & table_name=””) -> bool

is_string(mapio self, std::string const & field, std::string const & table_name="") → bool¶: is_string(mapio self, int const & field_index, std::string const & table_name=””) -> bool

get_table_name(mapio self) → std::string¶

put_table_name(mapio self, std::string const & rec_type) → int¶

get(mapio self, std::string const & name) → double¶: get(mapio self, int k) -> double

get_string(mapio self, std::string const & name) → std::string¶: get_string(mapio self, int i) -> std::string

field_index(mapio self, std::string const & name, std::string const & table="data") → int¶

put(mapio self, std::string const & name, double v)¶: put(mapio self, std::string const & name, std::string const & v) put(mapio self, int k, double v)

put_string(mapio self, std::string const & name, std::string const & v)¶: put_string(mapio self, std::string const & name, double v) put_string(mapio self, int k, std::string const & v)

get_position(mapio self) → double¶

set_position(mapio self, double pos) → int¶

find_key(mapio self, std::string const & key) → int¶

next_key(mapio self) → int¶

field_size(mapio self, std::string const & field, std::string const & table_name) → int¶

next(mapio self) → int¶

rewind(mapio self) → int¶

write(mapio self) → int¶

append(mapio self) → int¶

class maptek.vulcan.triangulation(*args, **kwargs)¶

Bases: object

Interface for Vulcan triangulations.

property thisown¶: The membership flag

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

load_grid(triangulation self, VGD_grid_t grid)¶: Loads a grid into the current triangulation (overwrites)

update_grid(triangulation self, VGD_grid_t grid)¶: Updates a grid with the current triangulation.

is_ok(triangulation self) → bool¶: Reports the triangulation load status (true if new)

is_closed(triangulation self) → bool¶: Reports the triangulation closure state.

is_crossing(triangulation self) → bool¶: Reports the existence of crossing triangles.

is_consistent(triangulation self) → bool¶: Reports the existence of inconsistent triangles.

n_nodes(triangulation self) → int¶: Returns the number of nodes in the triangulation.

n_faces(triangulation self) → int¶: Returns the number of facets in the triangulation.

get_face(triangulation self, int k) → int_list¶: Gets a facet and its point indices by index.

set_face(triangulation self, int k, int n1, int n2, int n3)¶: Sets a facets points by index.

get_node(triangulation self, int k) → double_list¶: Gets a vertex from the triangulation.

set_node(triangulation self, int k, double x, double y, double z)¶: Sets a triangulation vertex.

add_face(triangulation self, int n1, int n2, int n3) → int¶: Adds a facet to the triangulation.

add_node(triangulation self, double x, double y, double z) → int¶: Adds a vertex to the triangulation.

delete_face(triangulation self, int k, bool purge_points=False)¶: Deletes a facet from the triangulation. (Optional) Purges points no longer used.

delete_node(triangulation self, int k)¶: Deletes a point from the triangulation.

clear_triangles(triangulation self)¶: Clears all triangle data, leaving attributes intact.

clear(triangulation self)¶: Clears all data from the triangulation.

get_colour_index(triangulation self) → int¶: Gets the triangulation color (index).

set_colour_index(triangulation self, int colour)¶: Sets the triangulation colour (index).

is_rgb(triangulation self) → bool¶: Returns True if the triangulation color is RGB.

get_rgb(triangulation self) → int_list¶: Gets the triangulation color(RGB).

set_rgb(triangulation self, int_list const & rgb)¶: Sets the triangulation colour(RGB).

get_translucency(triangulation self) → double¶: Gets the triangulation translucency.

set_translucency(triangulation self, double const value)¶: Sets the triangulation translucency.

get_properties(triangulation self) → MVariant¶: Gets the triangulation property dictionary.

set_properties(triangulation self, MVariant & props)¶: Sets the triangulation property dictionary.

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.

neighbors(triangulation self, int k) → int_list¶: Gets the triangle neighbors.

node_neighborhood(triangulation self, int k) → int_list¶: Gets the node triangle neighborhood.

face_neighborhood(triangulation self, int k) → int_list¶: Gets the facet neighborhood.

face_direction(triangulation self, int k) → point ¶: Gets the facet direction as a unit vector.

extent_pts(triangulation self) → point_list ¶: Gets the triangulation extent as points.

extent(triangulation self) → double_double_list¶: Gets the triangulation extent as a list.

close(triangulation self) → bool¶: Attempts to close a open triangulation.

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

normalise(triangulation self)¶: Normalises a triangulation, fixing facet directions.

contour(triangulation self, double z) → obj_list¶: Gets the contours of a triangulation at a specified Z elevation

shortest_path(triangulation self, point start, point end) → VulcanObj¶

volume(triangulation self) → double¶: Returns the volume of a closed triangulation.

translate(triangulation self, point translation) → bool¶: Translates a triangulation by an x/y/z shift.

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.

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

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

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

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.

solid_from_polygon(triangulation self, double width, int poly_position)¶: Creates a solid from the points of the trianulation, projecting them vertically.

get_vertices(triangulation self) → ARRAY_RESULT_DOUBLE2¶: Gets the vertices of a triangulation as a NumPy array.

get_faces(triangulation self) → ARRAY_RESULT_LONGLONG2¶: Gets the facets of a triangulation as a NumPy array.

put_vertices(triangulation self, int n0)¶: Stores a NumPy array of vertices to the triangulation.

put_faces(triangulation self, int n0)¶: Stores a NumPy array of facets to the triangulation.

append_vertices(triangulation self, int n0)¶: Appends a NumPy array of vertices to the triangulation.

append_faces(triangulation self, int n0)¶: Appends a NumPy array of facets to the triangulation.

property nodes¶

Generator to move through each node of a triangulation.

Example

>>> for node in tri.nodes:
>>>     print (node)

property faces¶

Generator to move through each facet of a triangulation.

Example

>>> for face in tri.faces:
>>>     print (face)

property node¶

Returns a node from a triangulation using the syntax tri.node[i]

Returns: Node x/y/z data at a given index
Return type: list
Example

>>> for i in range(tri.n_nodes()):
>>>     print (tri.node[i])

property face¶

Returns a face from a triangulation using the syntax tri.face[i]

Returns: Facet node connections of a triangulation at an index
Return type: list
Example

>>> for i in range(tri.n_faces()):
>>>     print (tri.face[i])

get_colour()¶

Returns the colour of the triangulation in either RGB or colour index.

Returns: RGB colour int : Colour Index
Return type: list

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

property colour¶: Sets and gets the color of a triangulation.

class maptek.vulcan.tri_attributes(name: std::string const &)¶

Bases: object

Interface for Vulcan triangulation attributes.

property thisown¶: The membership flag

is_ok(tri_attributes self) → bool¶

put(tri_attributes self, std::string const & name, std::string const & value, std::string const & type="String") → bool¶: put(tri_attributes self, std::string const & name, int value, std::string const & type=”Integer”) -> bool

delete_key(tri_attributes self, std::string const & name)¶

clear(tri_attributes self)¶

get_string(tri_attributes self, std::string const & name) → std::string¶

get_type(tri_attributes self, std::string const & name) → std::string¶

get_keys(tri_attributes self) → string_list¶

get_values(tri_attributes self) → string_list¶

get_hash(tri_attributes self) → string_string_map¶

get_types(tri_attributes self) → string_list¶

exists(tri_attributes self, std::string const & name) → bool¶

get_last_error(tri_attributes self) → std::string¶

save(tri_attributes self)¶

class maptek.vulcan.VGD_grid_cell_t(*args)¶

Bases: object

Proxy of C++ VGD_grid_cell_t class.

property thisown¶: The membership flag

set_w(VGD_grid_cell_t self, double _w) → VGD_grid_cell_t ¶

put_w(VGD_grid_cell_t self, double _w) → VGD_grid_cell_t ¶

set_mask(VGD_grid_cell_t self, int _mask) → VGD_grid_cell_t ¶

put_mask(VGD_grid_cell_t self, int _mask) → VGD_grid_cell_t ¶

get_w(VGD_grid_cell_t self) → double¶

get_mask(VGD_grid_cell_t self) → int¶

get_w_and_mask(VGD_grid_cell_t self, float * ww, int * m)¶: get_w_and_mask(VGD_grid_cell_t self, double * ww, int * m)

copy(VGD_grid_cell_t self, VGD_grid_cell_t copy) → VGD_grid_cell_t ¶

class maptek.vulcan.VGD_grid_t(*args)¶

Bases: object

Proxy of C++ VGD_grid_t class.

property thisown¶: The membership flag

clear(VGD_grid_t self)¶

load(VGD_grid_t self, string const & name="") → int¶

save(VGD_grid_t self, string const & name="") → int¶

load_esri(VGD_grid_t self, string const & name="") → int¶

save_esri_ascii(VGD_grid_t self, string const & name) → int¶

get_x0(VGD_grid_t self) → double¶

get_y0(VGD_grid_t self) → double¶

get_dx(VGD_grid_t self) → double¶

get_dy(VGD_grid_t self) → double¶

n_data(VGD_grid_t self) → int¶

get_nx(VGD_grid_t self) → int¶

get_ny(VGD_grid_t self) → int¶

get_x(VGD_grid_t self, int k) → double¶

get_y(VGD_grid_t self, int k) → double¶

get_mask(VGD_grid_t self, int k) → int¶

put_w(VGD_grid_t self, int k, double w)¶

put_mask(VGD_grid_t self, int k, int mask)¶

ij_to_pos(VGD_grid_t self, int i, int j) → int¶

get_w(VGD_grid_t self, int k) → double¶: get_w(VGD_grid_t self, double x, double y, double * w, int * mask)

get_z(VGD_grid_t self, double x, double y, double * w, int * mask)¶

get_elevation(VGD_grid_t self, double x, double y) → double¶

get_elevation_mask(VGD_grid_t self, double x, double y) → int¶

get_w_missing(VGD_grid_t self, double x, double y, double * w, int * mask)¶

get_elevation_missing(VGD_grid_t self, double x, double y, double * w, int * mask) → double¶

get_elevation_missing_mask(VGD_grid_t self, double x, double y, double * w, int * mask) → int¶

set_x0(VGD_grid_t self, double _x0) → VGD_grid_t ¶

set_y0(VGD_grid_t self, double _y0) → VGD_grid_t ¶

set_dx(VGD_grid_t self, float _dx) → VGD_grid_t ¶

set_dy(VGD_grid_t self, float _dy) → VGD_grid_t ¶

set_size(VGD_grid_t self, int _nx, int _ny) → VGD_grid_t ¶

copy(VGD_grid_t self, VGD_grid_t right)¶

basic_stats(VGD_grid_t self, double * average, double * minw, double * maxw, double * variance, int * count)¶

get_values(VGD_grid_t self) → ARRAY_RESULT_FLOAT¶

get_values_mask(VGD_grid_t self) → ARRAY_RESULT_LONGLONG¶

get_x_coordinates(VGD_grid_t self) → ARRAY_RESULT_DOUBLE¶

get_y_coordinates(VGD_grid_t self) → ARRAY_RESULT_DOUBLE¶

put_values(VGD_grid_t self, int n0)¶

put_values_mask(VGD_grid_t self, int n0)¶

property ok¶

int

Type: ok

get_grid()¶

get_grid_mask()¶

get_grid_x()¶

get_grid_y()¶

put_grid(data)¶

put_grid_mask(mask)¶

get_pandas()¶

put_pandas(dataframe)¶

property pandas¶: Pandas DataFrame for vulcan.grid.

class maptek.vulcan.grid(name: std::string const &)¶

Bases: maptek.vulcan.VGD_grid_t

Interface for Vulcan grids.

property thisown¶: The membership flag

maptek.vulcan.python_authorise(char const * mode, char const * name) → bool¶: Checks authorization of Vulcan functionality by authorization mode and process name.

maptek.vulcan.check_python_auth() → bool¶: Checks authorization of Python scripting.

maptek.vulcan.shutdown_python_auth()¶

maptek.vulcan.get_spec_type(std::string const & specName) → std::string¶: Returns the spec file type (FORMATTED/VARIANT).

maptek.vulcan.load_spec(std::string specName) → MVariant¶: Loads a Vulcan specfile into a dictionary.

maptek.vulcan.save_spec(MVariant & dictionary, std::string specName) → bool¶: Saves a dictionary as a Vulcan specfile.

maptek.vulcan.save_formatted_spec(MVariant dictionary, std::string specName, MVariant sectionOrder=MVariant()) → bool¶: Saves a dictionary into a formatted specfile.

class maptek.vulcan.dgd(*args, **kwargs)¶

Bases: object

Interface for Vulcan design databases.

property thisown¶: The membership flag

is_locked(dgd self) → bool¶: Returns dgd lock status by checking for lock files.

close(dgd self)¶: Closes dgd.

is_layer(dgd self, std::string const & name) → bool¶: Checks if a layer exists in the dgd.

get_layer(dgd self, std::string const name) → layer ¶: Gets a layer from the database.

is_open(dgd self) → bool¶: Checks if the database is open.

num_layers(dgd self) → int¶: Returns the number of layers in the database.

list_layers(dgd self) → string_list¶: Lists the layers in the database.

delete_layer(dgd self, std::string const & layer) → bool¶: Deletes a layer in the database.

save_layer(dgd self, layer layerInstance) → bool¶: Saves a layer to the database.

save_layer_as(dgd self, std::string const name, layer layerInstance) → bool¶: Saves a layer to the database with a new name.

append(dgd self, layer layerInstance) → bool¶: Adds a new layer to the database. (Raises on duplicates.)

property layers¶: List of layers in database

property locked¶: Database work lock status.

property open¶: Database open status.

class maptek.vulcan.layer(name: std::string)¶

Bases: object

Interface for Vulcan layers.

property thisown¶: The membership flag

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

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

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

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

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

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

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

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

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

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

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

get_objects_enumerate(types: list)¶

Gets the objects of a specified types from a layer and layer indices. :param types: List of object types to get from the layer. :type types: list

Returns: List of vulcan objects of the specified types and the layer index.
Return type: list[[idx, obj]]
Example

>>> types = [vulcan.polyline]
>>> for i, obj in layer.get_objects_enumerate(types):
>>>     for pt in obj:
>>>         pt += 5 # Shift the object by 5 in x/y/z
>>>     layer[i] = obj

get_objects(types: list)¶

Gets the objects of a specified types from a layer. 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() :param types: List of object types to get from the layer. :type types: list

Returns: List of vulcan objects of the specified types.
Return type: list
Example

>>> types = [vulcan.text, vulcan.text3d]
>>> for obj in get_objects(types):
>>>     print (type(obj))

property name¶: Layer name

property description¶: Layer description

class maptek.vulcan.obj(*args, **kwargs)¶

Bases: object

Base class for shared methods in design object datatypes

property thisown¶: The membership flag

clear(obj self)¶: Clear out an object’s data.

get_type(obj self) → std::string¶: Get the object type name.

object_details(obj self) → std::string¶: Gets the object’s information as a formatted report.

get_name(obj self) → std::string¶: Gets the object name.

set_name(obj self, std::string const & name)¶: Sets the object name.

get_layer(obj self) → std::string¶: Gets the object layer.

get_description(obj self) → std::string¶: Gets the object description.

set_description(obj self, std::string const & desc)¶: Sets the object description.

get_feature(obj self) → std::string¶: Gets the object feature.

set_feature(obj self, std::string const & feature)¶: Sets the object feature.

get_group(obj self) → std::string¶: Gets the object group.

set_group(obj self, std::string const & group)¶: Sets the object group.

get_value(obj self) → double¶: Gets the object value.

set_value(obj self, double const & value)¶: Sets the object value.

get_colour(obj self) → int¶: Gets the object colour.

set_colour(obj self, int colour)¶: Sets the object colour.

num_links(obj self) → int¶: Gets the number of object links.

get_link(obj self, int k) → std::string¶: Gets the object link.

get_linktype(obj self, int k) → int¶: Gets the object link type.

set_link(obj self, int k, int type, std::string const & value)¶: Sets the object link.

get_linkdata(obj self) → MVariant¶: Gets a copy of the object link data.

set_linkdata(obj self, MVariant & dictionary)¶: Sets the object link data from a dictionary.

get_primitive(obj self) → MVariant¶: Gets a copy of the object primitive data.

set_primitive(obj self, MVariant & dictionary)¶: Sets the object primitive data.

get_attributes(obj self) → attributes ¶: Gets a reference to the object attribute data.

set_attributes(obj self, attributes attr)¶: Sets the object attribute data.

get_metadata(obj self) → metadata ¶: Gets a reference to the object metadata.

set_metadata(obj self, metadata meta)¶: Sets the object metadata.

get_section_widths(obj self) → section_widths ¶: Gets a reference to the object section width data.

set_section_widths(obj self, section_widths sect)¶: Sets the object section width data.

property type¶: Object type

property name¶: Object name

property layer¶: Object layer

property description¶: Object description

property feature¶: Object feature code

property group¶: Object group

property value¶: Object value

property colour¶: Object colour

property linkdata¶: Object link data

property metadata¶: Object metadata

property attributes¶: Object attribute data

property section_widths¶: Object section width data

class maptek.vulcan.point(*args, **kwargs)¶

Bases: object

Interface for Vulcan design points.

property thisown¶: The membership flag

distance(point self, point other) → double¶

get_x(point self) → double¶

set_x(point self, double const & x)¶

get_y(point self) → double¶

set_y(point self, double const & y)¶

get_z(point self) → double¶

set_z(point self, double const & z)¶

get_w(point self) → double¶

set_w(point self, double const & w)¶

get_t(point self) → int¶

set_t(point self, int const & t)¶

get_name(point self) → std::string¶

set_name(point self, std::string const & name)¶

property xyz¶

Generator for the x/y/z portion of a point.

Yields: Point x/y/z properties

property x¶: Point x value

property y¶: Point y value

property z¶: Point z value

property w¶: Point w value

property t¶: Point t (0/1 = connection)

property name¶: Point name

class maptek.vulcan.polyline(points: Optional[maptek.vulcan.point_list] = None)¶

Bases: maptek.vulcan.obj

Interface for Vulcan design polylines.

property thisown¶: The membership flag

get_linetype(polyline self) → int_list¶: Gets the linetype as a list (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 line.

set_pattern(polyline self, int pattern)¶: Sets the pattern index of a line.

get_point(polyline self, int const k) → point ¶: Gets a point from a line by index.

set_point(polyline self, int const k, double const x, double const y, double const z, double const w, int const t, std::string const name) → bool¶: Sets a point by index and values (with kwargs).

set_point_from_point(polyline self, int const k, point pt) → bool¶: Sets a point from a vulcan.point

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 by 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)¶

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 ¶: Gets the change in x/y/z (as a point)

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.

property linetype¶: Polyline linetype

property pattern¶: Polyline pattern

property closed¶: Polyline closure (bool)

property clockwise¶: Polyline direction (bool)

property coordinates¶: Polyline coordinates

class maptek.vulcan.text(*args)¶

Bases: maptek.vulcan.obj

Interface for Vulcan design text (2D).

property thisown¶: The membership flag

num_lines(text self) → int¶: Returns the number of text lines.

get_line(text self, int line_num) → std::string¶: Gets a line of text by index.

append(text self, std::string const & line)¶: Appends a line of text.

set_line(text self, int line_num, std::string const & line)¶: Sets a line of text by index.

delete_line(text self, int line_num)¶: Deletes a line of text by index.

delete_all_lines(text self)¶: Deletes all lines of text.

get_origin(text self) → point ¶: Gets the text origin point.

set_origin(text self, point pt)¶: Sets the text origin point.

get_angle(text self) → double¶: Gets the text angle.

set_angle(text self, double angle)¶: Sets the text angle.

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

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

get_height(text self) → double¶: Gets the text height.

set_height(text self, double height)¶: Sets the text height.

get_width(text self) → double¶: Gets the text width.

set_width(text self, double width)¶: Sets the text width.

get_font(text self) → std::string¶: Gets the text font.

set_font(text self, std::string const & font)¶: Sets the text font.

is_framed(text self) → bool¶: Text frame status (bool)

set_framed(text self, bool frame=True)¶: Sets/Removes text frame.

property origin¶: Text origin

property angle¶: Text angle

property scale¶: Text scale

property height¶: Text height

property width¶: Text width

property font¶: Text font

property framed¶: Is text framed

class maptek.vulcan.text3d(*args, **kwargs)¶

Bases: maptek.vulcan.obj

Interface for Vulcan design text (3D)

property thisown¶: The membership flag

num_lines(text3d self) → int¶: Returns the number of text lines.

get_line(text3d self, int line_num) → std::string¶: Gets a text line by index.

append(text3d self, std::string const & line)¶: Appends a new line of text.

set_line(text3d self, int line_num, std::string const & line)¶: Sets a line of text by index.

delete_line(text3d self, int line_num)¶: Deletes a line of text.

delete_all_lines(text3d self)¶: Deletes all lines of text.

get_origin(text3d self) → point ¶: Gets the origin point.

set_origin(text3d self, point pt)¶: Sets the origin point.

get_direction(text3d self) → point ¶: Gets the text direction (point with x/y/z)

set_direction(text3d self, point direction)¶: Sets the text direction.

get_normal(text3d self) → point ¶: Gets the text normal.

set_normal(text3d self, point normal)¶: Sets the text normal.

get_scale(text3d self) → std::string¶: Gets the text scale.

set_scale(text3d self, std::string const & scale)¶: Sets the text scale.

get_height(text3d self) → double¶: Gets the text height.

set_height(text3d self, double height)¶: Sets the text height.

get_width(text3d self) → double¶: Gets the text width.

set_width(text3d self, double width)¶: Sets the text width.

get_font(text3d self) → std::string¶: Gets the text font.

set_font(text3d self, std::string const & font)¶: Sets the text font.

is_italic(text3d self) → bool¶: Gets the text italic setting(bool).

set_italic(text3d self, bool italic=True)¶: Sets the font italics.

is_mirrored_vertical(text3d self) → bool¶: Gets the font’s mirror (vertical)

set_mirrored_vertical(text3d self, bool mirror=True)¶: Sets the text mirror(vertical)

is_mirrored_horizontal(text3d self) → bool¶: Gets the font’s mirror (horizontal)

set_mirrored_horizontal(text3d self, bool mirror=True)¶: Sets the text mirror(horizontal)

get_horizontal_align(text3d self) → std::string¶: Gets the horizontal alignment.

set_horizontal_align(text3d self, std::string const & alignment)¶: Sets the horizontal alignment.

get_vertical_align(text3d self) → std::string¶: Gets the vertical alignment.

set_vertical_align(text3d self, std::string const & alignment)¶: Sets the vertical alignment.

property origin¶: Text origin

property direction¶: Text direction

property normal¶: Text normal

property scale¶: Text scale

property height¶: Text height

property width¶: Text width

property font¶: Text font

property italic¶: Text italic setting

property mirrored_vertical¶: Is text mirrored vertically

property mirrored_horizontal¶: Is text mirrored horizontally

property horizontal_align¶: Is text aligned horizontally

property vertical_align¶: Is text aligned vertically

class maptek.vulcan.arrow¶

Bases: maptek.vulcan.obj

Interface for Vulcan design arrows.

property thisown¶: The membership flag

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

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

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

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

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

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

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

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

is_auto_scale(arrow self) → bool¶: Returns the arrow auto scale setting.

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

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

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

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

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

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

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

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

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

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

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

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_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 (2D/3D).

property start¶: Arrow start

property end¶: Arrow end

property normal¶: Arrow normal

property scale¶: Arrow scale

property num_facets¶: Arrow number of facets

property head_length¶: Arrow head length

property head_width¶: Arrow head width

property relative_head_length¶: Arrow relative head length

property relative_head_width¶: Arrow relative head width

property arrow_type¶: Arrow type (2D, 3D)

property auto_scale¶: Arrow auto scale

property filled¶: Arrow fill setting

class maptek.vulcan.dimension(*args, **kwargs)¶

Bases: maptek.vulcan.obj

Base class for Vulcan design dimensions.

property thisown¶: The membership flag

get_font(dimension self) → std::string¶: Gets the dimension font.

set_font(dimension self, std::string const & name)¶: Sets the dimension font.

get_scaled_text_height(dimension self) → double¶: Gets the dimension scaled text height.

get_text_height(dimension self) → double¶: Gets the dimension text height.

set_text_height(dimension self, double height)¶: Sets the dimension text height.

get_text_map_size(dimension self) → double¶: Gets the dimension text map size.

set_text_map_size(dimension self, double size)¶: Sets the dimension text map size.

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

get_scale_factor(dimension self, std::string const & unit) → double¶: Gets the dimension scale factor.

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

get_label(dimension self) → std::string¶: Gets the dimension label.

set_label(dimension self, std::string const & label)¶: Sets the dimension label.

get_tick_offset(dimension self) → double¶: Gets the dimension tick offset.

set_tick_offset(dimension self, double offset)¶: Sets the dimension tick offset.

get_tick_gap(dimension self) → double¶: Gets the dimension tick gap.

set_tick_gap(dimension self, double gap)¶: Sets the dimension tick gap.

get_tick_extent_size(dimension self) → double¶: Gets the dimension tick extent size.

set_tick_extent_size(dimension self, double size)¶: Sets the dimension tick extent size.

is_mirrored_horizontally(dimension self) → bool¶: Returns the dimension mirror setting (horizontal).

set_mirrored_horizontally(dimension self, bool mirror=True)¶: Sets the dimension mirror setting (horizontal).

is_mirrored_vertically(dimension self) → bool¶: Returns the dimension mirror setting (vertical).

set_mirrored_vertically(dimension self, bool mirror=True)¶: Sets the dimension mirror setting (vertical).

get_arrow_length(dimension self) → double¶: Gets the dimension arrow length.

set_arrow_length(dimension self, double length)¶: Sets the dimension arrow length.

get_arrow_width(dimension self) → double¶: Gets the dimension arrow width.

set_arrow_width(dimension self, double width)¶: Sets the dimension arrow width.

property font¶: Dimension font

property text_height¶: Dimension text height

property text_map_size¶: Dimension text map size

property scale¶: Dimension scale

property label¶: Dimension label

property tick_offset¶: Dimension tick offset

property tick_gap¶: Dimension tick gap

property tick_extent_size¶: Dimension tick extent size

property mirrored_horizontally¶: Dimension mirror (horizontal)

property mirrored_vertically¶: Dimension mirror (vertical)

property arrow_length¶: Dimension arrow length

property arrow_width¶: Dimension arrow width

class maptek.vulcan.dim_angle¶

Bases: maptek.vulcan.dimension

Interface for Vulcan design dimension angles.

property thisown¶: The membership flag

get_origin(dim_angle self) → point ¶: Gets the dimension origin.

set_origin(dim_angle self, point point)¶: Sets the dimension origin.

get_radius(dim_angle self) → point ¶: Gets the dimension radius.

set_radius(dim_angle self, point point)¶: Sets the dimension radius.

get_sweep(dim_angle self) → point ¶: Gets the dimension sweep.

set_sweep(dim_angle self, point point)¶: Sets the dimension sweep.

swap_points(dim_angle self)¶: Swaps the dimension points.

property origin¶: Dimension origin point.

property radius¶: Dimension radius point.

property sweep¶: Dimension sweep point.

class maptek.vulcan.dim_arc¶

Bases: maptek.vulcan.dimension

Interface for Vulcan design dimension arcs.

property thisown¶: The membership flag

get_origin(dim_arc self) → point ¶: Gets the dimension origin.

set_origin(dim_arc self, point point)¶: Sets the dimension origin.

get_radius(dim_arc self) → point ¶: Gets the dimension radius.

set_radius(dim_arc self, point point)¶: Sets the dimension radius.

get_sweep(dim_arc self) → point ¶: Gets the dimension sweep.

set_sweep(dim_arc self, point point)¶: Sets the dimension sweep.

swap_points(dim_arc self)¶: Swaps the dimension points.

property origin¶: Dimension origin point.

property radius¶: Dimension radius point.

property sweep¶: Dimension sweep point.

class maptek.vulcan.dim_line¶

Bases: maptek.vulcan.dimension

Interface for Vulcan design dimension lines.

property thisown¶: The membership flag

get_start(dim_line self) → point ¶: Gets the dimension start.

set_start(dim_line self, point point)¶: Sets the dimension start.

get_end(dim_line self) → point ¶: Gets the dimension end.

set_end(dim_line self, point point)¶: Sets the dimension end.

midpoint(dim_line self) → point ¶: Gets the dimension midpoint.

get_normal(dim_line self) → point ¶: Gets the dimension normal.

set_normal(dim_line self, point point)¶: Sets the dimension normal.

swap_points(dim_line self)¶: Swaps the dimension points.

property start¶: Dimension start point.

property end¶: Dimension end point.

property normal¶: Dimension normal direction.

class maptek.vulcan.dim_radius¶

Bases: maptek.vulcan.dimension

Interface for Vulcan design dimension radii.

property thisown¶: The membership flag

get_start(dim_radius self) → point ¶: Gets the dimension start.

set_start(dim_radius self, point point)¶: Sets the dimension start.

get_end(dim_radius self) → point ¶: Gets the dimension end.

set_end(dim_radius self, point point)¶: Sets the dimension end.

get_normal(dim_radius self) → point ¶: Gets the dimension normal.

set_normal(dim_radius self, point point)¶: Sets the dimension normal.

swap_points(dim_radius self)¶: Swaps the dimension points.

property start¶: Dimension start point.

property end¶: Dimension end point.

property normal¶: Dimension normal direction.

class maptek.vulcan.swig_callback¶

Bases: object

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

property thisown¶: The membership flag

class maptek.vulcan.callback(func=None)¶

Bases: maptek.vulcan.swig_callback

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

Examples

>>> def my_func(*args, **kwargs):
>>>     return {"result" : "new data"}
>>> cb = Callback(my_func)

set_callback(self, func)¶: Sets a callback from a callable function.

class maptek.vulcan.attributes¶

Bases: object

Class for accessing object attribute data.

property thisown¶: The membership flag

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.

class maptek.vulcan.metadata¶

Bases: object

Class for manipulating object metadata.

property thisown¶: The membership flag

num_fields(metadata self) → int¶: Returns the number of metadata fields.

field_list(metadata self) → str_list ¶: Returns the list of metadata fields.

has_field(metadata self, std::string const & field) → bool¶: Returns true if a field exists in the metadata.

remove_field(metadata self, std::string const & field)¶: Removes a field.

get_value(metadata self, std::string const & field) → std::string¶: Gets a field value.

set_field(metadata self, std::string const & field, std::string const & value)¶: Sets a field value.

get_timestamp(metadata self, std::string const & field) → mtk::datetime::DateTime¶: Gets a timestamp of a field.

as_dict(metadata self) → MVariant¶: Gets the metadata as a dictionary.

from_dict(metadata self, MVariant & data)¶: Builds metadata from a dictionary.

class maptek.vulcan.section_widths¶

Bases: object

Controls section widths of an object

property thisown¶: The membership flag

set_cross_sections(section_widths self, bool enable=True)¶: Sets the use of cross sections.

get_cross_sections(section_widths self) → bool¶: Gets the cross section use value.

set_cross_points(section_widths self, bool enable=True)¶: Sets the usage of cross section points.

get_cross_points(section_widths self) → bool¶: Gets the cross section point usage.

enable_section_width(section_widths self, bool enable=True)¶: Enables section width use.

use_section_width(section_widths self) → bool¶: Gets the value of section width use.

set_front_width(section_widths self, double width)¶: Sets the section front width.

get_front_width(section_widths self) → double¶: Gets the section front width.

set_back_width(section_widths self, double width)¶: Sets the section back width.

get_back_width(section_widths self) → double¶: Gets the section back width.

property cross_sections¶: Section widths cross sections setting.

property cross_points¶: Section widths cross points setting.

property enable¶: Section widths section width setting.

property front_width¶: Section widths front width.

property back_width¶: Section widths back width.