2.30.7.7. pycsamt.map.volume#

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

Functions

apply_vertical_exaggeration(fig[, ve, max_ratio])

Stretch the scene's vertical axis by ve (0 = automatic).

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)[source]

Bases: object

Builder object for 3-D survey maps.

Parameters:
with_mode(mode)[source]

Return a copy with another 3-D mode.

Parameters:

mode (str)

Return type:

Map3D

with_options(**kwargs)[source]

Return a copy with updated options.

Parameters:

kwargs (Any)

Return type:

Map3D

with_quantity(quantity)[source]

Return a copy using another mapped quantity.

Parameters:

quantity (str)

Return type:

Map3D

with_component(component)[source]

Return a copy using another component.

Parameters:

component (str)

Return type:

Map3D

figure()[source]

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)[source]

Build a 3-D map.

Parameters:
Return type:

Any

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

Build a 3-D volume map.

Parameters:
Return type:

Any

pycsamt.map.volume.build_3d_map(data, options)[source]

Build the concrete 3-D figure.

Parameters:
Return type:

Any

pycsamt.map.volume.apply_vertical_exaggeration(fig, ve=0.0, *, max_ratio=3.0)[source]

Stretch the scene’s vertical axis by ve (0 = automatic).

Sets aspectmode="manual" with an aspect ratio from the data extents of every trace, so x and y stay true to each other and z is exaggerated (capped at max_ratio times the horizontal size). Automatic makes the depth about half the horizontal extent (1-50x). Returns the factor used (1.0 when the scene has no 3-D extent).

Parameters:
Return type:

float