seisplotjs 3.2.7 | Documentation

seisplotjs

3.2.7

SYNGINE_SERVICE
SERVICE_VERSION
SERVICE_NAME
calcMoment
SyngineQuery ▸

Need help reading this?

SYNGINE_SERVICE

dist/syngine.mjs

const for service name

SYNGINE_SERVICE

Type: string

SERVICE_VERSION

dist/syngine.mjs

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

SERVICE_VERSION

Type: number

SERVICE_NAME

dist/syngine.mjs

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

SERVICE_NAME

calcMoment

dist/syngine.mjs

calcMoment(Mw: any)

Parameters

Mw (any)

SyngineQuery

dist/syngine.mjs

Query to a syngine web service.

new SyngineQuery(host: any)

Extends FDSNCommon

Parameters

host (any) optional host to connect to, defaults to Earthscope

https://service.earthscope.org/irisws/syngine/1/

Instance Members

▸ specVersion(value)

dist/syngine.mjs

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: any): any

Parameters

value (any) spec version, usually 1

Returns

any: new value if getting, this if setting

▸ getSpecVersion()

dist/syngine.mjs

getSpecVersion()

▸ protocol(value)

dist/syngine.mjs

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: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getProtocol()

dist/syngine.mjs

getProtocol()

▸ host(value)

dist/syngine.mjs

Gets/Sets the remote host to connect to.

host(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getHost()

dist/syngine.mjs

getHost()

▸ nodata(value)

dist/syngine.mjs

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: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getNodata()

dist/syngine.mjs

getNodata()

▸ port(value)

dist/syngine.mjs

Gets/Sets the remote port to connect to.

port(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getPort()

dist/syngine.mjs

getPort()

▸ pathBase(value)

dist/syngine.mjs

pathBase(value: any)

Parameters

value (any)

▸ getPathBase()

dist/syngine.mjs

getPathBase()

▸ format(value)

dist/syngine.mjs

format(value: any)

Parameters

value (any)

▸ getFormat()

dist/syngine.mjs

getFormat()

▸ model(value)

dist/syngine.mjs

Get/Set the model query parameter.

model(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getModel()

dist/syngine.mjs

getModel()

▸ label(value)

dist/syngine.mjs

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

label(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getLabel()

dist/syngine.mjs

getLabel()

▸ components(value)

dist/syngine.mjs

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

components(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getComponents()

dist/syngine.mjs

getComponents()

▸ units(value)

dist/syngine.mjs

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

units(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getUnits()

dist/syngine.mjs

getUnits()

▸ dt(value)

dist/syngine.mjs

Gets/Sets the dt query parameter, for upsampling.

dt(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getDt()

dist/syngine.mjs

getDt()

▸ scale(value)

dist/syngine.mjs

Gets/Sets the scale query parameter, for upsampling.

scale(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getscale()

dist/syngine.mjs

getscale()

▸ kernelWidth(value)

dist/syngine.mjs

Gets/Sets the kernelwidth query parameter, for upsampling.

kernelWidth(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getKernelWidth()

dist/syngine.mjs

getKernelWidth()

▸ sourceWidth(value)

dist/syngine.mjs

Gets/Sets the sourcewidth query parameter, for upsampling.

sourceWidth(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getSourceWidth()

dist/syngine.mjs

getSourceWidth()

▸ originTime(value)

dist/syngine.mjs

Get/Set the origintime query parameter.

originTime(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getOriginTime()

dist/syngine.mjs

getOriginTime()

▸ startTime(value)

dist/syngine.mjs

Get/Set the starttime query parameter.

startTime(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getStartTime()

dist/syngine.mjs

getStartTime()

▸ endTime(value)

dist/syngine.mjs

Get/Set the endtime query parameter.

endTime(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getEndTime()

dist/syngine.mjs

getEndTime()

▸ network(value)

dist/syngine.mjs

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

network(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getNetwork()

dist/syngine.mjs

getNetwork()

▸ station(value)

dist/syngine.mjs

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

station(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getStation()

dist/syngine.mjs

getStation()

▸ networkCode(value)

dist/syngine.mjs

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

networkCode(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getNetworkCode()

dist/syngine.mjs

getNetworkCode()

▸ stationCode(value)

dist/syngine.mjs

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

stationCode(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getStationCode()

dist/syngine.mjs

getStationCode()

▸ locationCode(value)

dist/syngine.mjs

Get/Set the location code query parameter.

locationCode(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getLocationCode()

dist/syngine.mjs

getLocationCode()

▸ receiverLatitude(value)

dist/syngine.mjs

Get/Set the receiverlatitude query parameter.

receiverLatitude(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getReceiverLatitude()

dist/syngine.mjs

getReceiverLatitude()

▸ receiverLongitude(value)

dist/syngine.mjs

Get/Set the receiverlongitude query parameter.

receiverLongitude(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getReceiverLongitude()

dist/syngine.mjs

getReceiverLongitude()

▸ channel(chan)

dist/syngine.mjs

channel(chan: any)

Parameters

chan (any)

▸ getChannel()

dist/syngine.mjs

getChannel()

▸ eventId(value)

dist/syngine.mjs

Get/Set the eventid query parameter.

eventId(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getEventId()

dist/syngine.mjs

getEventId()

▸ quake(quake)

dist/syngine.mjs

quake(quake: any)

Parameters

quake (any)

▸ getQuake()

dist/syngine.mjs

getQuake()

▸ sourceLatitude(value)

dist/syngine.mjs

Get/Set the sourcelatitude query parameter.

sourceLatitude(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getSourceLatitude()

dist/syngine.mjs

getSourceLatitude()

▸ sourceLongitude(value)

dist/syngine.mjs

Get/Set the longitude query parameter.

sourceLongitude(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getSourceLongitude()

dist/syngine.mjs

getSourceLongitude()

▸ sourceDepthInMeters(value)

dist/syngine.mjs

Get/Set the sourcedepthinmeters query parameter.

sourceDepthInMeters(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getSourceDepthInMeters()

dist/syngine.mjs

getSourceDepthInMeters()

▸ sourceDistanceInDegrees(value)

dist/syngine.mjs

Get/Set the sourcedistanceindegrees query parameter.

sourceDistanceInDegrees(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getSourceDistanceInDegrees()

dist/syngine.mjs

getSourceDistanceInDegrees()

▸ sourceMomentTensor(value)

dist/syngine.mjs

Get/Set the sourcemomenttensorb query parameter.

sourceMomentTensor(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getSourceMomentTensor()

dist/syngine.mjs

getSourceMomentTensor()

▸ sourceDoubleCouple(value)

dist/syngine.mjs

Get/Set the sourcedoublecouple query parameter.

sourceDoubleCouple(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getSourceDoubleCouple()

dist/syngine.mjs

getSourceDoubleCouple()

▸ sourceForce(value)

dist/syngine.mjs

Get/Set the sourceforce query parameter.

sourceForce(value: any): any

Parameters

value (any) optional new value if setting

Returns

any: new value if getting, this if setting

▸ getSsourceForce()

dist/syngine.mjs

getSsourceForce()

▸ queryDataRecords()

dist/syngine.mjs

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

queryDataRecords(): any

Returns

any: Promise to Array of miniseed.DataRecords

▸ queryMS3Records()

dist/syngine.mjs

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

queryMS3Records(): any

Returns

any: Promise to Array of mseed3.MSeed3Record

▸ querySeismograms()

dist/syngine.mjs

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(): any

Returns

any: Promise to Array of SeismogramDisplayData objects

▸ formBaseURL()

dist/syngine.mjs

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

formBaseURL(): any

Returns

any: the url

▸ formVersionURL()

dist/syngine.mjs

formVersionURL()