2.5.1.5. pycsamt.metadata.orientation#

Transfer-function orientation metadata independent of file format.

Classes

OrientationMeta([mode, ...])

Describe the coordinate orientation of transfer-function data.
class pycsamt.metadata.orientation.OrientationMeta(mode=None, angle_to_geographic_north=None, rotation_info=None, extra=<factory>)[source]

Bases: PyCSAMTObject

Describe the coordinate orientation of transfer-function data.

OrientationMeta describes the orientation of the data, not the physical sensor geometry. Physical channel geometry is retained by SiteLayout so rotations remain reversible where sufficient information is available.

Parameters:

  • mode ({"orthogonal", "sitelayout"}, optional) – "orthogonal" means the TF matrix is expressed in an orthogonal coordinate frame. "sitelayout" means the TF follows the original site channel layout.

  • angle_to_geographic_north (float, optional) – Clockwise angle in degrees of the orthogonal x-axis relative to geographic north. It is intentionally not fabricated when unknown.

  • rotation_info (str, optional) – Human-readable record of known rotation history or ambiguity.

  • extra (dict) – Additional orientation metadata.

mode: str | None = None
angle_to_geographic_north: float | None = None
rotation_info: 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_orthogonal: bool[source]

Return whether the data are in an orthogonal coordinate frame.

property follows_site_layout: bool[source]

Return whether data orientation follows the sensor layout.