2.5.1.4. pycsamt.metadata.channels#

Reusable electromagnetic channel and site-layout metadata.

Classes

ChannelMeta(name, field_type[, orientation, ...])

Describe one electric, magnetic, or auxiliary EM channel.

SiteLayout([input_channels, ...])

Original physical input/output channel geometry at a site.
class pycsamt.metadata.channels.ChannelMeta(name, field_type, orientation=None, tilt=None, x=None, y=None, z=None, x2=None, y2=None, z2=None, units=None, reference=None, sensor_id=None, extra=<factory>)[source]

Bases: PyCSAMTObject

Describe one electric, magnetic, or auxiliary EM channel.

Coordinates describe the physical site layout and are independent of the orientation applied to transfer-function matrices.

Parameters:
name: str
field_type: str
orientation: float | None = None
tilt: float | None = None
x: float | None = None
y: float | None = None
z: float | None = None
x2: float | None = None
y2: float | None = None
z2: float | None = None
units: str | None = None
reference: str | None = None
sensor_id: str | None = None
extra: dict[str, Any]
validate()[source]

Validate object state.

Subclasses can override this hook. The base implementation intentionally accepts all states.

Return type:

None

property is_electric: bool[source]
property is_magnetic: bool[source]
property has_second_endpoint: bool[source]
class pycsamt.metadata.channels.SiteLayout(input_channels=<factory>, output_channels=<factory>, input_units=None, output_units=None, input_reference=None, output_reference=None, extra=<factory>)[source]

Bases: PyCSAMTObject

Original physical input/output channel geometry at a site.

Parameters:
input_channels: list[ChannelMeta]
output_channels: list[ChannelMeta]
input_units: str | None = None
output_units: str | None = None
input_reference: str | None = None
output_reference: str | None = None
extra: dict[str, Any]
validate()[source]

Validate object state.

Subclasses can override this hook. The base implementation intentionally accepts all states.

Return type:

None

property input_names: tuple[str, ...][source]
property output_names: tuple[str, ...][source]
property n_input: int[source]
property n_output: int[source]
get_channel(name, *, role=None)[source]

Return a channel by name, optionally restricted by role.

Parameters:

  • name (str)

  • role (str | None)

Return type:

ChannelMeta | None