pycsamt.map.profile#

Profile-view and pseudosection API for pyCSAMT surveys.

Functions

`build_profile_map`(data, options)	Build the concrete profile-view figure.
`build_pseudosection`(data, options)	Build the concrete pseudosection figure.
`plot_profile_map`(data, *[, options])	Build a profile-view map.
`plot_pseudosection`(data, *[, options])	Build a resistivity or phase pseudosection.

Classes

ProfileMap(data, *[, options])

Builder object for profile maps.

class pycsamt.map.profile.ProfileMap(data, *, options=None, **ensure_kwargs)[source]#

Bases: object

Builder object for profile maps.

Parameters:

data (Any)
options (ProfileMapOptions | None)
ensure_kwargs (Any)

with_options(**kwargs)[source]#

Return a copy with updated options.

Parameters:: kwargs (Any)
Return type:: ProfileMap

with_quantity(quantity)[source]#

Return a copy using another mapped quantity.

Parameters:: quantity (str)
Return type:: ProfileMap

with_component(component)[source]#

Return a copy using one impedance component.

Parameters:: component (str)
Return type:: ProfileMap

with_components(*components)[source]#

Return a copy using multiple components.

Parameters:: components (str)
Return type:: ProfileMap

figure()[source]#

Build and return the profile figure.

Return type:: Any

pseudosection()[source]#

Build and return the pseudosection figure.

Return type:: Any

pycsamt.map.profile.plot_profile_map(data, *, options=None, **kwargs)[source]#

Build a profile-view map.

Parameters:

data (Any)
options (ProfileMapOptions | None)
kwargs (Any)

Return type:

Any

pycsamt.map.profile.plot_pseudosection(data, *, options=None, **kwargs)[source]#

Build a resistivity or phase pseudosection.

Parameters:

data (Any)
options (ProfileMapOptions | None)
kwargs (Any)

Return type:

Any

pycsamt.map.profile.build_profile_map(data, options)[source]#

Build the concrete profile-view figure.

Parameters:

data (MapData)
options (ProfileMapOptions)

Return type:

Any

pycsamt.map.profile.build_pseudosection(data, options)[source]#

Build the concrete pseudosection figure.

Parameters:

data (MapData)
options (ProfileMapOptions)

Return type:

Any