pycsamt.map.volume

3-D map API for fence, block, and depth-slice views.

Functions

build_3d_map(data, options)	Build the concrete 3-D figure.
plot_3d_map(data, *[, options])	Build a 3-D map.
plot_volume_map(data, *[, options])	Build a 3-D volume map.

Classes

Map3D(data, *[, options])	Builder object for 3-D survey maps.
VolumeMap

class pycsamt.map.volume.Map3D(data, *, options=None, **ensure_kwargs)

Bases: object

Builder object for 3-D survey maps.

Parameters:

• data (Any)

• options (VolumeMapOptions | None)

• ensure_kwargs (Any)

with_mode(mode)

Return a copy with another 3-D mode.

Parameters:

mode (str)

Return type:

Map3D

with_options(**kwargs)

Return a copy with updated options.

Parameters:

kwargs (Any)

Return type:

Map3D

with_quantity(quantity)

Return a copy using another mapped quantity.

Parameters:

quantity (str)

Return type:

Map3D

with_component(component)

Return a copy using another component.

Parameters:

component (str)

Return type:

Map3D

figure()

Build and return the 3-D map figure.

Return type:

Any

pycsamt.map.volume.VolumeMap

alias of Map3D

pycsamt.map.volume.plot_3d_map(data, *, options=None, **kwargs)

Build a 3-D map.

Parameters:

• data (Any)

• options (VolumeMapOptions | None)

• kwargs (Any)

Return type:

Any

pycsamt.map.volume.plot_volume_map(data, *, options=None, **kwargs)

Build a 3-D volume map.

Parameters:

• data (Any)

• options (VolumeMapOptions | None)

• kwargs (Any)

Return type:

Any

pycsamt.map.volume.build_3d_map(data, options)

Build the concrete 3-D figure.

Parameters:

• data (MapData)

• options (VolumeMapOptions)

Return type:

Any