seisplotjs 3.1.4 | Documentation

seisplotjs

3.1.4

SeismogramLoader ▸
- Instance members
- #stationQuery
- #withFedCatalog
- #withResponse
- #markOrigin
- #eventQuery
- #dataselectQuery
- #_startPhaseList
- #_endPhaseList
- #_markedPhaseList
- #_startOffset
- #_endOffset
- #startPhaseList
- #startPhaseList
- #startOffset
- #startOffset
- #startOffsetSeconds
- #endPhaseList
- #endPhaseList
- #endOffset
- #endOffset
- #endOffsetSeconds
- #markedPhaseList
- #markedPhaseList
- #loadSeismograms
- #load

Need help reading this?

SeismogramLoader

src/seismogramloader.ts

Loads seismograms based on queries to Station and Event web services. Uses the traveltime web service to create times for data query. Default is P-30 sec to S+60 sec.

new SeismogramLoader(stationQuery: (StationQuery | Array<Network>), eventQuery: (EventQuery | Array<Quake>), dataselectQuery: DataSelectQuery?)

Parameters

stationQuery ((StationQuery | Array<Network>)) query to find channels

eventQuery ((EventQuery | Array<Quake>)) query to find events

dataselectQuery (DataSelectQuery?) optional additional parameters for seismogram query

Instance Members

▸ stationQuery

src/seismogramloader.ts

stationQuery

Type: (StationQuery | Promise<Array<Network>>)

▸ withFedCatalog

src/seismogramloader.ts

withFedCatalog

▸ withResponse

src/seismogramloader.ts

withResponse

▸ markOrigin

src/seismogramloader.ts

markOrigin

▸ eventQuery

src/seismogramloader.ts

eventQuery

Type: (EventQuery | Promise<Array<Quake>>)

▸ dataselectQuery

src/seismogramloader.ts

dataselectQuery

Type: (null | DataSelectQuery)

▸ _startPhaseList

src/seismogramloader.ts

_startPhaseList

Type: Array<string>

▸ _endPhaseList

src/seismogramloader.ts

_endPhaseList

Type: Array<string>

▸ _markedPhaseList

src/seismogramloader.ts

_markedPhaseList

Type: Array<string>

▸ _startOffset

src/seismogramloader.ts

_startOffset

Type: Duration

▸ _endOffset

src/seismogramloader.ts

_endOffset

Type: Duration

▸ startPhaseList

src/seismogramloader.ts

startPhaseList

Type: Array<string>

Returns

Array<string>

▸ startPhaseList

src/seismogramloader.ts

startPhaseList

Type: (Array<string> | string)

Parameters

val ((Array<string> | string))

▸ startOffset

src/seismogramloader.ts

startOffset

Type: Duration

Returns

Duration

▸ startOffset

src/seismogramloader.ts

startOffset

Type: Duration

Parameters

val (Duration)

▸ startOffsetSeconds(val)

src/seismogramloader.ts

Sets the startOffset Duration to be val seconds.

startOffsetSeconds(val: number): SeismogramLoader

Parameters

val (number) number of seconds, negative for before, positive for after

Returns

SeismogramLoader: this

▸ endPhaseList

src/seismogramloader.ts

endPhaseList

Type: Array<string>

Returns

Array<string>

▸ endPhaseList

src/seismogramloader.ts

endPhaseList

Type: (Array<string> | string)

Parameters

val ((Array<string> | string))

▸ endOffset

src/seismogramloader.ts

endOffset

Type: Duration

Returns

Duration

▸ endOffset

src/seismogramloader.ts

endOffset

Type: Duration

Parameters

val (Duration)

▸ endOffsetSeconds(val)

src/seismogramloader.ts

Sets the endOffset Duration to be val seconds.

endOffsetSeconds(val: number): SeismogramLoader

Parameters

val (number) number of seconds, negative for before, positive for after

Returns

SeismogramLoader: this

▸ markedPhaseList

src/seismogramloader.ts

Additional phase arrival travel times to be marked, but do not effect the request time window.

markedPhaseList

Type: Array<string>

Returns

Array<string>: array of phase names.

▸ markedPhaseList

src/seismogramloader.ts

markedPhaseList

Type: (Array<string> | string)

Parameters

val ((Array<string> | string))

▸ loadSeismograms()

src/seismogramloader.ts

loadSeismograms(): Promise<Array<SeismogramDisplayData>>

Returns

Promise<Array<SeismogramDisplayData>>

▸ load()

src/seismogramloader.ts

Loads a Dataset based on the input station and event queries.

The raw traveltimes are included in the extras of the dataset with key "traveltimes", which is a Map with the quake as the key.

load(): Promise<Dataset>

Returns

Promise<Dataset>: a Dataset