seisplotjs 3.1.3 | Documentation

seisplotjs

3.1.3

IRIS_HOST
TEXT_FORMAT
JSON_FORMAT
SVG_FORMAT
TraveltimeJsonType
TraveltimeArrivalType
isValidTraveltimeJsonType
isValidTraveltimeArrivalType
convertTravelTimeLineToObject
createOriginArrival
TraveltimeQuery ▸
- Instance members
- #protocol
- #getProtocol
- #host
- #getHost
- #port
- #getPort
- #nodata
- #getNodata
- #specVersion
- #getSpecVersion
- #evdepth
- #evdepthInMeter
- #getEvdepth
- #distdeg
- #getDistdeg
- #model
- #getModel
- #phases
- #getPhases
- #stalat
- #getStalat
- #stalon
- #getStalon
- #latLonFromStation
- #receiverdepth
- #receiverdepthInMeter
- #receiverdepthFromChannel
- #getReceiverdepth
- #evlat
- #getEvlat
- #evlon
- #getEvlon
- #latLonFromQuake
- #format
- #getFormat
- #noheader
- #getNoheader
- #timeout
- #getTimeout
- #queryText
- #queryJson
- #querySvg
- #queryWadl
- #query
- #formBaseURL
- #formURL
- #queryTauPVersion
- #formTauPVersionURL
- #formWadlURL
FAKE_EMPTY_TEXT_MODEL
FAKE_EMPTY_TEXT_HEADERS
createEmptyTraveltimeJson
FAKE_EMPTY_SVG

Need help reading this?

IRIS_HOST

src/traveltime.ts

IRIS_HOST

Type: string

TEXT_FORMAT

src/traveltime.ts

TEXT_FORMAT

Type: string

JSON_FORMAT

src/traveltime.ts

JSON_FORMAT

Type: string

SVG_FORMAT

src/traveltime.ts

SVG_FORMAT

Type: string

TraveltimeJsonType

src/traveltime.ts

Type for json returned by iris traveltime web service

TraveltimeJsonType

Type: {model: string, sourcedepth: number, receiverdepth: number, phases: Array<string>, arrivals: Array<TraveltimeArrivalType>}

Properties

model (string)

sourcedepth (number)

receiverdepth (number)

phases (Array<string>)

arrivals (Array<TraveltimeArrivalType>)

TraveltimeArrivalType

src/traveltime.ts

TraveltimeArrivalType

Type: {distdeg: number, phase: string, time: number, rayparam: number, takeoff: number, incident: number, puristdist: number, puristname: string}

Properties

distdeg (number)

phase (string)

time (number)

rayparam (number)

takeoff (number)

incident (number)

puristdist (number)

puristname (string)

isValidTraveltimeJsonType

src/traveltime.ts

Verifies that JSON matches the types we expect, for typescript.

isValidTraveltimeJsonType(v: any): any

Parameters

v (any) JSON object, usually from the traveltime web service

Returns

any: true if matches expected structure

isValidTraveltimeArrivalType

src/traveltime.ts

isValidTraveltimeArrivalType(v: any): any

Parameters

v (any)

Returns

any

convertTravelTimeLineToObject

src/traveltime.ts

converts a text line from the text format into an TraveltimeArrivalType object like what is returned by the json format.

convertTravelTimeLineToObject(ttimeline: string): TraveltimeArrivalType

Parameters

ttimeline (string) travel time output line for an arrival

Returns

TraveltimeArrivalType: parsed travel time arrival

createOriginArrival

src/traveltime.ts

Creates a fake arrival for the origin time, useful to display a flag at origin time similar to the P and S arrival.

createOriginArrival(distdeg: number): TraveltimeArrivalType

Parameters

distdeg (number) earthquake to station distance, in degrees

Returns

TraveltimeArrivalType: an arrival for the origin

TraveltimeQuery

src/traveltime.ts

Query to the IRIS traveltime webservice, based on the TauP Toolkit. See https://service.iris.edu/irisws/traveltime/1/ and https://www.seis.sc.edu/TauP/

new TraveltimeQuery(host: (string | null)?)

Extends FDSNCommon

Parameters

host ((string | null)?) optional host to connect to, defaults to IRIS

Instance Members

▸ protocol(value?)

src/traveltime.ts

protocol(value: string?): TraveltimeQuery

Parameters

value (string?)

Returns

TraveltimeQuery

▸ getProtocol()

src/traveltime.ts

getProtocol(): (string | undefined)

Returns

(string | undefined)

▸ host(value?)

src/traveltime.ts

host(value: string?): TraveltimeQuery

Parameters

value (string?)

Returns

TraveltimeQuery

▸ getHost()

src/traveltime.ts

getHost(): string

Returns

string

▸ port(value?)

src/traveltime.ts

Gets/Sets the remote port to connect to.

port(value: number?): TraveltimeQuery

Parameters

value (number?) optional new value if setting

Returns

TraveltimeQuery: new value if getting, this if setting

▸ getPort()

src/traveltime.ts

getPort(): (number | undefined)

Returns

(number | undefined)

▸ nodata(value?)

src/traveltime.ts

Gets/Sets the nodata parameter, usually 404 or 204 (default), controlling the status code when no matching data is found by the service.

nodata(value: number?): TraveltimeQuery

Parameters

value (number?) optional new value if setting

Returns

TraveltimeQuery: new value if getting, this if setting

▸ getNodata()

src/traveltime.ts

getNodata(): (number | undefined)

Returns

(number | undefined)

▸ specVersion(value?)

src/traveltime.ts

specVersion(value: string?): TraveltimeQuery

Parameters

value (string?)

Returns

TraveltimeQuery

▸ getSpecVersion()

src/traveltime.ts

getSpecVersion(): (string | undefined)

Returns

(string | undefined)

▸ evdepth(value?)

src/traveltime.ts

evdepth(value: number?): TraveltimeQuery

Parameters

value (number?)

Returns

TraveltimeQuery

▸ evdepthInMeter(value?)

src/traveltime.ts

evdepthInMeter(value: number?): TraveltimeQuery

Parameters

value (number?)

Returns

TraveltimeQuery

▸ getEvdepth()

src/traveltime.ts

getEvdepth(): (number | undefined)

Returns

(number | undefined)

▸ distdeg(value?)

src/traveltime.ts

distdeg(value: (number | Array<number>)?): TraveltimeQuery

Parameters

value ((number | Array<number>)?)

Returns

TraveltimeQuery

▸ getDistdeg()

src/traveltime.ts

getDistdeg(): (Array<number> | undefined)

Returns

(Array<number> | undefined)

▸ model(value?)

src/traveltime.ts

model(value: string?): TraveltimeQuery

Parameters

value (string?)

Returns

TraveltimeQuery

▸ getModel()

src/traveltime.ts

getModel(): (string | undefined)

Returns

(string | undefined)

▸ phases(value?)

src/traveltime.ts

phases(value: string?): TraveltimeQuery

Parameters

value (string?)

Returns

TraveltimeQuery

▸ getPhases()

src/traveltime.ts

getPhases(): (string | undefined)

Returns

(string | undefined)

▸ stalat(value?)

src/traveltime.ts

stalat(value: number?): TraveltimeQuery

Parameters

value (number?)

Returns

TraveltimeQuery

▸ getStalat()

src/traveltime.ts

getStalat(): (number | undefined)

Returns

(number | undefined)

▸ stalon(value?)

src/traveltime.ts

stalon(value: number?): TraveltimeQuery

Parameters

value (number?)

Returns

TraveltimeQuery

▸ getStalon()

src/traveltime.ts

getStalon(): (number | undefined)

Returns

(number | undefined)

▸ latLonFromStation(station)

src/traveltime.ts

latLonFromStation(station: Station): TraveltimeQuery

Parameters

station (Station)

Returns

TraveltimeQuery

▸ receiverdepth(value?)

src/traveltime.ts

receiverdepth(value: number?): TraveltimeQuery

Parameters

value (number?)

Returns

TraveltimeQuery

▸ receiverdepthInMeter(value?)

src/traveltime.ts

receiverdepthInMeter(value: number?): TraveltimeQuery

Parameters

value (number?)

Returns

TraveltimeQuery

▸ receiverdepthFromChannel(channel)

src/traveltime.ts

receiverdepthFromChannel(channel: Channel): TraveltimeQuery

Parameters

channel (Channel)

Returns

TraveltimeQuery

▸ getReceiverdepth()

src/traveltime.ts

getReceiverdepth(): (number | undefined)

Returns

(number | undefined)

▸ evlat(value?)

src/traveltime.ts

evlat(value: number?): TraveltimeQuery

Parameters

value (number?)

Returns

TraveltimeQuery

▸ getEvlat()

src/traveltime.ts

getEvlat(): (number | undefined)

Returns

(number | undefined)

▸ evlon(value?)

src/traveltime.ts

evlon(value: number?): TraveltimeQuery

Parameters

value (number?)

Returns

TraveltimeQuery

▸ getEvlon()

src/traveltime.ts

getEvlon(): (number | undefined)

Returns

(number | undefined)

▸ latLonFromQuake(quake)

src/traveltime.ts

latLonFromQuake(quake: Quake): TraveltimeQuery

Parameters

quake (Quake)

Returns

TraveltimeQuery

▸ format(value?)

src/traveltime.ts

format(value: string?): TraveltimeQuery

Parameters

value (string?)

Returns

TraveltimeQuery

▸ getFormat()

src/traveltime.ts

getFormat(): (string | undefined)

Returns

(string | undefined)

▸ noheader(value?)

src/traveltime.ts

noheader(value: boolean?): TraveltimeQuery

Parameters

value (boolean?)

Returns

TraveltimeQuery

▸ getNoheader()

src/traveltime.ts

getNoheader(): (boolean | undefined)

Returns

(boolean | undefined)

▸ timeout(value?)

src/traveltime.ts

Get/Set the timeout in seconds for the request. Default is 30.

timeout(value: number?): TraveltimeQuery

Parameters

value (number?) optional new value if setting

Returns

TraveltimeQuery: new value if getting, this if setting

▸ getTimeout()

src/traveltime.ts

getTimeout(): (number | undefined)

Returns

(number | undefined)

▸ queryText()

src/traveltime.ts

queryText(): Promise<string>

Returns

Promise<string>

▸ queryJson()

src/traveltime.ts

queryJson(): Promise<TraveltimeJsonType>

Returns

Promise<TraveltimeJsonType>

▸ querySvg()

src/traveltime.ts

querySvg(): Promise<Element>

Returns

Promise<Element>

▸ queryWadl()

src/traveltime.ts

queryWadl(): Promise<Document>

Returns

Promise<Document>

▸ query()

src/traveltime.ts

query(): Promise<(TraveltimeJsonType | Element | string)>

Returns

Promise<(TraveltimeJsonType | Element | string)>

▸ formBaseURL()

src/traveltime.ts

formBaseURL(): string

Returns

string

▸ formURL()

src/traveltime.ts

formURL(): string

Returns

string

▸ queryTauPVersion()

src/traveltime.ts

queryTauPVersion(): Promise<string>

Returns

Promise<string>

▸ formTauPVersionURL()

src/traveltime.ts

formTauPVersionURL(): string

Returns

string

▸ formWadlURL()

src/traveltime.ts

formWadlURL(): string

Returns

string

FAKE_EMPTY_TEXT_MODEL

src/traveltime.ts

FAKE_EMPTY_TEXT_MODEL

FAKE_EMPTY_TEXT_HEADERS

src/traveltime.ts

FAKE_EMPTY_TEXT_HEADERS

createEmptyTraveltimeJson

src/traveltime.ts

createEmptyTraveltimeJson(ttquery: TraveltimeQuery): TraveltimeJsonType

Parameters

ttquery (TraveltimeQuery)

Returns

TraveltimeJsonType

FAKE_EMPTY_SVG

src/traveltime.ts

FAKE_EMPTY_SVG