seisplotjs.quakeml 3.0.0-alpha.0

seisplotjs.quakeml

3.0.0-alpha.0

QML_NS
BED_NS
IRIS_NS
ANSS_NS
ANSS_CATALOG_NS
USGS_HOST
UNKNOWN_MAG_TYPE
UNKNOWN_PUBLIC_ID
FAKE_ORIGIN_TIME
Quake ▸
- Static members
- .createFromXml
- .extractEventId
- Instance members
- #eventId
- #publicId
- #description
- #magnitudeList
- #originList
- #pickList
- #preferredOriginId
- #_preferredOrigin
- #preferredMagnitudeId
- #_preferredMagnitude
- #preferredOrigin
- #origin
- #preferredMagnitude
- #magnitude
- #time
- #latitude
- #longitude
- #depth
- #depthKm
- #arrivals
- #picks
- #toString
Origin ▸
- Static members
- .createFromXml
- Instance members
- #time
- #latitude
- #longitude
- #depth
- #arrivalList
- #publicId
- #toString
- #arrivals
Magnitude ▸
- Static members
- .createFromXml
- Instance members
- #mag
- #type
- #publicId
- #toString
Arrival ▸
- Static members
- .createFromXml
- Instance members
- #phase
- #pick
- #publicId
Pick ▸
- Static members
- .createFromXml
- Instance members
- #time
- #networkCode
- #stationCode
- #locationCode
- #channelCode
- #publicId
- #isAtStation
- #isOnChannel
parseQuakeML
createQuakeFromValues
parseUtil ▸
- Static members
- ._grabFirstEl
- ._grabFirstElNS
- ._grabFirstElText
- ._grabFirstElFloat
- ._grabFirstElInt
- ._grabAttribute
- ._requireAttribute
- ._grabAttributeNS

Need help reading this?

QML_NS

src/quakeml.ts

QML_NS

Type: string

BED_NS

src/quakeml.ts

BED_NS

Type: string

IRIS_NS

src/quakeml.ts

IRIS_NS

Type: string

ANSS_NS

src/quakeml.ts

ANSS_NS

Type: string

ANSS_CATALOG_NS

src/quakeml.ts

ANSS_CATALOG_NS

Type: string

USGS_HOST

src/quakeml.ts

USGS_HOST

Type: string

UNKNOWN_MAG_TYPE

src/quakeml.ts

UNKNOWN_MAG_TYPE

Type: string

UNKNOWN_PUBLIC_ID

src/quakeml.ts

UNKNOWN_PUBLIC_ID

Type: string

FAKE_ORIGIN_TIME

src/quakeml.ts

FAKE_ORIGIN_TIME

Quake

src/quakeml.ts

Represent a QuakeML Event. Renamed to Quake as Event conflicts with other uses in javascript.

new Quake(publicId: string)

Parameters

publicId (string)

Static Members

▸ createFromXml(qml, host?)

src/quakeml.ts

Parses a QuakeML event xml element into a Quake object. Pass in host=seisplotjs.fdsnevent.USGS_HOST for xml from the USGS service in order to parse the eventid, otherwise this can be left out

createFromXml(qml: Element, host: string?): Quake

Parameters

qml (Element) the event xml Element

host (string?) optional source of the xml, helpful for parsing the eventid

Returns

Quake: QuakeML Quake(Event) object

▸ extractEventId(qml, host?)

src/quakeml.ts

Extracts the EventId from a QuakeML element, guessing from one of several incompatible (grumble grumble) formats.

extractEventId(qml: Element, host: string?): string

Parameters

qml (Element) Quake(Event) to extract from

host (string?) optional source of the xml to help determine the event id style

Returns

string: Extracted Id, or "unknownEventId" if we can't figure it out

Instance Members

▸ eventId

src/quakeml.ts

eventId

Type: (string | undefined)

▸ publicId

src/quakeml.ts

publicId

Type: string

▸ description

src/quakeml.ts

description

▸ magnitudeList

src/quakeml.ts

magnitudeList

▸ originList

src/quakeml.ts

originList

▸ pickList

src/quakeml.ts

pickList

▸ preferredOriginId

src/quakeml.ts

preferredOriginId

Type: (string | undefined)

▸ _preferredOrigin

src/quakeml.ts

_preferredOrigin

▸ preferredMagnitudeId

src/quakeml.ts

preferredMagnitudeId

Type: (string | undefined)

▸ _preferredMagnitude

src/quakeml.ts

_preferredMagnitude

▸ preferredOrigin

src/quakeml.ts

preferredOrigin

Type: Origin

Returns

Origin

▸ origin

src/quakeml.ts

origin

Type: Origin

Returns

Origin

▸ preferredMagnitude

src/quakeml.ts

preferredMagnitude

Type: Magnitude

Returns

Magnitude

▸ magnitude

src/quakeml.ts

magnitude

Type: Magnitude

Returns

Magnitude

▸ time

src/quakeml.ts

time

Type: DateTime

Returns

DateTime

▸ latitude

src/quakeml.ts

latitude

Type: number

Returns

number

▸ longitude

src/quakeml.ts

longitude

Type: number

Returns

number

▸ depth

src/quakeml.ts

depth

Type: number

Returns

number

▸ depthKm

src/quakeml.ts

depthKm

Type: number

Returns

number

▸ arrivals

src/quakeml.ts

arrivals

Type: Array<Arrival>

Returns

Array<Arrival>

▸ picks

src/quakeml.ts

picks

Type: Array<Pick>

Returns

Array<Pick>

▸ toString()

src/quakeml.ts

toString(): string

Returns

string

Origin

src/quakeml.ts

Represents a QuakeML Origin.

new Origin()

Static Members

▸ createFromXml(qml, allPicks)

src/quakeml.ts

Parses a QuakeML origin xml element into a Origin object.

createFromXml(qml: Element, allPicks: Array<Pick>): Origin

Parameters

qml (Element) the origin xml Element

allPicks (Array<Pick>) picks already extracted from the xml for linking arrivals with picks

Returns

Origin: Origin instance

Instance Members

▸ time

src/quakeml.ts

time

Type: DateTime

▸ latitude

src/quakeml.ts

latitude

Type: number

▸ longitude

src/quakeml.ts

longitude

Type: number

▸ depth

src/quakeml.ts

depth

Type: number

▸ arrivalList

src/quakeml.ts

arrivalList

Type: Array<Arrival>

▸ publicId

src/quakeml.ts

publicId

Type: string

▸ toString()

src/quakeml.ts

toString(): string

Returns

string

▸ arrivals

src/quakeml.ts

arrivals

Type: Array<Arrival>

Returns

Array<Arrival>

Magnitude

src/quakeml.ts

Represents a QuakeML Magnitude.

new Magnitude(mag: number, type: string)

Parameters

mag (number)

type (string)

Static Members

▸ createFromXml(qml)

src/quakeml.ts

Parses a QuakeML magnitude xml element into a Magnitude object.

createFromXml(qml: Element): Magnitude

Parameters

qml (Element) the magnitude xml Element

Returns

Magnitude: Magnitude instance

Instance Members

▸ mag

src/quakeml.ts

mag

Type: number

▸ type

src/quakeml.ts

type

Type: string

▸ publicId

src/quakeml.ts

publicId

Type: string

▸ toString()

src/quakeml.ts

toString(): string

Returns

string

Arrival

src/quakeml.ts

Represents a QuakeML Arrival, a combination of a Pick with a phase name.

new Arrival(phase: string, pick: Pick)

Parameters

phase (string)

pick (Pick)

Static Members

▸ createFromXml(arrivalQML, allPicks)

src/quakeml.ts

Parses a QuakeML arrival xml element into a Arrival object.

createFromXml(arrivalQML: Element, allPicks: Array<Pick>): Arrival

Parameters

arrivalQML (Element) the arrival xml Element

allPicks (Array<Pick>) picks already extracted from the xml for linking arrivals with picks

Returns

Arrival: Arrival instance

Instance Members

▸ phase

src/quakeml.ts

phase

Type: string

▸ pick

src/quakeml.ts

pick

Type: Pick

▸ publicId

src/quakeml.ts

publicId

Type: string

Pick

src/quakeml.ts

Represents a QuakeML Pick.

new Pick(time: DateTime, networkCode: string, stationCode: string, locationCode: string, channelCode: string)

Parameters

time (DateTime)

networkCode (string)

stationCode (string)

locationCode (string)

channelCode (string)

Static Members

▸ createFromXml(pickQML)

src/quakeml.ts

Parses a QuakeML pick xml element into a Pick object.

createFromXml(pickQML: Element): Pick

Parameters

pickQML (Element) the pick xml Element

Returns

Pick: Pick instance

Instance Members

▸ time

src/quakeml.ts

time

Type: DateTime

▸ networkCode

src/quakeml.ts

networkCode

Type: string

▸ stationCode

src/quakeml.ts

stationCode

Type: string

▸ locationCode

src/quakeml.ts

locationCode

Type: string

▸ channelCode

src/quakeml.ts

channelCode

Type: string

▸ publicId

src/quakeml.ts

publicId

Type: string

▸ isAtStation(station)

src/quakeml.ts

isAtStation(station: Station): boolean

Parameters

station (Station)

Returns

boolean

▸ isOnChannel(channel)

src/quakeml.ts

isOnChannel(channel: Channel): boolean

Parameters

channel (Channel)

Returns

boolean

parseQuakeML

src/quakeml.ts

Parses a QuakeML xml document into seisplotjs objects

parseQuakeML(rawXml: Document, host: string?): Array<Quake>

Parameters

rawXml (Document) the xml Document to parse

host (string?) optional source of the xml, helpful for parsing the eventid

Returns

Array<Quake>: array of Quake objects

createQuakeFromValues

src/quakeml.ts

createQuakeFromValues(publicId: string, time: DateTime, latitude: number, longitude: number, depth: number): Quake

Parameters

publicId (string)

time (DateTime)

latitude (number)

longitude (number)

depth (number)

Returns

Quake

parseUtil

src/quakeml.ts

parseUtil

Static Members

▸ _grabFirstEl

src/quakeml.ts

_grabFirstEl

▸ _grabFirstElNS

src/quakeml.ts

_grabFirstElNS

▸ _grabFirstElText

src/quakeml.ts

_grabFirstElText

▸ _grabFirstElFloat

src/quakeml.ts

_grabFirstElFloat

▸ _grabFirstElInt

src/quakeml.ts

_grabFirstElInt

▸ _grabAttribute

src/quakeml.ts

_grabAttribute

▸ _requireAttribute

src/quakeml.ts

_requireAttribute

▸ _grabAttributeNS

src/quakeml.ts

_grabAttributeNS