seisplotjs.fdsndataselect 2.0.0-alpha.4

seisplotjs.fdsndataselect

2.0.0-alpha.4

FORMAT_MINISEED
SERVICE_VERSION
SERVICE_NAME
IRIS_HOST
DataSelectQuery ▸
- Instance members
- #specVersion
- #protocol
- #host
- #nodata
- #port
- #networkCode
- #stationCode
- #locationCode
- #channelCode
- #startTime
- #endTime
- #timeWindow
- #quality
- #minimumLength
- #longestOnly
- #repository
- #format
- #timeout
- #queryDataRecords
- #querySeismograms
- #postQueryDataRecords
- #postQuerySeismograms
- #postQueryRaw
- #createPostBody
- #formBaseURL
- #formVersionURL
- #queryVersion
- #makeParam
- #formURL
createDataSelectQuery

Need help reading this?

FORMAT_MINISEED

src/fdsndataselect.js

const for miniseed format, mseed

FORMAT_MINISEED

Type: string

SERVICE_VERSION

src/fdsndataselect.js

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

SERVICE_VERSION

Type: number

SERVICE_NAME

src/fdsndataselect.js

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

SERVICE_NAME

IRIS_HOST

src/fdsndataselect.js

const for the default IRIS web service host, service.iris.edu

IRIS_HOST

Type: string

DataSelectQuery

src/fdsndataselect.js

Query to a FDSN Dataselect web service.

new DataSelectQuery(host: string?)

Parameters

host (string?)

Instance Members

▸ specVersion(value?)

src/fdsndataselect.js

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: number?): (number | DataSelectQuery)

Parameters

value (number?)

Returns

(number | DataSelectQuery)

▸ protocol(value?)

src/fdsndataselect.js

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?): (string | DataSelectQuery)

Parameters

value (string?)

Returns

(string | DataSelectQuery)

▸ host(value?)

src/fdsndataselect.js

Gets/Sets the remote host to connect to.

host(value: string?): (string | DataSelectQuery)

Parameters

value (string?)

Returns

(string | DataSelectQuery)

▸ nodata(value?)

src/fdsndataselect.js

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?): (number | DataSelectQuery)

Parameters

value (number?)

Returns

(number | DataSelectQuery)

▸ port(value?)

src/fdsndataselect.js

Gets/Sets the remote port to connect to.

port(value: number?): (number | DataSelectQuery)

Parameters

value (number?)

Returns

(number | DataSelectQuery)

▸ networkCode(value?)

src/fdsndataselect.js

networkCode(value: string?): (string | DataSelectQuery)

Parameters

value (string?)

Returns

(string | DataSelectQuery)

▸ stationCode(value?)

src/fdsndataselect.js

stationCode(value: string?): (string | DataSelectQuery)

Parameters

value (string?)

Returns

(string | DataSelectQuery)

▸ locationCode(value?)

src/fdsndataselect.js

locationCode(value: string?): (string | DataSelectQuery)

Parameters

value (string?)

Returns

(string | DataSelectQuery)

▸ channelCode(value?)

src/fdsndataselect.js

channelCode(value: string?): (string | DataSelectQuery)

Parameters

value (string?)

Returns

(string | DataSelectQuery)

▸ startTime(value?)

src/fdsndataselect.js

startTime(value: moment?): (moment | DataSelectQuery)

Parameters

value (moment?)

Returns

(moment | DataSelectQuery)

▸ endTime(value?)

src/fdsndataselect.js

endTime(value: moment?): (moment | DataSelectQuery)

Parameters

value (moment?)

Returns

(moment | DataSelectQuery)

▸ timeWindow(se)

src/fdsndataselect.js

Sets startTime and endTime using the given time window

timeWindow(se: StartEndDuration): any

Parameters

se (StartEndDuration) time window

Returns

any: this

▸ quality(value?)

src/fdsndataselect.js

quality(value: string?): (string | DataSelectQuery)

Parameters

value (string?)

Returns

(string | DataSelectQuery)

▸ minimumLength(value?)

src/fdsndataselect.js

minimumLength(value: number?): (number | DataSelectQuery)

Parameters

value (number?)

Returns

(number | DataSelectQuery)

▸ longestOnly(value?)

src/fdsndataselect.js

longestOnly(value: boolean?): (boolean | DataSelectQuery)

Parameters

value (boolean?)

Returns

(boolean | DataSelectQuery)

▸ repository(value?)

src/fdsndataselect.js

set or get the repository paramter. This is an IRIS-specific parameter that will not work with other dataselect web services.

repository(value: string?): (string | DataSelectQuery)

Parameters

value (string?)

Returns

(string | DataSelectQuery)

▸ format(value?)

src/fdsndataselect.js

format(value: string?): (string | DataSelectQuery)

Parameters

value (string?)

Returns

(string | DataSelectQuery)

▸ timeout(value?)

src/fdsndataselect.js

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

timeout(value: number?): (number | DataSelectQuery)

Parameters

value (number?)

Returns

(number | DataSelectQuery)

▸ queryDataRecords()

src/fdsndataselect.js

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

▸ querySeismograms()

src/fdsndataselect.js

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

querySeismograms(): Promise<Array<Seismogram>>

Returns

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

▸ postQueryDataRecords(channelTimeList)

src/fdsndataselect.js

postQueryDataRecords(channelTimeList: Array<SeismogramDisplayData>): Promise<Array<miniseed.DataRecord>>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

Promise<Array<miniseed.DataRecord>>

▸ postQuerySeismograms(channelTimeList)

src/fdsndataselect.js

query the dataselect server 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(channelTimeList: [type]): Promise<Array<SeismogramDisplayData>>

Parameters

channelTimeList ([type]) 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(channelTimeList)

src/fdsndataselect.js

postQueryRaw(channelTimeList: Array<SeismogramDisplayData>): Promise<Response>

Parameters

channelTimeList (Array<SeismogramDisplayData>)

Returns

Promise<Response>

▸ createPostBody(channelTimeList)

src/fdsndataselect.js

createPostBody(channelTimeList: Array<SeismogramDisplayData>): string

Parameters

channelTimeList (Array<SeismogramDisplayData>)