LocationBase
Description
LocationBase specifies parameters specific to a type of location.
Python class:
LocationBase
YAML / JSON label:
location_base
Corresponding StationXML structure
- None
Individual attributes in this class belong to the Station attributes.
Object Hierarchy
Superclass
None
Subclasses
None
Relationships
Is part of a Location
Attributes
Name |
Type |
Required |
Default |
Equivalent StationXML |
Remarks |
uncertainties |
dictionary of {lat: number, lon:number, elev: number} |
Y |
None |
Included in latitude, longitude and elevation (see Class Location) |
In meters. As uncertainties.m in YANL / JSON |
depth |
number |
Y |
None |
None |
In meters. As depth.m in YANL / JSON |
geology |
string |
Y |
None |
||
vault |
string |
Y |
None |
||
localisation_method |
string |
Y |
None |
None |
Added in Comment in StationXML |
JSON schema
Example
file: _templates/TEMPLATE.location_base.yaml
---
format_version: "1.0"
revision:
authors:
- {$ref: "persons/EXAMPLE.person.yaml"} # Reference to a file,
# or fields of a person element
date: "2024-09-30" # yyyy-mm-dd
location_base:
depth.m: 0 # Installation depth beneath the seafloor, for channel but not station
uncertainties.m: {lon: 200, lat: 200, elev: 20} # uncertainties in meters
# BEGIN OPTIONAL location_base elements
vault: "seafloor" # Type of vault
geology: "unknown" # Type of rock and/or geologic formation at the station
measurement_method: "Sea surface release point" # description of measurement method
water_level.m: 0 # Elevation of the water surface (0 for oceans)
notes: [""]
configuration_default: "SEA_SURFACE"
configurations:
"SEA_SURFACE":
configuration_description: "Standard sea-surface deployment"
"ACOUSTIC_SURVEY":
uncertainties.m: {lon: 5, lat: 5, elev: 10}
measurement_method: "Acoustic survey"
# END OPTIONAL location_base elements
# BEGIN OPTIONAL top-level elements
notes: [""]
# END OPTIONAL top-level elements