seisplotjs

3.2.7
STAXML_MIME

Type: string

xml namespace for stationxml

STAML_NS

Type: string

COUNT_UNIT_NAME

dist/stationxml.mjs
COUNT_UNIT_NAME

Type: string

FIX_INVALID_STAXML

dist/stationxml.mjs
FIX_INVALID_STAXML

Type: boolean

INVALID_NUMBER

dist/stationxml.mjs
INVALID_NUMBER

FAKE_START_DATE

dist/stationxml.mjs
FAKE_START_DATE

FAKE_EMPTY_XML

dist/stationxml.mjs

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

FAKE_EMPTY_XML

Type: string

CHANNEL_CLICK_EVENT

dist/stationxml.mjs
CHANNEL_CLICK_EVENT

Type: string

STATION_CLICK_EVENT

dist/stationxml.mjs
STATION_CLICK_EVENT

Type: string

isChannelClickCustomEvent

dist/stationxml.mjs

Typescript guard for channelclick CustomEvents.

isChannelClickCustomEvent(event: any): any
Parameters
event (any) generic event to ensure is a CustomEvent
Returns
any: true if is correct type

isStationClickCustomEvent

dist/stationxml.mjs

Typescript guard for stationclick CustomEvents.

isStationClickCustomEvent(event: any): any
Parameters
event (any) generic event to ensure is a CustomEvent
Returns
any: true if is correct type

createChannelClickEvent

dist/stationxml.mjs

Utility function to create CustomEvent for clicking on a Channel, for example in a map or table.

createChannelClickEvent(sta: any, mouseclick: any): any
Parameters
sta (any) Channel clicked on
mouseclick (any) original mouse click Event
Returns
any: CustomEvent populated with channel field in detail.

createStationClickEvent

dist/stationxml.mjs

Utility function to create CustomEvent for clicking on a Station, for example in a map or table.

createStationClickEvent(sta: any, mouseclick: any): any
Parameters
sta (any) Station clicked on
mouseclick (any) original mouse click Event
Returns
any: CustomEvent populated with station field in detail.
new Network(networkCode: any)
Parameters
networkCode (any)
Instance Members
sourceId
startDate
startDate
endDate
endDate
timeRange
codes()
isActiveAt(d)
isTempNet()
new Station(network: any, stationCode: any)
Parameters
network (any)
stationCode (any)
Instance Members
sourceId
startDate
startDate
endDate
endDate
timeRange
networkCode
isActiveAt(d)
codes(sep)
new Channel(station: any, channelCode: any, locationCode: any)
Parameters
station (any)
channelCode (any)
locationCode (any)
Instance Members
sourceId
sourceId
startDate
startDate
endDate
endDate
timeRange
locationCode
locationCode
stationCode
networkCode
hasInstrumentSensitivity()
instrumentSensitivity
instrumentSensitivity
nslc
codes(sep)
isActiveAt(d)

InstrumentSensitivity

dist/stationxml.mjs
new InstrumentSensitivity(sensitivity: any, frequency: any, inputUnits: any, outputUnits: any)
Parameters
sensitivity (any)
frequency (any)
inputUnits (any)
outputUnits (any)
new Equipment()
new Response(instrumentSensitivity: any, stages: any)
Parameters
instrumentSensitivity (any)
stages (any)
new Stage(filter: any, decimation: any, gain: any)
Parameters
filter (any)
decimation (any)
gain (any)

AbstractFilterType

dist/stationxml.mjs
new AbstractFilterType(inputUnits: any, outputUnits: any)
Parameters
inputUnits (any)
outputUnits (any)
new PolesZeros(inputUnits: any, outputUnits: any)

Extends AbstractFilterType

Parameters
inputUnits (any)
outputUnits (any)
new FIR(inputUnits: any, outputUnits: any)

Extends AbstractFilterType

Parameters
inputUnits (any)
outputUnits (any)

CoefficientsFilter

dist/stationxml.mjs
new CoefficientsFilter(inputUnits: any, outputUnits: any)

Extends AbstractFilterType

Parameters
inputUnits (any)
outputUnits (any)
new Decimation(inputSampleRate: any, factor: any)
Parameters
inputSampleRate (any)
factor (any)
new Gain(value: any, frequency: any)
Parameters
value (any)
frequency (any)
new Span(interval: any)
Parameters
interval (any)

DataAvailability

dist/stationxml.mjs
new DataAvailability()
new Comment(value: any)
Parameters
value (any)
new Author()

parseStationXml

dist/stationxml.mjs

Parses the FDSN StationXML returned from a query.

parseStationXml(rawXml: any): any
Parameters
rawXml (any) parsed xml to extract objects from
Returns
any: an Array of Network objects.

convertToNetwork

dist/stationxml.mjs

Parses a FDSNStationXML Network xml element into a Network object.

convertToNetwork(xml: any): any
Parameters
xml (any) the network xml Element
Returns
any: Network instance

convertToStation

dist/stationxml.mjs

Parses a FDSNStationXML Station xml element into a Station object.

convertToStation(network: any, xml: any): any
Parameters
network (any) the containing network
xml (any) the station xml Element
Returns
any: Station instance

convertToChannel

dist/stationxml.mjs

Parses a FDSNStationXML Channel xml element into a Channel object.

convertToChannel(station: any, xml: any): any
Parameters
station (any) the containing staton
xml (any) the channel xml Element
Returns
any: Channel instance

convertToDataAvailability

dist/stationxml.mjs
convertToDataAvailability(xml: any)
Parameters
xml (any)

convertToComment

dist/stationxml.mjs
convertToComment(xml: any)
Parameters
xml (any)

convertToAuthor

dist/stationxml.mjs
convertToAuthor(xml: any)
Parameters
xml (any)

convertToEquipment

dist/stationxml.mjs
convertToEquipment(xml: any)
Parameters
xml (any)

convertToResponse

dist/stationxml.mjs

Parses a FDSNStationXML Response xml element into a Response object.

convertToResponse(responseXml: any): any
Parameters
responseXml (any) the response xml Element
Returns
any: Response instance

convertToInstrumentSensitivity

dist/stationxml.mjs

Parses a FDSNStationXML InstrumentSensitivity xml element into a InstrumentSensitivity object.

convertToInstrumentSensitivity(xml: any): any
Parameters
xml (any) the InstrumentSensitivity xml Element
Returns
any: InstrumentSensitivity instance

convertToStage

dist/stationxml.mjs

Parses a FDSNStationXML Stage xml element into a Stage object.

convertToStage(stageXml: any): any
Parameters
stageXml (any) the Stage xml Element
Returns
any: Stage instance

convertToDecimation

dist/stationxml.mjs

Parses a FDSNStationXML Decimation xml element into a Decimation object.

convertToDecimation(decXml: any): any
Parameters
decXml (any) the Decimation xml Element
Returns
any: Decimation instance

convertToGain

dist/stationxml.mjs

Parses a FDSNStationXML Gain xml element into a Gain object.

convertToGain(gainXml: any): any
Parameters
gainXml (any) the Gain xml Element
Returns
any: Gain instance

createInterval

dist/stationxml.mjs
createInterval(start: any, end: any)
Parameters
start (any)
end (any)

extractComplex

dist/stationxml.mjs

Extracts a complex number from an stationxml element.

extractComplex(el: any): any
Parameters
el (any) xml element
Returns
any: Complex instance

activeNetworks

dist/stationxml.mjs

Generator function to access all active stations within all networks in the array.

activeNetworks(networks: any, atTime: any)
Parameters
networks (any) array of Networks
atTime (any) time for station to be active, defaults to now

Generator function to access all stations within all networks in the array.

allStations(networks: any)
Parameters
networks (any) array of Networks

activeStations

dist/stationxml.mjs

Generator function to access all active stations within all networks in the array.

activeStations(networks: any, atTime: any)
Parameters
networks (any) array of Networks
atTime (any) time for station to be active, defaults to now

Generator function to access all channels within all stations within all networks in the array.

allChannels(networks: any)
Parameters
networks (any) array of Networks

activeChannels

dist/stationxml.mjs

Generator function to access all active channels within all networks in the array.

activeChannels(networks: any, atTime: any)
Parameters
networks (any) array of Networks
atTime (any) time for channel to be active, defaults to now

Extract all channels from all stations from all networks in the input array. Regular expressions may be used instead of exact code matchs.

findChannels(networks: any, netCode: any, staCode: any, locCode: any, chanCode: any)
Parameters
networks (any) Array of networks.
netCode (any = ".*") network code to match, defaults to .*
staCode (any = ".*") station code to match, defaults to .*
locCode (any = ".*") location code to match, defaults to .*
chanCode (any = ".*") channel code to match, defaults to .*

findChannelsForSourceId

dist/stationxml.mjs
findChannelsForSourceId(networks: any, sid: any)
Parameters
networks (any)
sid (any)

uniqueSourceIds

dist/stationxml.mjs
uniqueSourceIds(channelList: any)
Parameters
channelList (any)

uniqueStations

dist/stationxml.mjs
uniqueStations(channelList: any)
Parameters
channelList (any)

uniqueNetworks

dist/stationxml.mjs
uniqueNetworks(channelList: any)
Parameters
channelList (any)

fetchStationXml

dist/stationxml.mjs

Fetches and parses StationXML from a URL. This can be used in instances where a static stationXML file is available on a web site instead of via a web service with query paramters.

fetchStationXml(url: any, timeoutSec: any, nodata: any): any
Parameters
url (any) the url to download from
timeoutSec (any = 10) timeout in case of failed connection
nodata (any = 204) http code for no data
Returns
any: Promise to parsed StationXML as an Network array

mightBeStatonXml

dist/stationxml.mjs
mightBeStatonXml(buf: any)
Parameters
buf (any)
parseUtil
Static Members
_grabFirstEl
_grabFirstElText
_grabFirstElFloat
_grabFirstElInt
_grabAttribute
_requireAttribute
_grabAttributeNS