seisplotjs 3.2.1 | Documentation

seisplotjs

3.2.1

STAXML_MIME
STAML_NS
COUNT_UNIT_NAME
FIX_INVALID_STAXML
INVALID_NUMBER
FAKE_START_DATE
FAKE_EMPTY_XML
CHANNEL_CLICK_EVENT
STATION_CLICK_EVENT
ChannelEventDetail
StationEventDetail
isChannelClickCustomEvent
isStationClickCustomEvent
createChannelClickEvent
createStationClickEvent
StationClickEventMap
ChannelClickEventMap
Network ▸
- Instance members
- #networkCode
- #_startDate
- #_endDate
- #restrictedStatus
- #description
- #totalNumberStations
- #stations
- #sourceId
- #startDate
- #startDate
- #endDate
- #endDate
- #timeRange
- #codes
- #isActiveAt
- #isTempNet
Station ▸
- Instance members
- #network
- #stationCode
- #sourceID
- #restrictedStatus
- #name
- #latitude
- #longitude
- #elevation
- #waterLevel
- #comments
- #equipmentList
- #dataAvailability
- #identifierList
- #description
- #geology
- #vault
- #channels
- #sourceId
- #startDate
- #startDate
- #endDate
- #endDate
- #timeRange
- #networkCode
- #isActiveAt
- #codes
Channel ▸
- Instance members
- #station
- #channelCode
- #restrictedStatus
- #latitude
- #longitude
- #elevation
- #depth
- #azimuth
- #dip
- #sampleRate
- #waterLevel
- #comments
- #equipmentList
- #dataAvailability
- #identifierList
- #description
- #response
- #sensor
- #preamplifier
- #datalogger
- #sourceId
- #sourceId
- #nslcId
- #startDate
- #startDate
- #endDate
- #endDate
- #timeRange
- #locationCode
- #locationCode
- #stationCode
- #networkCode
- #hasInstrumentSensitivity
- #instrumentSensitivity
- #instrumentSensitivity
- #nslc
- #codes
- #isActiveAt
InstrumentSensitivity ▸
- Instance members
- #sensitivity
- #frequency
- #inputUnits
- #outputUnits
Equipment ▸
- Instance members
- #resourceId
- #type
- #description
- #manufacturer
- #vendor
- #model
- #serialNumber
- #installationDate
- #removalDate
- #calibrationDateList
Response ▸
- Instance members
- #instrumentSensitivity
- #stages
Stage ▸
- Instance members
- #filter
- #decimation
- #gain
AbstractFilterType ▸
- Instance members
- #inputUnits
- #outputUnits
- #name
- #description
PolesZeros ▸
- Instance members
- #pzTransferFunctionType
- #normalizationFactor
- #normalizationFrequency
- #zeros
- #poles
FIR ▸
- Instance members
- #symmetry
- #numerator
CoefficientsFilter ▸
- Instance members
- #cfTransferFunction
- #numerator
- #denominator
Decimation ▸
- Instance members
- #inputSampleRate
- #factor
- #offset
- #delay
- #correction
Gain ▸
- Instance members
- #value
- #frequency
Span ▸
- Instance members
- #interval
- #numberSegments
- #maximumTimeTear
DataAvailability ▸
- Instance members
- #extent
- #spanList
Comment ▸
- Instance members
- #id
- #subject
- #value
- #beginEffectiveTime
- #endEffectiveTime
- #authorList
Author ▸
- Instance members
- #name
- #agency
- #email
- #phone
parseStationXml
convertToNetwork
convertToStation
convertToChannel
convertToDataAvailability
convertToComment
convertToAuthor
convertToEquipment
convertToResponse
convertToInstrumentSensitivity
convertToStage
convertToDecimation
convertToGain
createInterval
extractComplex
activeNetworks
allStations
activeStations
allChannels
activeChannels
findChannels
findChannelsForSourceId
uniqueSourceIds
uniqueStations
uniqueNetworks
fetchStationXml
mightBeStatonXml
parseUtil ▸
- Static members
- ._grabFirstEl
- ._grabFirstElText
- ._grabFirstElFloat
- ._grabFirstElInt
- ._grabAttribute
- ._requireAttribute
- ._grabAttributeNS

Need help reading this?

STAXML_MIME

src/stationxml.ts

STAXML_MIME

Type: string

STAML_NS

src/stationxml.ts

xml namespace for stationxml

STAML_NS

Type: string

COUNT_UNIT_NAME

src/stationxml.ts

COUNT_UNIT_NAME

Type: string

FIX_INVALID_STAXML

src/stationxml.ts

FIX_INVALID_STAXML

Type: boolean

INVALID_NUMBER

src/stationxml.ts

INVALID_NUMBER

FAKE_START_DATE

src/stationxml.ts

FAKE_START_DATE

FAKE_EMPTY_XML

src/stationxml.ts

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

FAKE_EMPTY_XML

Type: string

CHANNEL_CLICK_EVENT

src/stationxml.ts

CHANNEL_CLICK_EVENT

Type: string

STATION_CLICK_EVENT

src/stationxml.ts

STATION_CLICK_EVENT

Type: string

ChannelEventDetail

src/stationxml.ts

ChannelEventDetail

StationEventDetail

src/stationxml.ts

StationEventDetail

isChannelClickCustomEvent

src/stationxml.ts

Typescript guard for channelclick CustomEvents.

isChannelClickCustomEvent(event: Event): any

Parameters

event (Event) generic event to ensure is a CustomEvent

Returns

any: true if is correct type

isStationClickCustomEvent

src/stationxml.ts

Typescript guard for stationclick CustomEvents.

isStationClickCustomEvent(event: Event): any

Parameters

event (Event) generic event to ensure is a CustomEvent

Returns

any: true if is correct type

createChannelClickEvent

src/stationxml.ts

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

createChannelClickEvent(sta: Channel, mouseclick: Event): CustomEvent<ChannelEventDetail>

Parameters

sta (Channel) Channel clicked on

mouseclick (Event) original mouse click Event

Returns

CustomEvent<ChannelEventDetail>: CustomEvent populated with channel field in detail.

createStationClickEvent

src/stationxml.ts

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

createStationClickEvent(sta: Station, mouseclick: Event): CustomEvent<StationEventDetail>

Parameters

sta (Station) Station clicked on

mouseclick (Event) original mouse click Event

Returns

CustomEvent<StationEventDetail>: CustomEvent populated with station field in detail.

StationClickEventMap

src/stationxml.ts

StationClickEventMap

Extends HTMLElementEventMap

ChannelClickEventMap

src/stationxml.ts

ChannelClickEventMap

Extends HTMLElementEventMap

Network

src/stationxml.ts

new Network(networkCode: string)

Parameters

networkCode (string)

Instance Members

▸ networkCode

src/stationxml.ts

networkCode

Type: string

▸ _startDate

src/stationxml.ts

_startDate

Type: DateTime

▸ _endDate

src/stationxml.ts

_endDate

Type: (DateTime | null)

▸ restrictedStatus

src/stationxml.ts

restrictedStatus

Type: string

▸ description

src/stationxml.ts

description

Type: string

▸ totalNumberStations

src/stationxml.ts

totalNumberStations

Type: (number | null)

▸ stations

src/stationxml.ts

stations

Type: Array<Station>

▸ sourceId

src/stationxml.ts

sourceId

Type: NetworkSourceId

Returns

NetworkSourceId

▸ startDate

src/stationxml.ts

startDate

Type: DateTime

Returns

DateTime

▸ startDate

src/stationxml.ts

startDate

Type: (DateTime | string)

Parameters

value ((DateTime | string))

▸ endDate

src/stationxml.ts

endDate

Type: (null | DateTime)

Returns

(null | DateTime)

▸ endDate

src/stationxml.ts

endDate

Type: (DateTime | string | null)

Parameters

value ((DateTime | string | null))

▸ timeRange

src/stationxml.ts

timeRange

Type: Interval

Returns

Interval

▸ codes()

src/stationxml.ts

codes(): string

Returns

string

▸ isActiveAt(d?)

src/stationxml.ts

isActiveAt(d: DateTime?): boolean

Parameters

d (DateTime?)

Returns

boolean

▸ isTempNet()

src/stationxml.ts

isTempNet(): boolean

Returns

boolean

Station

src/stationxml.ts

new Station(network: Network, stationCode: string)

Parameters

network (Network)

stationCode (string)

Instance Members

▸ network

src/stationxml.ts

network

Type: Network

▸ stationCode

src/stationxml.ts

stationCode

Type: string

▸ sourceID

src/stationxml.ts

sourceID

Type: (string | null)

▸ restrictedStatus

src/stationxml.ts

restrictedStatus

Type: string

▸ name

src/stationxml.ts

name

Type: string

▸ latitude

src/stationxml.ts

latitude

Type: number

▸ longitude

src/stationxml.ts

longitude

Type: number

▸ elevation

src/stationxml.ts

elevation

Type: number

▸ waterLevel

src/stationxml.ts

waterLevel

Type: (number | null)

▸ comments

src/stationxml.ts

comments

Type: Array<Comment>

▸ equipmentList

src/stationxml.ts

equipmentList

Type: Array<Equipment>

▸ dataAvailability

src/stationxml.ts

dataAvailability

Type: (DataAvailability | null)

▸ identifierList

src/stationxml.ts

identifierList

Type: Array<string>

▸ description

src/stationxml.ts

description

Type: string

▸ geology

src/stationxml.ts

geology

Type: string

▸ vault

src/stationxml.ts

vault

Type: string

▸ channels

src/stationxml.ts

channels

Type: Array<Channel>

▸ sourceId

src/stationxml.ts

sourceId

Type: StationSourceId

Returns

StationSourceId

▸ startDate

src/stationxml.ts

startDate

Type: DateTime

Returns

DateTime

▸ startDate

src/stationxml.ts

startDate

Type: (DateTime | string)

Parameters

value ((DateTime | string))

▸ endDate

src/stationxml.ts

endDate

Type: (DateTime | null)

Returns

(DateTime | null)

▸ endDate

src/stationxml.ts

endDate

Type: (DateTime | string | null)

Parameters

value ((DateTime | string | null))

▸ timeRange

src/stationxml.ts

timeRange

Type: Interval

Returns

Interval

▸ networkCode

src/stationxml.ts

networkCode

Type: string

Returns

string

▸ isActiveAt(d?)

src/stationxml.ts

isActiveAt(d: DateTime?): boolean

Parameters

d (DateTime?)

Returns

boolean

▸ codes(sep)

src/stationxml.ts

codes(sep: any): string

Parameters

sep

(any
            = ".")

Returns

string

Channel

src/stationxml.ts

new Channel(station: Station, channelCode: string, locationCode: string)

Parameters

station (Station)

channelCode (string)

locationCode (string)

Instance Members

▸ station

src/stationxml.ts

station

Type: Station

▸ channelCode

src/stationxml.ts

channelCode

Type: string

▸ restrictedStatus

src/stationxml.ts

restrictedStatus

Type: string

▸ latitude

src/stationxml.ts

latitude

Type: number

▸ longitude

src/stationxml.ts

longitude

Type: number

▸ elevation

src/stationxml.ts

elevation

Type: number

▸ depth

src/stationxml.ts

depth

Type: number

▸ azimuth

src/stationxml.ts

azimuth

Type: number

▸ dip

src/stationxml.ts

dip

Type: number

▸ sampleRate

src/stationxml.ts

sampleRate

Type: number

▸ waterLevel

src/stationxml.ts

waterLevel

▸ comments

src/stationxml.ts

comments

▸ equipmentList

src/stationxml.ts

equipmentList

▸ dataAvailability

src/stationxml.ts

dataAvailability

▸ identifierList

src/stationxml.ts

identifierList

▸ description

src/stationxml.ts

description

▸ response

src/stationxml.ts

response

Type: (Response | null)

▸ sensor

src/stationxml.ts

sensor

Type: (Equipment | null)

▸ preamplifier

src/stationxml.ts

preamplifier

Type: (Equipment | null)

▸ datalogger

src/stationxml.ts

datalogger

Type: (Equipment | null)

▸ sourceId

src/stationxml.ts

sourceId

Type: FDSNSourceId

Returns

FDSNSourceId

▸ sourceId

src/stationxml.ts

sourceId

Type: FDSNSourceId

Parameters

sid (FDSNSourceId)

▸ nslcId

src/stationxml.ts

nslcId

Type: NslcId

Returns

NslcId

▸ startDate

src/stationxml.ts

startDate

Type: DateTime

Returns

DateTime

▸ startDate

src/stationxml.ts

startDate

Type: (DateTime | string)

Parameters

value ((DateTime | string))

▸ endDate

src/stationxml.ts

endDate

Type: (null | DateTime)

Returns

(null | DateTime)

▸ endDate

src/stationxml.ts

endDate

Type: (DateTime | string | null)

Parameters

value ((DateTime | string | null))

▸ timeRange

src/stationxml.ts

timeRange

Type: Interval

Returns

Interval

▸ locationCode

src/stationxml.ts

locationCode

Type: string

Returns

string

▸ locationCode

src/stationxml.ts

locationCode

Type: string

Parameters

value (string)

▸ stationCode

src/stationxml.ts

stationCode

Type: string

Returns

string

▸ networkCode

src/stationxml.ts

networkCode

Type: string

Returns

string

▸ hasInstrumentSensitivity()

src/stationxml.ts

Checks if this channel has sensitivity defined, within the response.

hasInstrumentSensitivity(): boolean

Returns

boolean: true if instrumentSensitivity exits

▸ instrumentSensitivity

src/stationxml.ts

instrumentSensitivity

Type: InstrumentSensitivity

Parameters

value (InstrumentSensitivity)

▸ instrumentSensitivity

src/stationxml.ts

instrumentSensitivity

Type: InstrumentSensitivity

Returns

InstrumentSensitivity

▸ nslc

src/stationxml.ts

return network, station, location and channels codes as one string.

nslc

Type: string

Returns

string: net.sta.loc.chan

▸ codes(sep)

src/stationxml.ts

return network, station, location and channels codes as one string.

codes(sep: any): string

Parameters

sep

(any
            = ".")

separator, defaults to dot '.'

Returns

string: net.sta.loc.chan

▸ isActiveAt(d?)

src/stationxml.ts

isActiveAt(d: DateTime?): boolean

Parameters

d (DateTime?)

Returns

boolean

InstrumentSensitivity

src/stationxml.ts

new InstrumentSensitivity(sensitivity: number, frequency: number, inputUnits: string, outputUnits: string)

Parameters

sensitivity (number)

frequency (number)

inputUnits (string)

outputUnits (string)

Instance Members

▸ sensitivity

src/stationxml.ts

sensitivity

Type: number

▸ frequency

src/stationxml.ts

frequency

Type: number

▸ inputUnits

src/stationxml.ts

inputUnits

Type: string

▸ outputUnits

src/stationxml.ts

outputUnits

Type: string

Equipment

src/stationxml.ts

new Equipment()

Instance Members

▸ resourceId

src/stationxml.ts

resourceId

Type: string

▸ type

src/stationxml.ts

type

Type: string

▸ description

src/stationxml.ts

description

Type: string

▸ manufacturer

src/stationxml.ts

manufacturer

Type: string

▸ vendor

src/stationxml.ts

vendor

Type: string

▸ model

src/stationxml.ts

model

Type: string

▸ serialNumber

src/stationxml.ts

serialNumber

Type: string

▸ installationDate

src/stationxml.ts

installationDate

Type: (DateTime | null)

▸ removalDate

src/stationxml.ts

removalDate

Type: (DateTime | null)

▸ calibrationDateList

src/stationxml.ts

calibrationDateList

Type: Array<DateTime>

Response

src/stationxml.ts

new Response(instrumentSensitivity: InstrumentSensitivity?, stages: Array<Stage>?)

Parameters

instrumentSensitivity (InstrumentSensitivity?)

stages (Array<Stage>?)

Instance Members

▸ instrumentSensitivity

src/stationxml.ts

instrumentSensitivity

Type: (InstrumentSensitivity | null)

▸ stages

src/stationxml.ts

stages

Type: Array<Stage>

Stage

src/stationxml.ts

new Stage(filter: (AbstractFilterType | null), decimation: (Decimation | null), gain: Gain)

Parameters

filter ((AbstractFilterType | null))

decimation ((Decimation | null))

gain (Gain)

Instance Members

▸ filter

src/stationxml.ts

filter

Type: (AbstractFilterType | null)

▸ decimation

src/stationxml.ts

decimation

Type: (Decimation | null)

▸ gain

src/stationxml.ts

gain

Type: Gain

AbstractFilterType

src/stationxml.ts

new AbstractFilterType(inputUnits: string, outputUnits: string)

Parameters

inputUnits (string)

outputUnits (string)

Instance Members

▸ inputUnits

src/stationxml.ts

inputUnits

Type: string

▸ outputUnits

src/stationxml.ts

outputUnits

Type: string

▸ name

src/stationxml.ts

name

Type: string

▸ description

src/stationxml.ts

description

Type: string

PolesZeros

src/stationxml.ts

new PolesZeros(inputUnits: string, outputUnits: string)

Extends AbstractFilterType

Parameters

inputUnits (string)

outputUnits (string)

Instance Members

▸ pzTransferFunctionType

src/stationxml.ts

pzTransferFunctionType

Type: string

▸ normalizationFactor

src/stationxml.ts

normalizationFactor

Type: number

▸ normalizationFrequency

src/stationxml.ts

normalizationFrequency

Type: number

▸ zeros

src/stationxml.ts

zeros

Type: Array<InstanceType<any>>

▸ poles

src/stationxml.ts

poles

Type: Array<InstanceType<any>>

FIR

src/stationxml.ts

new FIR(inputUnits: string, outputUnits: string)

Extends AbstractFilterType

Parameters

inputUnits (string)

outputUnits (string)

Instance Members

▸ symmetry

src/stationxml.ts

symmetry

Type: string

▸ numerator

src/stationxml.ts

numerator

Type: Array<number>

CoefficientsFilter

src/stationxml.ts

new CoefficientsFilter(inputUnits: string, outputUnits: string)

Extends AbstractFilterType

Parameters

inputUnits (string)

outputUnits (string)

Instance Members

▸ cfTransferFunction

src/stationxml.ts

cfTransferFunction

Type: string

▸ numerator

src/stationxml.ts

numerator

Type: Array<number>

▸ denominator

src/stationxml.ts

denominator

Type: Array<number>

Decimation

src/stationxml.ts

new Decimation(inputSampleRate: number, factor: number)

Parameters

inputSampleRate (number)

factor (number)

Instance Members

▸ inputSampleRate

src/stationxml.ts

inputSampleRate

Type: number

▸ factor

src/stationxml.ts

factor

Type: number

▸ offset

src/stationxml.ts

offset

Type: (number | null | undefined)

▸ delay

src/stationxml.ts

delay

Type: (number | null | undefined)

▸ correction

src/stationxml.ts

correction

Type: (number | null | undefined)

Gain

src/stationxml.ts

new Gain(value: number, frequency: number)

Parameters

value (number)

frequency (number)

Instance Members

▸ value

src/stationxml.ts

value

Type: number

▸ frequency

src/stationxml.ts

frequency

Type: number

Span

src/stationxml.ts

new Span(interval: Interval)

Parameters

interval (Interval)

Instance Members

▸ interval

src/stationxml.ts

interval

Type: Interval

▸ numberSegments

src/stationxml.ts

numberSegments

▸ maximumTimeTear

src/stationxml.ts

maximumTimeTear

Type: (number | null)

DataAvailability

src/stationxml.ts

new DataAvailability()

Instance Members

▸ extent

src/stationxml.ts

extent

Type: (Interval | null)

▸ spanList

src/stationxml.ts

spanList

Type: Array<Span>

Comment

src/stationxml.ts

new Comment(value: string)

Parameters

value (string)

Instance Members

▸ id

src/stationxml.ts

▸ subject

src/stationxml.ts

subject

▸ value

src/stationxml.ts

value

Type: string

▸ beginEffectiveTime

src/stationxml.ts

beginEffectiveTime

▸ endEffectiveTime

src/stationxml.ts

endEffectiveTime

▸ authorList

src/stationxml.ts

authorList

Author

src/stationxml.ts

new Author()

Instance Members

▸ name

src/stationxml.ts

name

▸ agency

src/stationxml.ts

agency

▸ email

src/stationxml.ts

▸ phone

src/stationxml.ts

phone

parseStationXml

src/stationxml.ts

Parses the FDSN StationXML returned from a query.

parseStationXml(rawXml: Document): Array<Network>

Parameters

rawXml (Document) parsed xml to extract objects from

Returns

Array<Network>: an Array of Network objects.

convertToNetwork

src/stationxml.ts

Parses a FDSNStationXML Network xml element into a Network object.

convertToNetwork(xml: Element): Network

Parameters

xml (Element) the network xml Element

Returns

Network: Network instance

convertToStation

src/stationxml.ts

Parses a FDSNStationXML Station xml element into a Station object.

convertToStation(network: Network, xml: Element): Station

Parameters

network (Network) the containing network

xml (Element) the station xml Element

Returns

Station: Station instance

convertToChannel

src/stationxml.ts

Parses a FDSNStationXML Channel xml element into a Channel object.

convertToChannel(station: Station, xml: Element): Channel

Parameters

station (Station) the containing staton

xml (Element) the channel xml Element

Returns

Channel: Channel instance

convertToDataAvailability

src/stationxml.ts

convertToDataAvailability(xml: Element): DataAvailability

Parameters

xml (Element)

Returns

DataAvailability

convertToComment

src/stationxml.ts

convertToComment(xml: Element): Comment

Parameters

xml (Element)

Returns

Comment

convertToAuthor

src/stationxml.ts

convertToAuthor(xml: Element): Author

Parameters

xml (Element)

Returns

Author

convertToEquipment

src/stationxml.ts

convertToEquipment(xml: Element): Equipment

Parameters

xml (Element)

Returns

Equipment

convertToResponse

src/stationxml.ts

Parses a FDSNStationXML Response xml element into a Response object.

convertToResponse(responseXml: Element): Response

Parameters

responseXml (Element) the response xml Element

Returns

Response: Response instance

convertToInstrumentSensitivity

src/stationxml.ts

Parses a FDSNStationXML InstrumentSensitivity xml element into a InstrumentSensitivity object.

convertToInstrumentSensitivity(xml: Element): InstrumentSensitivity

Parameters

xml (Element) the InstrumentSensitivity xml Element

Returns

InstrumentSensitivity: InstrumentSensitivity instance

convertToStage

src/stationxml.ts

Parses a FDSNStationXML Stage xml element into a Stage object.

convertToStage(stageXml: Element): Stage

Parameters

stageXml (Element) the Stage xml Element

Returns

Stage: Stage instance

convertToDecimation

src/stationxml.ts

Parses a FDSNStationXML Decimation xml element into a Decimation object.

convertToDecimation(decXml: Element): Decimation

Parameters

decXml (Element) the Decimation xml Element

Returns

Decimation: Decimation instance

convertToGain

src/stationxml.ts

Parses a FDSNStationXML Gain xml element into a Gain object.

convertToGain(gainXml: Element): Gain

Parameters

gainXml (Element) the Gain xml Element

Returns

Gain: Gain instance

createInterval

src/stationxml.ts

createInterval(start: DateTime, end: (null | DateTime)): Interval

Parameters

start (DateTime)

end ((null | DateTime))

Returns

Interval

extractComplex

src/stationxml.ts

Extracts a complex number from an stationxml element.

extractComplex(el: Element): InstanceType<any>

Parameters

el (Element) xml element

Returns

InstanceType<any>: Complex instance

activeNetworks

src/stationxml.ts

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

activeNetworks(networks: Array<Network>, atTime: DateTime?): Generator<Network, void, any>

Parameters

networks (Array<Network>) array of Networks

atTime (DateTime?) time for station to be active, defaults to now

Returns

Generator<Network, void, any>

allStations

src/stationxml.ts

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

allStations(networks: Array<Network>): Generator<Station, void, any>

Parameters

networks (Array<Network>) array of Networks

Returns

Generator<Station, void, any>

activeStations

src/stationxml.ts

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

activeStations(networks: Array<Network>, atTime: DateTime?): Generator<Station, void, any>

Parameters

networks (Array<Network>) array of Networks

atTime (DateTime?) time for station to be active, defaults to now

Returns

Generator<Station, void, any>

allChannels

src/stationxml.ts

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

allChannels(networks: Array<Network>): Generator<Channel, void, any>

Parameters

networks (Array<Network>) array of Networks

Returns

Generator<Channel, void, any>

activeChannels

src/stationxml.ts

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

activeChannels(networks: Array<Network>, atTime: DateTime?): Generator<Channel, void, any>

Parameters

networks (Array<Network>) array of Networks

atTime (DateTime?) time for channel to be active, defaults to now

Returns

Generator<Channel, void, any>

findChannels

src/stationxml.ts

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: Array<Network>, netCode: string, staCode: string, locCode: string, chanCode: string): Generator<Channel, void, any>

Parameters

networks (Array<Network>) Array of networks.

netCode

(string
            = ".*")

network code to match, defaults to .*

staCode

(string
            = ".*")

station code to match, defaults to .*

locCode

(string
            = ".*")

location code to match, defaults to .*

chanCode

(string
            = ".*")

channel code to match, defaults to .*

Returns

Generator<Channel, void, any>

findChannelsForSourceId

src/stationxml.ts

findChannelsForSourceId(networks: Array<Network>, sid: FDSNSourceId): Generator<Channel, void, any>

Parameters

networks (Array<Network>)

sid (FDSNSourceId)

Returns

Generator<Channel, void, any>

uniqueSourceIds

src/stationxml.ts

uniqueSourceIds(channelList: Iterable<Channel>): Array<FDSNSourceId>

Parameters

channelList (Iterable<Channel>)

Returns

Array<FDSNSourceId>

uniqueStations

src/stationxml.ts

uniqueStations(channelList: Iterable<Channel>): Array<Station>

Parameters

channelList (Iterable<Channel>)

Returns

Array<Station>

uniqueNetworks

src/stationxml.ts

uniqueNetworks(channelList: Iterable<(Channel | Station)>): Array<Network>

Parameters

channelList (Iterable<(Channel | Station)>)

Returns

Array<Network>

fetchStationXml

src/stationxml.ts

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: (string | URL), timeoutSec: any, nodata: any): Promise<Array<Network>>

Parameters

url ((string | URL)) the url to download from

timeoutSec

(any
            = 10)

timeout in case of failed connection

nodata

(any
            = 204)

http code for no data

Returns

Promise<Array<Network>>: Promise to parsed StationXML as an Network array

mightBeStatonXml

src/stationxml.ts

mightBeStatonXml(buf: ArrayBufferLike)

Parameters

buf (ArrayBufferLike)

parseUtil

src/stationxml.ts

parseUtil

Static Members

▸ _grabFirstEl

src/stationxml.ts

_grabFirstEl

▸ _grabFirstElText

src/stationxml.ts

_grabFirstElText

▸ _grabFirstElFloat

src/stationxml.ts

_grabFirstElFloat

▸ _grabFirstElInt

src/stationxml.ts

_grabFirstElInt

▸ _grabAttribute

src/stationxml.ts

_grabAttribute

▸ _requireAttribute

src/stationxml.ts

_requireAttribute

▸ _grabAttributeNS

src/stationxml.ts

_grabAttributeNS