seisplotjs.stationxml

2.0.0
Need help reading this?

STAML_NS

src/stationxml.js

xml namespace for stationxml

STAML_NS

Type: string

Network

src/stationxml.js
new Network(networkCode: string)
Parameters
networkCode (string)
Instance Members
▸ networkCode
▸ _startDate
▸ _endDate
▸ restrictedStatus
▸ description
▸ totalNumberStations
▸ stations
▸ startDate
▸ startDate
▸ endDate
▸ endDate
▸ timeRange
▸ codes()
▸ isTempNet()

Station

src/stationxml.js
new Station(network: Network, stationCode: string)
Parameters
network (Network)
stationCode (string)
Instance Members
▸ network
▸ stationCode
▸ restrictedStatus
▸ latitude
▸ longitude
▸ elevation
▸ channels
▸ startDate
▸ startDate
▸ endDate
▸ endDate
▸ timeRange
▸ networkCode
▸ codes()

Channel

src/stationxml.js
new Channel(station: Station, channelCode: string, locationCode: string)
Parameters
station (Station)
channelCode (string)
locationCode (string)
Instance Members
▸ station
▸ channelCode
▸ restrictedStatus
▸ latitude
▸ longitude
▸ elevation
▸ depth
▸ azimuth
▸ sampleRate
▸ response
▸ startDate
▸ startDate
▸ endDate
▸ endDate
▸ timeRange
▸ locationCode
▸ locationCode
▸ stationCode
▸ networkCode
▸ hasInstrumentSensitivity()
▸ instrumentSensitivity
▸ instrumentSensitivity
▸ codes()

InstrumentSensitivity

src/stationxml.js
new InstrumentSensitivity(sensitivity: number, frequency: number, inputUnits: string, outputUnits: string)
Parameters
sensitivity (number)
frequency (number)
inputUnits (string)
outputUnits (string)
Instance Members
▸ sensitivity
▸ frequency
▸ inputUnits
▸ outputUnits

Response

src/stationxml.js
new Response(instrumentSensitivity: InstrumentSensitivity?, stages: Array<Stage>?)
Parameters
instrumentSensitivity (InstrumentSensitivity?)
stages (Array<Stage>?)
Instance Members
▸ instrumentSensitivity
▸ stages

Stage

src/stationxml.js
new Stage(filter: (AbstractFilterType | null), decimation: (Decimation | null), gain: Gain)
Parameters
filter ((AbstractFilterType | null))
decimation ((Decimation | null))
gain (Gain)
Instance Members
▸ filter
▸ decimation
▸ gain

AbstractFilterType

src/stationxml.js
new AbstractFilterType(inputUnits: string, outputUnits: string)
Parameters
inputUnits (string)
outputUnits (string)
Instance Members
▸ inputUnits
▸ outputUnits
▸ description

PolesZeros

src/stationxml.js
new PolesZeros(inputUnits: string, outputUnits: string)

Extends AbstractFilterType

Parameters
inputUnits (string)
outputUnits (string)
Instance Members
▸ pzTransferFunctionType
▸ normalizationFactor
▸ normalizationFrequency
▸ zeros
▸ poles

FIR

src/stationxml.js
new FIR(inputUnits: string, outputUnits: string)

Extends AbstractFilterType

Parameters
inputUnits (string)
outputUnits (string)
Instance Members
▸ symmetry
▸ numerator

CoefficientsFilter

src/stationxml.js
new CoefficientsFilter(inputUnits: string, outputUnits: string)

Extends AbstractFilterType

Parameters
inputUnits (string)
outputUnits (string)
Instance Members
▸ cfTransferFunction
▸ numerator
▸ denominator

Decimation

src/stationxml.js
new Decimation()
Instance Members
▸ inputSampleRate
▸ factor
▸ offset
▸ delay
▸ correction

Gain

src/stationxml.js
new Gain()
Instance Members
▸ value
▸ frequency

parseStationXml

src/stationxml.js

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.js

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.js

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.js

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

convertToResponse

src/stationxml.js

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.js

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.js

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.js

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.js

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

extractComplex

src/stationxml.js

Extracts a complex number from an stationxml element.

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

allStations

src/stationxml.js

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

allStations(networks: Array<Network>): void
Parameters
networks (Array<Network>) array of Networks
Returns
void

allChannels

src/stationxml.js

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

allChannels(networks: Array<Network>): void
Parameters
networks (Array<Network>) array of Networks
Returns
void

findChannels

src/stationxml.js

Extract all channels from all stations from all networks in the input array.

findChannels(networks: Array<Network>, netCode: string, staCode: string, locCode: string, chanCode: string): void
Parameters
networks (Array<Network>) Array of networks.
netCode (string) network code to match
staCode (string) station code to match
locCode (string) location code to match
chanCode (string) channel code to match
Returns
void

parseUtil

src/stationxml.js
parseUtil
Static Members
▸ _grabFirstEl
▸ _grabFirstElText
▸ _grabFirstElFloat
▸ _grabFirstElInt
▸ _grabAttribute
▸ _grabAttributeNS