seisplotjs

3.1.1
Need help reading this?

STAML_NS

xml namespace for stationxml

STAML_NS

Type: string

COUNT_UNIT_NAME

COUNT_UNIT_NAME

Type: string

FIX_INVALID_STAXML

FIX_INVALID_STAXML

Type: boolean

INVALID_NUMBER

INVALID_NUMBER

FAKE_START_DATE

FAKE_START_DATE

CHANNEL_CLICK_EVENT

CHANNEL_CLICK_EVENT

Type: string

STATION_CLICK_EVENT

STATION_CLICK_EVENT

Type: string

createChannelClickEvent

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

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

createStationClickEvent

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

createStationClickEvent(sta: Station, mouseclick: Event): CustomEvent
Parameters
sta (Station) Station clicked on
mouseclick (Event) original mouse click Event
Returns
CustomEvent: CustomEvent populated with station field in detail.

Network

new Network(networkCode: string)
Parameters
networkCode (string)
Instance Members
▸ networkCode
▸ _startDate
▸ _endDate
▸ restrictedStatus
▸ description
▸ totalNumberStations
▸ stations
▸ sourceId
▸ startDate
▸ startDate
▸ endDate
▸ endDate
▸ timeRange
▸ codes()
▸ isActiveAt(d?)
▸ isTempNet()

Station

new Station(network: Network, stationCode: string)
Parameters
network (Network)
stationCode (string)
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(d?)
▸ codes(sep)

Channel

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
▸ dip
▸ sampleRate
▸ waterLevel
▸ comments
▸ equipmentList
▸ dataAvailability
▸ identifierList
▸ description
▸ response
▸ sensor
▸ preamplifier
▸ datalogger
▸ sourceId
▸ nslcId
▸ startDate
▸ startDate
▸ endDate
▸ endDate
▸ timeRange
▸ locationCode
▸ locationCode
▸ stationCode
▸ networkCode
▸ hasInstrumentSensitivity()
▸ instrumentSensitivity
▸ instrumentSensitivity
▸ nslc
▸ codes(sep)
▸ isActiveAt(d?)

InstrumentSensitivity

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

Equipment

new Equipment()
Instance Members
▸ resourceId
▸ type
▸ description
▸ manufacturer
▸ vendor
▸ model
▸ serialNumber
▸ installationDate
▸ removalDate
▸ calibrationDateList

Response

new Response(instrumentSensitivity: InstrumentSensitivity?, stages: Array<Stage>?)
Parameters
instrumentSensitivity (InstrumentSensitivity?)
stages (Array<Stage>?)
Instance Members
▸ instrumentSensitivity
▸ stages

Stage

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

new AbstractFilterType(inputUnits: string, outputUnits: string)
Parameters
inputUnits (string)
outputUnits (string)
Instance Members
▸ inputUnits
▸ outputUnits
▸ name
▸ description

PolesZeros

new PolesZeros(inputUnits: string, outputUnits: string)

Extends AbstractFilterType

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

FIR

new FIR(inputUnits: string, outputUnits: string)

Extends AbstractFilterType

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

CoefficientsFilter

new CoefficientsFilter(inputUnits: string, outputUnits: string)

Extends AbstractFilterType

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

Decimation

new Decimation(inputSampleRate: number, factor: number)
Parameters
inputSampleRate (number)
factor (number)
Instance Members
▸ inputSampleRate
▸ factor
▸ offset
▸ delay
▸ correction

Gain

new Gain(value: number, frequency: number)
Parameters
value (number)
frequency (number)
Instance Members
▸ value
▸ frequency

Span

new Span(interval: Interval)
Parameters
interval (Interval)
Instance Members
▸ interval
▸ numberSegments
▸ maximumTimeTear

DataAvailability

new DataAvailability()
Instance Members
▸ extent
▸ spanList

Comment

new Comment(value: string)
Parameters
value (string)
Instance Members
▸ id
▸ subject
▸ value
▸ beginEffectiveTime
▸ endEffectiveTime
▸ authorList

Author

new Author()
Instance Members
▸ name
▸ agency
▸ email
▸ phone

parseStationXml

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

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

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

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

convertToDataAvailability(xml: Element): DataAvailability
Parameters
xml (Element)
Returns
DataAvailability

convertToComment

convertToComment(xml: Element): Comment
Parameters
xml (Element)
Returns
Comment

convertToAuthor

convertToAuthor(xml: Element): Author
Parameters
xml (Element)
Returns
Author

convertToEquipment

convertToEquipment(xml: Element): Equipment
Parameters
xml (Element)
Returns
Equipment

convertToResponse

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

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

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

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

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

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

extractComplex

Extracts a complex number from an stationxml element.

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

allStations

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>

allChannels

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>

findChannels

Extract all channels from all stations from all networks in the input array. Regular expressions may be used instaed 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
staCode (string) station code to match
locCode (string) location code to match
chanCode (string) channel code to match
Returns
Generator<Channel, void, any>

uniqueSourceIds

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

uniqueStations

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

uniqueNetworks

uniqueNetworks(channelList: Iterable<Channel>): Array<Network>
Parameters
channelList (Iterable<Channel>)
Returns
Array<Network>

parseUtil

parseUtil
Static Members
▸ _grabFirstEl
▸ _grabFirstElText
▸ _grabFirstElFloat
▸ _grabFirstElInt
▸ _grabAttribute
▸ _requireAttribute
▸ _grabAttributeNS