seisplotjs 3.2.0 | Documentation

seisplotjs

3.2.0

USC_HOST
TEXT_FORMAT
JSON_FORMAT
SVG_FORMAT
TAUP_SERVICE
TAUP_TIME_TOOL
TAUP_PATH_TOOL
TauP3TimeJsonType
TraveltimeAmpSourceType
TraveltimeArrivalType
TraveltimeAmplitudeType
isValidTauP3TimeJsonType
isValidTraveltimeArrivalType
createOriginArrival
TauPQuery ▸
- Instance members
- #protocol
- #getProtocol
- #host
- #getHost
- #port
- #getPort
- #pathBase
- #getPathBase
- #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?

USC_HOST

src/taup3.ts

USC_HOST

Type: string

TEXT_FORMAT

src/taup3.ts

TEXT_FORMAT

Type: string

JSON_FORMAT

src/taup3.ts

JSON_FORMAT

Type: string

SVG_FORMAT

src/taup3.ts

SVG_FORMAT

Type: string

TAUP_SERVICE

src/taup3.ts

const for service name

TAUP_SERVICE

Type: string

TAUP_TIME_TOOL

src/taup3.ts

TAUP_TIME_TOOL

Type: string

TAUP_PATH_TOOL

src/taup3.ts

TAUP_PATH_TOOL

Type: string

TauP3TimeJsonType

src/taup3.ts

Type for json returned by iris traveltime web service

TauP3TimeJsonType

Type: {model: string, sourcedepthlist: Array<number>, receiverdepthlist: Array<number>, phases: Array<string>, source: TraveltimeAmpSourceType?, arrivals: Array<TraveltimeArrivalType>}

Properties

model (string)

sourcedepthlist (Array<number>)

receiverdepthlist (Array<number>)

phases (Array<string>)

source (TraveltimeAmpSourceType?)

arrivals (Array<TraveltimeArrivalType>)

TraveltimeAmpSourceType

src/taup3.ts

TraveltimeAmpSourceType

Type: {withAmplitude: boolean, mw: number, attenuationFreq: number, numFrequencies: number, strikeDipRake: Array<number>?}

Properties

withAmplitude (boolean)

mw (number)

attenuationFreq (number)

numFrequencies (number)

strikeDipRake (Array<number>?)

TraveltimeArrivalType

src/taup3.ts

TraveltimeArrivalType

Type: {sourcedepth: number, receiverdepth: number, distdeg: number, phase: string, time: number, rayparam: number, takeoff: number, incident: number, puristdist: number, puristname: string, amp: TraveltimeAmplitudeType?}

Properties

sourcedepth (number)

receiverdepth (number)

distdeg (number)

phase (string)

time (number)

rayparam (number)

takeoff (number)

incident (number)

puristdist (number)

puristname (string)

amp (TraveltimeAmplitudeType?)

TraveltimeAmplitudeType

src/taup3.ts

TraveltimeAmplitudeType

Type: {factorpsv: number, factorsh: number, geospread: number, attenuation: number, freeFactor: number, radiationPattern: Array<number>, radiationTerm: number, mgtokg: number, refltranpsv: number, refltransh: number, source: {Mw: number, attenuationfreq: number}}

Properties

factorpsv (number)

factorsh (number)

geospread (number)

attenuation (number)

freeFactor (number)

radiationPattern (Array<number>)

radiationTerm (number)

mgtokg (number)

refltranpsv (number)

refltransh (number)

source ({Mw: number, attenuationfreq: number})

isValidTauP3TimeJsonType

src/taup3.ts

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

isValidTauP3TimeJsonType(v: any): any

Parameters

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

Returns

any: true if matches expected structure

isValidTraveltimeArrivalType

src/taup3.ts

isValidTraveltimeArrivalType(v: any): any

Parameters

v (any)

Returns

any

createOriginArrival

src/taup3.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

TauPQuery

src/taup3.ts

Query to a TauP v3 webservice, based on the TauP Toolkit. See https://taup.readthedocs.io/en/latest/ and https://www.seis.sc.edu/TauP/

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

Extends FDSNCommon

Parameters

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

Instance Members

▸ protocol(value?)

src/taup3.ts

protocol(value: string?): TauPQuery

Parameters

value (string?)

Returns

TauPQuery

▸ getProtocol()

src/taup3.ts

getProtocol(): (string | undefined)

Returns

(string | undefined)

▸ host(value?)

src/taup3.ts

host(value: string?): TauPQuery

Parameters

value (string?)

Returns

TauPQuery

▸ getHost()

src/taup3.ts

getHost(): string

Returns

string

▸ port(value?)

src/taup3.ts

Gets/Sets the remote port to connect to.

port(value: number?): TauPQuery

Parameters

value (number?) optional new value if setting

Returns

TauPQuery: new value if getting, this if setting

▸ getPort()

src/taup3.ts

getPort(): (number | undefined)

Returns

(number | undefined)

▸ pathBase(value?)

src/taup3.ts

pathBase(value: string?): TauPQuery

Parameters

value (string?)

Returns

TauPQuery

▸ getPathBase()

src/taup3.ts

getPathBase(): string

Returns

string

▸ nodata(value?)

src/taup3.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?): TauPQuery

Parameters

value (number?) optional new value if setting

Returns

TauPQuery: new value if getting, this if setting

▸ getNodata()

src/taup3.ts

getNodata(): (number | undefined)

Returns

(number | undefined)

▸ specVersion(value?)

src/taup3.ts

specVersion(value: string?): TauPQuery

Parameters

value (string?)

Returns

TauPQuery

▸ getSpecVersion()

src/taup3.ts

getSpecVersion(): (string | undefined)

Returns

(string | undefined)

▸ evdepth(value?)

src/taup3.ts

evdepth(value: (number | Array<number>)?): TauPQuery

Parameters

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

Returns

TauPQuery

▸ evdepthInMeter(value?)

src/taup3.ts

evdepthInMeter(value: (number | Array<number>)?): TauPQuery

Parameters

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

Returns

TauPQuery

▸ getEvdepth()

src/taup3.ts

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

Returns

(Array<number> | undefined)

▸ distdeg(value?)

src/taup3.ts

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

Parameters

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

Returns

TauPQuery

▸ getDistdeg()

src/taup3.ts

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

Returns

(Array<number> | undefined)

▸ model(value?)

src/taup3.ts

model(value: string?): TauPQuery

Parameters

value (string?)

Returns

TauPQuery

▸ getModel()

src/taup3.ts

getModel(): (string | undefined)

Returns

(string | undefined)

▸ phases(value?)

src/taup3.ts

phases(value: string?): TauPQuery

Parameters

value (string?)

Returns

TauPQuery

▸ getPhases()

src/taup3.ts

getPhases(): (string | undefined)

Returns

(string | undefined)

▸ stalat(value?)

src/taup3.ts

stalat(value: number?): TauPQuery

Parameters

value (number?)

Returns

TauPQuery

▸ getStalat()

src/taup3.ts

getStalat(): (number | undefined)

Returns

(number | undefined)

▸ stalon(value?)

src/taup3.ts

stalon(value: number?): TauPQuery

Parameters

value (number?)

Returns

TauPQuery

▸ getStalon()

src/taup3.ts

getStalon(): (number | undefined)

Returns

(number | undefined)

▸ latLonFromStation(station)

src/taup3.ts

latLonFromStation(station: Station): TauPQuery

Parameters

station (Station)

Returns

TauPQuery

▸ receiverdepth(value?)

src/taup3.ts

receiverdepth(value: number?): TauPQuery

Parameters

value (number?)

Returns

TauPQuery

▸ receiverdepthInMeter(value?)

src/taup3.ts

receiverdepthInMeter(value: number?): TauPQuery

Parameters

value (number?)

Returns

TauPQuery

▸ receiverdepthFromChannel(channel)

src/taup3.ts

receiverdepthFromChannel(channel: Channel): TauPQuery

Parameters

channel (Channel)

Returns

TauPQuery

▸ getReceiverdepth()

src/taup3.ts

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

Returns

(Array<number> | undefined)

▸ evlat(value?)

src/taup3.ts

evlat(value: number?): TauPQuery

Parameters

value (number?)

Returns

TauPQuery

▸ getEvlat()

src/taup3.ts

getEvlat(): (number | undefined)

Returns

(number | undefined)

▸ evlon(value?)

src/taup3.ts

evlon(value: number?): TauPQuery

Parameters

value (number?)

Returns

TauPQuery

▸ getEvlon()

src/taup3.ts

getEvlon(): (number | undefined)

Returns

(number | undefined)

▸ latLonFromQuake(quake)

src/taup3.ts

latLonFromQuake(quake: Quake): TauPQuery

Parameters

quake (Quake)

Returns

TauPQuery

▸ format(value?)

src/taup3.ts

format(value: string?): TauPQuery

Parameters

value (string?)

Returns

TauPQuery

▸ getFormat()

src/taup3.ts

getFormat(): (string | undefined)

Returns

(string | undefined)

▸ noheader(value?)

src/taup3.ts

noheader(value: boolean?): TauPQuery

Parameters

value (boolean?)

Returns

TauPQuery

▸ getNoheader()

src/taup3.ts

getNoheader(): (boolean | undefined)

Returns

(boolean | undefined)

▸ timeout(value?)

src/taup3.ts

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

timeout(value: number?): TauPQuery

Parameters

value (number?) optional new value if setting

Returns

TauPQuery: new value if getting, this if setting

▸ getTimeout()

src/taup3.ts

getTimeout(): (number | undefined)

Returns

(number | undefined)

▸ queryText()

src/taup3.ts

queryText(): Promise<string>

Returns

Promise<string>

▸ queryJson()

src/taup3.ts

queryJson(): Promise<TauP3TimeJsonType>

Returns

Promise<TauP3TimeJsonType>

▸ querySvg()

src/taup3.ts

querySvg(): Promise<Element>

Returns

Promise<Element>

▸ queryWadl()

src/taup3.ts

queryWadl(): Promise<Document>

Returns

Promise<Document>

▸ query()

src/taup3.ts

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

Returns

Promise<(TauP3TimeJsonType | Element | string)>

▸ formBaseURL()

src/taup3.ts

Forms the basic URL to contact the web service, without any query paramters

formBaseURL(): string

Returns

string: the url

▸ formURL(toolname?)

src/taup3.ts

formURL(toolname: string?): string

Parameters

toolname (string?)

Returns

string

▸ queryTauPVersion()

src/taup3.ts

queryTauPVersion(): Promise<string>

Returns

Promise<string>

▸ formTauPVersionURL()

src/taup3.ts

formTauPVersionURL(): string

Returns

string

▸ formWadlURL()

src/taup3.ts

formWadlURL(): string

Returns

string

FAKE_EMPTY_TEXT_MODEL

src/taup3.ts

FAKE_EMPTY_TEXT_MODEL

FAKE_EMPTY_TEXT_HEADERS

src/taup3.ts

FAKE_EMPTY_TEXT_HEADERS

createEmptyTraveltimeJson

src/taup3.ts

createEmptyTraveltimeJson(ttquery: TauPQuery): TauP3TimeJsonType

Parameters

ttquery (TauPQuery)

Returns

TauP3TimeJsonType

FAKE_EMPTY_SVG

src/taup3.ts

FAKE_EMPTY_SVG