2.5.1.1. pycsamt.metadata.site

Site-level metadata for electromagnetic transfer functions.

Classes

LocationMeta([latitude, longitude, ...])	Geographic location and optional magnetic declination metadata.
SiteMeta([project, survey, year_collected, ...])	Site identity, acquisition interval, and geographic location.

class pycsamt.metadata.site.LocationMeta(latitude=None, longitude=None, elevation=None, datum='WGS84', elevation_units='meters', declination=None, declination_epoch=None, extra=<factory>)

Bases: PyCSAMTObject

Geographic location and optional magnetic declination metadata.

Parameters:

• latitude (float | None)

• longitude (float | None)

• elevation (float | None)

• datum (str | None)

• elevation_units (str)

• declination (float | None)

• declination_epoch (float | None)

• extra (dict[str, Any])

latitude: float | None = None

longitude: float | None = None

elevation: float | None = None

datum: str | None = 'WGS84'

elevation_units: str = 'meters'

declination: float | None = None

declination_epoch: float | None = None

extra: dict[str, Any]

validate()

Validate object state.

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

Return type:

None

property has_horizontal_coordinates: bool

class pycsamt.metadata.site.SiteMeta(project=None, survey=None, year_collected=None, country=None, site_id=None, name=None, location=None, acquired_by=None, start=None, end=None, extra=<factory>)

Bases: PyCSAMTObject

Site identity, acquisition interval, and geographic location.

Parameters:

• project (str | None)

• survey (str | None)

• year_collected (int | None)

• country (str | None)

• site_id (str | int | None)

• name (str | None)

• location (LocationMeta | None)

• acquired_by (str | None)

• start (datetime | str | None)

• end (datetime | str | None)

• extra (dict[str, Any])

project: str | None = None

survey: str | None = None

year_collected: int | None = None

country: str | None = None

site_id: str | int | None = None

name: str | None = None

location: LocationMeta | None = None

acquired_by: str | None = None

start: datetime | str | None = None

end: datetime | str | None = None

extra: dict[str, Any]

validate()

Validate object state.

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

Return type:

None

property preferred_name: str | None

Return human site name, falling back to the site identifier.