seisplotjs 3.1.1 | Documentation

seisplotjs

3.1.1

SERVICE_VERSION
SERVICE_NAME
IRIS_HOST
TARGET_DATASELECT
TARGET_STATION
FAKE_EMPTY_TEXT
FedCatalogDataCenter ▸
- Instance members
- #dataCenter
- #services
- #stationService
- #dataSelectService
- #postLines
- #stationQuery
- #dataSelectQuery
- #level
- #queryNetworkList
- #queryStationRawXml
- #querySDDList
FedCatalogResult ▸
- Instance members
- #params
- #queries
FedCatalogQuery ▸
- Static members
- .fromStationQuery

Need help reading this?

SERVICE_VERSION

Major version of the IRIS web service supported here. Currently is 1.

SERVICE_VERSION

Type: number

SERVICE_NAME

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

SERVICE_NAME

FAKE_EMPTY_TEXT

a fake, completely empty stationxml document in case of no data.

FAKE_EMPTY_TEXT

Type: string

FedCatalogDataCenter

Represents the part of the results of a fedcatalog query for a single datacenter, a section of the larger FedCatalogResult.

new FedCatalogDataCenter()

Instance Members

▸ dataCenter

dataCenter

Type: string

▸ services

services

Type: Map<string, string>

▸ stationService

stationService

Type: string

▸ dataSelectService

dataSelectService

Type: string

▸ postLines

postLines

Type: Array<string>

▸ stationQuery

stationQuery

Type: (StationQuery | null)

▸ dataSelectQuery

dataSelectQuery

Type: (DataSelectQuery | null)

▸ level

level

Type: string

▸ queryNetworkList()

Uses the response from the FedCat server to make the actual FDSNStation query that returns StationXML. If the original FedCat query did not return a Station service, or it was not asked for, then the array will be empty.

queryNetworkList(): Promise<Array<Network>>

Returns

Promise<Array<Network>>: promise to networks

▸ queryStationRawXml()

queryStationRawXml(): Promise<Document>

Returns

Promise<Document>

▸ querySDDList()

querySDDList(): Promise<Array<SeismogramDisplayData>>

Returns

Promise<Array<SeismogramDisplayData>>

FedCatalogResult

Represents the results of a fedcatalog query.

new FedCatalogResult()

Instance Members

▸ params

params

Type: Map<string, string>

▸ queries

queries

Type: Array<FedCatalogDataCenter>

FedCatalogQuery

Query to a IRIS FedCatalog web service.

new FedCatalogQuery(host: string?)

Extends FDSNCommon

Parameters

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

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

Static Members

▸ fromStationQuery(stationQuery)

Constructs a station FedCatalogQuery using the parameters in a StationQuery.

fromStationQuery(stationQuery: StationQuery): FedCatalogQuery

Parameters

stationQuery (StationQuery) query to pull parameters from

Returns

FedCatalogQuery: fedcatalog query

Instance Members

▸ fedCatResult

fedCatResult

Type: (Promise<FedCatalogResult> | null)

▸ specVersion(value?)

Gets/Sets the version of the fdsnws 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?): FedCatalogQuery

Parameters

value (string?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getSpecVersion()

getSpecVersion(): string

Returns

string

▸ protocol(value?)

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?): FedCatalogQuery

Parameters

value (string?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getProtocol()

getProtocol(): (string | undefined)

Returns

(string | undefined)

▸ host(value?)

Gets/Sets the remote host to connect to.

host(value: string?): FedCatalogQuery

Parameters

value (string?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getHost()

getHost(): (string | undefined)

Returns

(string | undefined)

▸ port(value?)

Gets/Sets the remote port to connect to.

port(value: number?): FedCatalogQuery

Parameters

value (number?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getPort()

getPort(): (number | undefined)

Returns

(number | undefined)

▸ nodata(value?)

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?): FedCatalogQuery

Parameters

value (number?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getNodata()

getNodata(): (number | undefined)

Returns

(number | undefined)

▸ targetService(value?)

Get/Set the targetservice query parameter.

targetService(value: string?): FedCatalogQuery

Parameters

value (string?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getTargetService()

getTargetService(): (string | undefined)

Returns

(string | undefined)

▸ networkCode(value?)

Get/Set the network query parameter.

networkCode(value: string?): FedCatalogQuery

Parameters

value (string?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getNetworkCode()

getNetworkCode(): (string | undefined)

Returns

(string | undefined)

▸ stationCode(value?)

Get/Set the station query parameter.

stationCode(value: string?): FedCatalogQuery

Parameters

value (string?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getStationCode()

getStationCode(): (string | undefined)

Returns

(string | undefined)

▸ locationCode(value?)

Get/Set the location code query parameter.

locationCode(value: string?): FedCatalogQuery

Parameters

value (string?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getLocationCode()

getLocationCode(): (string | undefined)

Returns

(string | undefined)

▸ channelCode(value?)

Get/Set the channel query parameter.

channelCode(value: string?): FedCatalogQuery

Parameters

value (string?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getChannelCode()

getChannelCode(): (string | undefined)

Returns

(string | undefined)

▸ nslcCodes(channelId)

nslcCodes(channelId: NslcId): FedCatalogQuery

Parameters

channelId (NslcId)

Returns

FedCatalogQuery

▸ startTime(value?)

Get/Set the starttime query parameter.

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

Parameters

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

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getStartTime()

getStartTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ endTime(value?)

Get/Set the endtime query parameter.

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

Parameters

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

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getEndTime()

getEndTime(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ timeRange(se)

Sets startTime and endTime using the given time window

timeRange(se: Interval): FedCatalogQuery

Parameters

se (Interval) time window

Returns

FedCatalogQuery: this

▸ startBefore(value?)

Get/Set the startbefore query parameter.

startBefore(value: (DateTime | string)?): FedCatalogQuery

Parameters

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

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getStartBefore()

getStartBefore(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ endBefore(value?)

Get/Set the endbefore query parameter.

endBefore(value: (DateTime | string)?): FedCatalogQuery

Parameters

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

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getEndBefore()

getEndBefore(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ startAfter(value?)

Get/Set the startafter query parameter.

startAfter(value: (DateTime | string)?): FedCatalogQuery

Parameters

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

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getStartAfter()

getStartAfter(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ endAfter(value?)

Get/Set the endafter query parameter.

endAfter(value: (DateTime | string)?): FedCatalogQuery

Parameters

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

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getEndAfter()

getEndAfter(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ minLat(value?)

Get/Set the minlat query parameter.

minLat(value: number?): FedCatalogQuery

Parameters

value (number?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getMinLat()

getMinLat(): (number | undefined)

Returns

(number | undefined)

▸ maxLat(value?)

Get/Set the maxlon query parameter.

maxLat(value: number?): FedCatalogQuery

Parameters

value (number?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getMaxLat()

getMaxLat(): (number | undefined)

Returns

(number | undefined)

▸ minLon(value?)

Get/Set the minlon query parameter.

minLon(value: number?): FedCatalogQuery

Parameters

value (number?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getMinLon()

getMinLon(): (number | undefined)

Returns

(number | undefined)

▸ maxLon(value?)

Get/Set the maxlon query parameter.

maxLon(value: number?): FedCatalogQuery

Parameters

value (number?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getMaxLon()

getMaxLon(): (number | undefined)

Returns

(number | undefined)

▸ latitude(value?)

Get/Set the latitude query parameter.

latitude(value: number?): FedCatalogQuery

Parameters

value (number?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getLatitude()

getLatitude(): (number | undefined)

Returns

(number | undefined)

▸ longitude(value?)

Get/Set the longitude query parameter.

longitude(value: number?): FedCatalogQuery

Parameters

value (number?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getLongitude()

getLongitude(): (number | undefined)

Returns

(number | undefined)

▸ minRadius(value?)

Get/Set the minradius query parameter.

minRadius(value: number?): FedCatalogQuery

Parameters

value (number?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getMinRadius()

getMinRadius(): (number | undefined)

Returns

(number | undefined)

▸ maxRadius(value?)

Get/Set the maxradius query parameter.

maxRadius(value: number?): FedCatalogQuery

Parameters

value (number?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getMaxRadius()

getMaxRadius(): (number | undefined)

Returns

(number | undefined)

▸ includeRestricted(value?)

Get/Set the includerestricted query parameter.

includeRestricted(value: boolean?): FedCatalogQuery

Parameters

value (boolean?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getIncludeRestricted()

getIncludeRestricted(): (boolean | undefined)

Returns

(boolean | undefined)

▸ includeAvailability(value?)

Get/Set the includeavailability query parameter.

includeAvailability(value: boolean?): FedCatalogQuery

Parameters

value (boolean?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getIncludeAvailability()

getIncludeAvailability(): (boolean | undefined)

Returns

(boolean | undefined)

▸ format(value?)

Get/Set the format query parameter.

format(value: string?): FedCatalogQuery

Parameters

value (string?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getFormat()

getFormat(): (string | undefined)

Returns

(string | undefined)

▸ updatedAfter(value?)

Get/Set the updatedafter query parameter.

updatedAfter(value: DateTime?): FedCatalogQuery

Parameters

value (DateTime?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getUpdatedAfter()

getUpdatedAfter(): (DateTime | undefined)

Returns

(DateTime | undefined)

▸ matchTimeseries(value?)

Get/Set the matchtimeseries query parameter.

matchTimeseries(value: boolean?): FedCatalogQuery

Parameters

value (boolean?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getMatchTimeseries()

getMatchTimeseries(): (boolean | undefined)

Returns

(boolean | undefined)

▸ timeout(value?)

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

timeout(value: number?): FedCatalogQuery

Parameters

value (number?) optional new value if setting

Returns

FedCatalogQuery: new value if getting, this if setting

▸ getTimeout()

getTimeout(): (number | undefined)

Returns

(number | undefined)

▸ isSomeParameterSet()

Checks to see if any parameter that would limit the data returned is set. This is a crude, coarse check to make sure the client doesn't ask for EVERYTHING the server has.

isSomeParameterSet(): boolean

Returns

boolean: true if some parameter set

▸ queryNetworks()

Queries the remote web service for networks.

queryNetworks(): Promise<Array<Network>>

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ queryStations()

Queries the remote web service for stations. The stations are contained within their respective Networks.

queryStations(): Promise<Array<Network>>

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ queryChannels()

Queries the remote web service for channels. The Channels are contained within their respective Stations which are in Networks.

queryChannels(): Promise<Array<Network>>

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ queryResponses()

Queries the remote web service for responses. The Responses are contained within their respective Channels, which are in Stations which are in Networks.

queryResponses(): Promise<Array<Network>>

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ queryFdsnStation(level)

Queries the remote station web service at the given level.

queryFdsnStation(level: string): Promise<Array<Network>>

Parameters

level (string) the level to query at, networ, station, channel or response.

Returns

Promise<Array<Network>>: a Promise to an Array of Network objects.

▸ setupQueryFdsnStation(level)

setupQueryFdsnStation(level: string): Promise<FedCatalogResult>

Parameters

level (string)

Returns

Promise<FedCatalogResult>

▸ setupForFdnsDataSelect(fedCatalogResult)

For each item in a parsed result returned from a FedCat service, create a DataSelectQuery with host and port, or url filled in correctly, ready to be called with the result lines.

setupForFdnsDataSelect(fedCatalogResult: FedCatalogResult): FedCatalogResult

Parameters

fedCatalogResult (FedCatalogResult) result from a FedCat web service

Returns

FedCatalogResult: result with dataSelectQuery added to each item

▸ queryFdsnDataselect()

queryFdsnDataselect(): Promise<Array<SeismogramDisplayData>>

Returns

Promise<Array<SeismogramDisplayData>>

▸ postFdsnDataselectForFedCatResult(fedCatalogResult)

postFdsnDataselectForFedCatResult(fedCatalogResult: FedCatalogResult): Promise<Array<SeismogramDisplayData>>

Parameters

fedCatalogResult (FedCatalogResult)

Returns

Promise<Array<SeismogramDisplayData>>

▸ postQuerySeismograms(sddList)

query the fed cat server for dataselect using post, which allows for multiple channel-timeranges at once. This assumes that there are not multiple time ranges for the same channel as the results, encapsulated as SeismogramDisplayData objects, are returned one seismogram per channel, which may contain gaps. The original channel and timerange are also populated with each result.

postQuerySeismograms(sddList: Array<SeismogramDisplayData>): Promise<Array<SeismogramDisplayData>>

Parameters

sddList (Array<SeismogramDisplayData>) array of SeismogramDisplayData objects that will be filled in with the resulting seismogram

Returns

Promise<Array<SeismogramDisplayData>>: Promise to the input Array of SeismogramDisplayData objects, each with the seismogram containing the data returned from the server

▸ postQueryRaw(sddList, targetService)

postQueryRaw(sddList: Array<SeismogramDisplayData>, targetService: string): Promise<FedCatalogResult>

Parameters

sddList (Array<SeismogramDisplayData>)

targetService (string)

Returns

Promise<FedCatalogResult>

▸ postQueryRawWithBody(body)

postQueryRawWithBody(body: string): Promise<FedCatalogResult>

Parameters

body (string)

Returns

Promise<FedCatalogResult>

▸ queryRaw()

Queries the remote web service.

queryRaw(): Promise<FedCatalogResult>

Returns

Promise<FedCatalogResult>: a Promise to an parsed result.

▸ handleHttpResponseCodes(response)

handleHttpResponseCodes(response: Response): Promise<string>

Parameters

response (Response)

Returns

Promise<string>

▸ parseRequest(requestText)

parseRequest(requestText: string): FedCatalogResult

Parameters

requestText (string)

Returns

FedCatalogResult

▸ formVersionURL()

Forms the URL to get version from the web service, without any query paramters

formVersionURL(): string

Returns

string: the url

▸ queryVersion()

Queries the remote web service to get its version

queryVersion(): Promise<string>

Returns

Promise<string>: Promise to version string

▸ formBaseURL()

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

formBaseURL(): string

Returns

string: the url

▸ formPostURL()

Form URL to post the remote web service. No parameters are added to the URL as those will be in the body of the post.

formPostURL(): string

Returns

string: the URL for posting

▸ formURL()

Form URL to query the remote web service, encoding the query parameters.

formURL(): string

Returns

string: url

seisplotjs

SERVICE_VERSION

SERVICE_NAME

IRIS_HOST

TARGET_DATASELECT

TARGET_STATION

FAKE_EMPTY_TEXT

FedCatalogDataCenter

FedCatalogResult

FedCatalogQuery