seisplotjs.quakeml 2.0.0-alpha.6

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.js

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.js

eventId

Type: string

▸ publicId

src/quakeml.js

publicId

Type: string

▸ _time

src/quakeml.js

_time

Type: moment

▸ latitude

src/quakeml.js

latitude

Type: number

▸ longitude

src/quakeml.js

longitude

Type: number

▸ depth

src/quakeml.js

depth

Type: number

▸ description

src/quakeml.js

description

Type: string

▸ magnitude

src/quakeml.js

magnitude

Type: Magnitude

▸ magnitudeList

src/quakeml.js

magnitudeList

Type: Array<Magnitude>

▸ originList

src/quakeml.js

originList

Type: Array<Origin>

▸ pickList

src/quakeml.js

pickList

Type: Array<Pick>

▸ preferredOriginId

src/quakeml.js

preferredOriginId

Type: string?

▸ preferredOrigin

src/quakeml.js

preferredOrigin

Type: Origin

▸ preferredMagnitudeId

src/quakeml.js

preferredMagnitudeId

Type: string?

▸ preferredMagnitude

src/quakeml.js

preferredMagnitude

Type: Magnitude

▸ time

src/quakeml.js

time

Type: moment

Returns

moment

▸ time

src/quakeml.js

time

Type: (moment | string)

Parameters

value ((moment | string))

▸ arrivals

src/quakeml.js

arrivals

Type: Array<Arrival>

Returns

Array<Arrival>

▸ picks

src/quakeml.js

picks

Type: Array<Pick>

Returns

Array<Pick>

▸ toString()

src/quakeml.js

toString()

Origin

src/quakeml.js

Represents a QuakeML Origin.

new Origin()

Static Members

▸ createFromXml(qml, allPicks)

src/quakeml.js

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.js

time

Type: moment

▸ latitude

src/quakeml.js

latitude

Type: number

▸ longitude

src/quakeml.js

longitude

Type: number

▸ depth

src/quakeml.js

depth

Type: number

▸ arrivalList

src/quakeml.js

arrivalList

Type: Array<Arrival>

▸ publicId

src/quakeml.js

publicId

Type: string

▸ toString()

src/quakeml.js

toString()

▸ arrivals

src/quakeml.js

arrivals

Type: Array<Arrival>

Returns

Array<Arrival>

Magnitude

src/quakeml.js

Represents a QuakeML Magnitude.

new Magnitude(mag: number, type: string)

Parameters

mag (number)

type (string)

Static Members

▸ createFromXml(qml)

src/quakeml.js

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.js

mag

Type: number

▸ type

src/quakeml.js

type

Type: string

▸ publicId

src/quakeml.js

publicId

Type: string

▸ toString()

src/quakeml.js

toString()

Arrival

src/quakeml.js

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.js

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.js

phase

Type: string

▸ pick

src/quakeml.js

pick

Type: Pick

▸ publicId

src/quakeml.js

publicId

Type: string

Pick

src/quakeml.js

Represents a QuakeML Pick.

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

Parameters

time (moment)

networkCode (string)

stationCode (string)

locationCode (string)

channelCode (string)

Static Members

▸ createFromXml(pickQML)

src/quakeml.js

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.js

time

Type: moment

▸ networkCode

src/quakeml.js

networkCode

Type: string

▸ stationCode

src/quakeml.js

stationCode

Type: string

▸ locationCode

src/quakeml.js

locationCode

Type: string

▸ channelCode

src/quakeml.js

channelCode

Type: string

▸ publicId

src/quakeml.js

publicId

Type: string

parseQuakeML

src/quakeml.js

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

parseUtil

src/quakeml.js

parseUtil

Static Members

▸ _grabFirstEl

src/quakeml.js

_grabFirstEl

▸ _grabFirstElNS

src/quakeml.js

_grabFirstElNS

▸ _grabFirstElText

src/quakeml.js

_grabFirstElText

▸ _grabFirstElFloat

src/quakeml.js

_grabFirstElFloat

▸ _grabFirstElInt

src/quakeml.js

_grabFirstElInt

▸ _grabAttribute

src/quakeml.js

_grabAttribute

▸ _grabAttributeNS

src/quakeml.js

_grabAttributeNS