pycsamt.map.station

2-D station-map API for pyCSAMT surveys.

Functions

build_station_map(data[, options])	Build a Plotly 2-D station map.
plot_station_map(data, *[, options])	Build a 2-D station map.

Classes

StationMap(data, *[, options])

Builder object for station-map figures.

class pycsamt.map.station.StationMap(data, *, options=None, **ensure_kwargs)

Bases: object

Builder object for station-map figures.

Parameters:

• data (Any)

• options (StationMapOptions | None)

• ensure_kwargs (Any)

with_overlay(overlay, **kwargs)

Return a copy with a different overlay.

Parameters:

• overlay (str)

• kwargs (Any)

Return type:

StationMap

with_options(**kwargs)

Return a copy with updated options.

Parameters:

kwargs (Any)

Return type:

StationMap

figure()

Build and return the station-map figure.

Return type:

Any

pycsamt.map.station.plot_station_map(data, *, options=None, **kwargs)

Build a 2-D station map.

Parameters:

• data (Any)

• options (StationMapOptions | None)

• kwargs (Any)

Return type:

Any

pycsamt.map.station.build_station_map(data, options=None)

Build a Plotly 2-D station map.

Parameters:

• data (MapData)

• options (StationMapOptions | None)

Return type:

Any