seisplotjs 3.2.0 | Documentation

seisplotjs

3.2.0

SYNGINE_SERVICE
SERVICE_VERSION
SERVICE_NAME
calcMoment
SyngineQuery ▸
- Instance members
- #_channel
- #specVersion
- #getSpecVersion
- #protocol
- #getProtocol
- #host
- #getHost
- #nodata
- #getNodata
- #port
- #getPort
- #pathBase
- #getPathBase
- #format
- #getFormat
- #model
- #getModel
- #label
- #getLabel
- #components
- #getComponents
- #units
- #getUnits
- #dt
- #getDt
- #scale
- #getscale
- #kernelWidth
- #getKernelWidth
- #sourceWidth
- #getSourceWidth
- #originTime
- #getOriginTime
- #startTime
- #getStartTime
- #endTime
- #getEndTime
- #network
- #getNetwork
- #station
- #getStation
- #networkCode
- #getNetworkCode
- #stationCode
- #getStationCode
- #locationCode
- #getLocationCode
- #receiverLatitude
- #getReceiverLatitude
- #receiverLongitude
- #getReceiverLongitude
- #channel
- #getChannel
- #eventId
- #getEventId
- #quake
- #getQuake
- #sourceLatitude
- #getSourceLatitude
- #sourceLongitude
- #getSourceLongitude
- #sourceDepthInMeters
- #getSourceDepthInMeters
- #sourceDistanceInDegrees
- #getSourceDistanceInDegrees
- #sourceMomentTensor
- #getSourceMomentTensor
- #sourceDoubleCouple
- #getSourceDoubleCouple
- #sourceForce
- #getSsourceForce
- #queryDataRecords
- #queryMS3Records
- #querySeismograms
- #formBaseURL
- #formVersionURL
- #queryVersion
- #formURL

Need help reading this?

SYNGINE_SERVICE

src/syngine.ts

const for service name

SYNGINE_SERVICE

Type: string

SERVICE_VERSION

src/syngine.ts

Major version of the FDSN spec supported here. Currently is 1.

SERVICE_VERSION

Type: number

SERVICE_NAME

src/syngine.ts

Service name as used in the FDSN DataCenters registry, https://www.fdsn.org/datacenters

SERVICE_NAME

calcMoment

src/syngine.ts

calcMoment(Mw: number): number

Parameters

Mw (number)

Returns

number

SyngineQuery

src/syngine.ts

Query to a syngine web service.

new SyngineQuery(host: string?)

Extends FDSNCommon

Parameters

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

https://service.iris.edu/irisws/syngine/1/

Instance Members

▸ _channel

src/syngine.ts

_channel

Type: (Channel | undefined)

▸ specVersion(value?)

src/syngine.ts

Gets/Sets the version of the syngine spec, 1 is currently the only value. Setting this is probably a bad idea as the code may not be compatible with the web service.

specVersion(value: string?): SyngineQuery

Parameters

value (string?) spec version, usually 1

Returns

SyngineQuery: new value if getting, this if setting

▸ getSpecVersion()

src/syngine.ts

getSpecVersion(): string

Returns

string

▸ protocol(value?)

src/syngine.ts

Gets/Sets the protocol, http or https. This should match the protocol of the page loaded, but is autocalculated and generally need not be set.

protocol(value: string?): SyngineQuery

Parameters

value (string?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getProtocol()

src/syngine.ts

getProtocol(): string

Returns

string

▸ host(value?)

src/syngine.ts

Gets/Sets the remote host to connect to.

host(value: string?): SyngineQuery

Parameters

value (string?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getHost()

src/syngine.ts

getHost(): string

Returns

string

▸ nodata(value?)

src/syngine.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?): SyngineQuery

Parameters

value (number?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getNodata()

src/syngine.ts

getNodata(): (number | undefined)

Returns

(number | undefined)

▸ port(value?)

src/syngine.ts

Gets/Sets the remote port to connect to.

port(value: number?): SyngineQuery

Parameters

value (number?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getPort()

src/syngine.ts

getPort(): (number | undefined)

Returns

(number | undefined)

▸ pathBase(value?)

src/syngine.ts

pathBase(value: string?): SyngineQuery

Parameters

value (string?)

Returns

SyngineQuery

▸ getPathBase()

src/syngine.ts

getPathBase(): string

Returns

string

▸ format(value?)

src/syngine.ts

format(value: string?): SyngineQuery

Parameters

value (string?)

Returns

SyngineQuery

▸ getFormat()

src/syngine.ts

getFormat(): (string | undefined)

Returns

(string | undefined)

▸ model(value?)

src/syngine.ts

Get/Set the model query parameter.

model(value: string?): SyngineQuery

Parameters

value (string?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getModel()

src/syngine.ts

getModel(): (string | undefined)

Returns

(string | undefined)

▸ label(value?)

src/syngine.ts

Get/Set the label query parameter, used for file names.

label(value: string?): SyngineQuery

Parameters

value (string?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getLabel()

src/syngine.ts

getLabel(): (string | undefined)

Returns

(string | undefined)

▸ components(value?)

src/syngine.ts

Get/Set the components query parameter, used for file names.

components(value: string?): SyngineQuery

Parameters

value (string?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getComponents()

src/syngine.ts

getComponents(): (string | undefined)

Returns

(string | undefined)

▸ units(value?)

src/syngine.ts

Get/Set the units query parameter, displacement, velocity or acceleration.

units(value: string?): SyngineQuery

Parameters

value (string?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getUnits()

src/syngine.ts

getUnits(): (string | undefined)

Returns

(string | undefined)

▸ dt(value?)

src/syngine.ts

Gets/Sets the dt query parameter, for upsampling.

dt(value: number?): SyngineQuery

Parameters

value (number?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getDt()

src/syngine.ts

getDt(): (number | undefined)

Returns

(number | undefined)

▸ scale(value?)

src/syngine.ts

Gets/Sets the scale query parameter, for upsampling.

scale(value: number?): SyngineQuery

Parameters

value (number?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getscale()

src/syngine.ts

getscale(): (number | undefined)

Returns

(number | undefined)

▸ kernelWidth(value?)

src/syngine.ts

Gets/Sets the kernelwidth query parameter, for upsampling.

kernelWidth(value: number?): SyngineQuery

Parameters

value (number?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getKernelWidth()

src/syngine.ts

getKernelWidth(): (number | undefined)

Returns

(number | undefined)

▸ sourceWidth(value?)

src/syngine.ts

Gets/Sets the sourcewidth query parameter, for upsampling.

sourceWidth(value: number?): SyngineQuery

Parameters

value (number?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getSourceWidth()

src/syngine.ts

getSourceWidth(): (number | undefined)

Returns

(number | undefined)

▸ originTime(value?)

src/syngine.ts

Get/Set the origintime query parameter.

originTime(value: (DateTime | string)?): SyngineQuery

Parameters

value ((DateTime | string)?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getOriginTime()

src/syngine.ts

getOriginTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ startTime(value?)

src/syngine.ts

Get/Set the starttime query parameter.

startTime(value: (DateTime | string)?): SyngineQuery

Parameters

value ((DateTime | string)?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getStartTime()

src/syngine.ts

getStartTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ endTime(value?)

src/syngine.ts

Get/Set the endtime query parameter.

endTime(value: (DateTime | string)?): SyngineQuery

Parameters

value ((DateTime | string)?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getEndTime()

src/syngine.ts

getEndTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ network(value?)

src/syngine.ts

Get/Set the network query parameter, used for receiver location.

network(value: string?): SyngineQuery

Parameters

value (string?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getNetwork()

src/syngine.ts

getNetwork(): (string | undefined)

Returns

(string | undefined)

▸ station(value?)

src/syngine.ts

Get/Set the station query parameter, used for receiver location.

station(value: string?): SyngineQuery

Parameters

value (string?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getStation()

src/syngine.ts

getStation(): (string | undefined)

Returns

(string | undefined)

▸ networkCode(value?)

src/syngine.ts

Get/Set the network query parameter, code used for synthetics.

networkCode(value: string?): SyngineQuery

Parameters

value (string?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getNetworkCode()

src/syngine.ts

getNetworkCode(): (string | undefined)

Returns

(string | undefined)

▸ stationCode(value?)

src/syngine.ts

Get/Set the station query parameter, code used for synthetics.

stationCode(value: string?): SyngineQuery

Parameters

value (string?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getStationCode()

src/syngine.ts

getStationCode(): (string | undefined)

Returns

(string | undefined)

▸ locationCode(value?)

src/syngine.ts

Get/Set the location code query parameter.

locationCode(value: string?): SyngineQuery

Parameters

value (string?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getLocationCode()

src/syngine.ts

getLocationCode(): (string | undefined)

Returns

(string | undefined)

▸ receiverLatitude(value?)

src/syngine.ts

Get/Set the receiverlatitude query parameter.

receiverLatitude(value: number?): SyngineQuery

Parameters

value (number?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getReceiverLatitude()

src/syngine.ts

getReceiverLatitude(): (number | undefined)

Returns

(number | undefined)

▸ receiverLongitude(value?)

src/syngine.ts

Get/Set the receiverlongitude query parameter.

receiverLongitude(value: number?): SyngineQuery

Parameters

value (number?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getReceiverLongitude()

src/syngine.ts

getReceiverLongitude(): (number | undefined)

Returns

(number | undefined)

▸ channel(chan)

src/syngine.ts

channel(chan: Channel): SyngineQuery

Parameters

chan (Channel)

Returns

SyngineQuery

▸ getChannel()

src/syngine.ts

getChannel(): (Channel | undefined)

Returns

(Channel | undefined)

▸ eventId(value?)

src/syngine.ts

Get/Set the eventid query parameter.

eventId(value: string?): SyngineQuery

Parameters

value (string?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getEventId()

src/syngine.ts

getEventId(): (string | undefined)

Returns

(string | undefined)

▸ quake(quake)

src/syngine.ts

quake(quake: Quake): SyngineQuery

Parameters

quake (Quake)

Returns

SyngineQuery

▸ getQuake()

src/syngine.ts

getQuake(): (Quake | undefined)

Returns

(Quake | undefined)

▸ sourceLatitude(value?)

src/syngine.ts

Get/Set the sourcelatitude query parameter.

sourceLatitude(value: number?): SyngineQuery

Parameters

value (number?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getSourceLatitude()

src/syngine.ts

getSourceLatitude(): (number | undefined)

Returns

(number | undefined)

▸ sourceLongitude(value?)

src/syngine.ts

Get/Set the longitude query parameter.

sourceLongitude(value: number?): SyngineQuery

Parameters

value (number?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getSourceLongitude()

src/syngine.ts

getSourceLongitude(): (number | undefined)

Returns

(number | undefined)

▸ sourceDepthInMeters(value?)

src/syngine.ts

Get/Set the sourcedepthinmeters query parameter.

sourceDepthInMeters(value: number?): SyngineQuery

Parameters

value (number?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getSourceDepthInMeters()

src/syngine.ts

getSourceDepthInMeters(): (number | undefined)

Returns

(number | undefined)

▸ sourceDistanceInDegrees(value?)

src/syngine.ts

Get/Set the sourcedistanceindegrees query parameter.

sourceDistanceInDegrees(value: number?): SyngineQuery

Parameters

value (number?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getSourceDistanceInDegrees()

src/syngine.ts

getSourceDistanceInDegrees(): (number | undefined)

Returns

(number | undefined)

▸ sourceMomentTensor(value?)

src/syngine.ts

Get/Set the sourcemomenttensorb query parameter.

sourceMomentTensor(value: Array<number>?): SyngineQuery

Parameters

value (Array<number>?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getSourceMomentTensor()

src/syngine.ts

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

Returns

(Array<number> | undefined)

▸ sourceDoubleCouple(value?)

src/syngine.ts

Get/Set the sourcedoublecouple query parameter.

sourceDoubleCouple(value: Array<number>?): SyngineQuery

Parameters

value (Array<number>?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getSourceDoubleCouple()

src/syngine.ts

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

Returns

(Array<number> | undefined)

▸ sourceForce(value?)

src/syngine.ts

Get/Set the sourceforce query parameter.

sourceForce(value: Array<number>?): SyngineQuery

Parameters

value (Array<number>?) optional new value if setting

Returns

SyngineQuery: new value if getting, this if setting

▸ getSsourceForce()

src/syngine.ts

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

Returns

(Array<number> | undefined)

▸ queryDataRecords()

src/syngine.ts

queries the web service using the configured parameters, parsing the response into miniseed data records.

queryDataRecords(): Promise<Array<miniseed.DataRecord>>

Returns

Promise<Array<miniseed.DataRecord>>: Promise to Array of miniseed.DataRecords

▸ queryMS3Records()

src/syngine.ts

queries the web service using the configured parameters, parsing the response into miniseed2 data records, then convert to MSeed3Records populating extra headers.

queryMS3Records(): Promise<Array<mseed3.MSeed3Record>>

Returns

Promise<Array<mseed3.MSeed3Record>>: Promise to Array of mseed3.MSeed3Record

▸ querySeismograms()

src/syngine.ts

queries the web service using the configured parameters, parsing the response into miniseed data records and then combining the data records into SeismogramDisplayData objects.

querySeismograms(): Promise<Array<SeismogramDisplayData>>

Returns

Promise<Array<SeismogramDisplayData>>: Promise to Array of SeismogramDisplayData objects

▸ formBaseURL()

src/syngine.ts

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

formBaseURL(): string

Returns

string: the url

▸ formVersionURL()

src/syngine.ts

formVersionURL(): string

Returns

string

▸ queryVersion()

src/syngine.ts

Queries the remote web service to get its version

queryVersion(): Promise<string>

Returns

Promise<string>: Promise to version string

▸ formURL()

src/syngine.ts

formURL(): string

Returns

string