Network

src/stationxml.js

new Network(networkCode: string)

Parameters

networkCode (string)

Instance Members

▸ networkCode(value)

src/stationxml.js

gets or sets the networkCode.

networkCode(value: string): (string | Network)

Parameters

value (string) set the networkCode

Returns

(string | Network): Network if a value is passed in, networkCode if no arguments

▸ startDate(value)

src/stationxml.js

gets or sets the startDate.

startDate(value: (moment | string)): (moment | Network)

Parameters

value ((moment | string)) set the startDate

Returns

(moment | Network): Network if a value is passed in, startDate if no arguments

▸ endDate(value)

src/stationxml.js

endDate(value: moment): (moment | Network)

Parameters

value (moment)

Returns

(moment | Network)

▸ restrictedStatus(value)

src/stationxml.js

restrictedStatus(value: string): (string | Network)

Parameters

value (string)

Returns

(string | Network)

▸ description(value)

src/stationxml.js

description(value: string): (string | Network)

Parameters

value (string)

Returns

(string | Network)

▸ stations(value)

src/stationxml.js

stations(value: Array<Station>): (Array<Station> | Network)

Parameters

value (Array<Station>)

Returns

(Array<Station> | Network)

▸ codes()

src/stationxml.js

codes(): string

Returns

string

▸ isTempNet()

src/stationxml.js

isTempNet(): boolean

Returns

boolean

Station

src/stationxml.js

new Station(network: Network, stationCode: string)

Parameters

network (Network)

stationCode (string)

Instance Members

▸ network(value)

src/stationxml.js

Gets or sets the network.

network(value: Network): (Network | Station)

Parameters

value (Network)

Returns

(Network | Station)

▸ stationCode(value)

src/stationxml.js

stationCode(value: string): (string | Station)

Parameters

value (string)

Returns

(string | Station)

▸ startDate(value)

src/stationxml.js

startDate(value: moment): (moment | Station)

Parameters

value (moment)

Returns

(moment | Station)

▸ endDate(value)

src/stationxml.js

endDate(value: moment): (moment | Station)

Parameters

value (moment)

Returns

(moment | Station)

▸ restrictedStatus(value)

src/stationxml.js

restrictedStatus(value: string): (string | Station)

Parameters

value (string)

Returns

(string | Station)

▸ name(value)

src/stationxml.js

name(value: string): (string | Station)

Parameters

value (string)

Returns

(string | Station)

▸ latitude(value)

src/stationxml.js

latitude(value: number): (number | Station)

Parameters

value (number)

Returns

(number | Station)

▸ longitude(value)

src/stationxml.js

longitude(value: number): (number | Station)

Parameters

value (number)

Returns

(number | Station)

▸ elevation(value)

src/stationxml.js

elevation(value: number): (number | Station)

Parameters

value (number)

Returns

(number | Station)

▸ channels(value)

src/stationxml.js

channels(value: Array<Channel>): (Array<Channel> | Station)

Parameters

value (Array<Channel>)

Returns

(Array<Channel> | Station)

▸ codes()

src/stationxml.js

codes(): string

Returns

string

Channel

src/stationxml.js

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

Parameters

station (Station)

channelCode (string)

locationCode (string)

Instance Members

▸ station(value)

src/stationxml.js

station(value: Station): (Station | Channel)

Parameters

value (Station)

Returns

(Station | Channel)

▸ channelCode(value)

src/stationxml.js

channelCode(value: string): (string | Channel)

Parameters

value (string)

Returns

(string | Channel)

▸ locationCode(value)

src/stationxml.js

locationCode(value: string): (string | Channel)

Parameters

value (string)

Returns

(string | Channel)

▸ locationId(value)

src/stationxml.js

locationId(value: string): (string | Channel)

Parameters

value (string)

Returns

(string | Channel)

▸ startDate(value)

src/stationxml.js

startDate(value: moment): (moment | Channel)

Parameters

value (moment)

Returns

(moment | Channel)

▸ endDate(value)

src/stationxml.js

endDate(value: moment): (moment | Channel)

Parameters

value (moment)

Returns

(moment | Channel)

▸ restrictedStatus(value)

src/stationxml.js

restrictedStatus(value: string): (string | Channel)

Parameters

value (string)

Returns

(string | Channel)

▸ latitude(value)

src/stationxml.js

latitude(value: number): (number | Channel)

Parameters

value (number)

Returns

(number | Channel)

▸ longitude(value)

src/stationxml.js

longitude(value: number): (number | Channel)

Parameters

value (number)

Returns

(number | Channel)

▸ elevation(value)

src/stationxml.js

elevation(value: number): (number | Channel)

Parameters

value (number)

Returns

(number | Channel)

▸ depth(value)

src/stationxml.js

depth(value: number): (number | Channel)

Parameters

value (number)

Returns

(number | Channel)

▸ azimuth(value)

src/stationxml.js

azimuth(value: number): (number | Channel)

Parameters

value (number)

Returns

(number | Channel)

▸ dip(value)

src/stationxml.js

dip(value: number): (number | Channel)

Parameters

value (number)

Returns

(number | Channel)

▸ sampleRate(value)

src/stationxml.js

sampleRate(value: number): (number | Channel)

Parameters

value (number)

Returns

(number | Channel)

▸ instrumentSensitivity(value)

src/stationxml.js

instrumentSensitivity(value: InstrumentSensitivity): (InstrumentSensitivity | Channel)

Parameters

value (InstrumentSensitivity)

Returns

(InstrumentSensitivity | Channel)

▸ response(value)

src/stationxml.js

response(value: Response): (Response | Channel)

Parameters

value (Response)

Returns

(Response | Channel)

▸ codes()

src/stationxml.js

codes(): string

Returns

string

Response

src/stationxml.js

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

Parameters

instrumentSensitivity (InstrumentSensitivity)

stages (Array<Stage>)

Instance Members

▸ instrumentSensitivity(value)

src/stationxml.js

instrumentSensitivity(value: InstrumentSensitivity)

Parameters

value (InstrumentSensitivity)

▸ stages(value)

src/stationxml.js

stages(value: Array<Stage>)

Parameters

value (Array<Stage>)

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(value)

src/stationxml.js

sensitivity(value: number): (number | InstrumentSensitivity)

Parameters

value (number)

Returns

(number | InstrumentSensitivity)

▸ frequency(value)

src/stationxml.js

frequency(value: number): (number | InstrumentSensitivity)

Parameters

value (number)

Returns

(number | InstrumentSensitivity)

▸ inputUnits(value)

src/stationxml.js

inputUnits(value: string): (string | InstrumentSensitivity)

Parameters

value (string)

Returns

(string | InstrumentSensitivity)

▸ outputUnits(value)

src/stationxml.js

outputUnits(value: string): (string | InstrumentSensitivity)

Parameters

value (string)

Returns

(string | InstrumentSensitivity)

AbstractFilterType

src/stationxml.js

new AbstractFilterType(inputUnits: string, outputUnits: string)

Parameters

inputUnits (string)

outputUnits (string)

Instance Members

▸ name(value)

src/stationxml.js

name(value: string)

Parameters

value (string)

▸ description(value)

src/stationxml.js

description(value: string)

Parameters

value (string)

▸ inputUnits(value)

src/stationxml.js

inputUnits(value: string)

Parameters

value (string)

▸ outputUnits(value)

src/stationxml.js

outputUnits(value: string)

Parameters

value (string)

Stage

src/stationxml.js

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

Parameters

filter (AbstractFilterType)

decimation ((Decimation | null))

gain (Gain)

Instance Members

▸ filter(value)

src/stationxml.js

filter(value: AbstractFilterType)

Parameters

value (AbstractFilterType)

▸ decimation(value)

src/stationxml.js

decimation(value: Decimation)

Parameters

value (Decimation)

▸ gain(value)

src/stationxml.js

gain(value: Gain)

Parameters

value (Gain)

PolesZeros

src/stationxml.js

new PolesZeros(inputUnits: string, outputUnits: string)

Extends AbstractFilterType

Parameters

inputUnits (string)

outputUnits (string)

Instance Members

▸ pzTransferFunctionType(value)

src/stationxml.js

pzTransferFunctionType(value: string)

Parameters

value (string)

▸ normalizationFactor(value)

src/stationxml.js

normalizationFactor(value: number)

Parameters

value (number)

▸ normalizationFrequency(value)

src/stationxml.js

normalizationFrequency(value: number)

Parameters

value (number)

▸ zeros(value)

src/stationxml.js

zeros(value: Array<ComplexType>)

Parameters

value (Array<ComplexType>)

▸ poles(value)

src/stationxml.js

poles(value: Array<ComplexType>)

Parameters

value (Array<ComplexType>)

FIR

src/stationxml.js

new FIR(inputUnits: string, outputUnits: string)

Extends AbstractFilterType

Parameters

inputUnits (string)

outputUnits (string)

Instance Members

▸ symmetry(value)

src/stationxml.js

symmetry(value: string)

Parameters

value (string)

▸ numerator(value)

src/stationxml.js

numerator(value: Array<number>)

Parameters

value (Array<number>)

CoefficientsFilter

src/stationxml.js

new CoefficientsFilter(inputUnits: string, outputUnits: string)

Extends AbstractFilterType

Parameters

inputUnits (string)

outputUnits (string)

Instance Members

▸ cfTransferFunction(value)

src/stationxml.js

cfTransferFunction(value: string)

Parameters

value (string)

▸ numerator(value)

src/stationxml.js

numerator(value: Array<number>)

Parameters

value (Array<number>)

▸ denominator(value)

src/stationxml.js

denominator(value: Array<number>)

Parameters

value (Array<number>)

Decimation

src/stationxml.js

new Decimation()

Instance Members

▸ inputSampleRate(value)

src/stationxml.js

inputSampleRate(value: number)

Parameters

value (number)

▸ factor(value)

src/stationxml.js

factor(value: number)

Parameters

value (number)

▸ offset(value)

src/stationxml.js

offset(value: number)

Parameters

value (number)

▸ delay(value)

src/stationxml.js

delay(value: number)

Parameters

value (number)

▸ correction(value)

src/stationxml.js

correction(value: number)

Parameters

value (number)

Gain

src/stationxml.js

new Gain()

Instance Members

▸ value(value)

src/stationxml.js

value(value: number)

Parameters

value (number)

▸ frequency(value)

src/stationxml.js

frequency(value: number)

Parameters

value (number)

Quake

src/quakeml.js

Represent a QuakeML Event. Renamed to Quake as Event conflicts with other uses in javascript.

new Quake()

Instance Members

▸ eventid(value)

src/quakeml.js

eventid(value: string): (string | Quake)

Parameters

value (string)

Returns

(string | Quake)

▸ publicID(value)

src/quakeml.js

publicID(value: string): (string | Quake)

Parameters

value (string)

Returns

(string | Quake)

▸ time(value)

src/quakeml.js

time(value: moment): (moment | Quake)

Parameters

value (moment)

Returns

(moment | Quake)

▸ latitude(value)

src/quakeml.js

latitude(value: number): (number | Quake)

Parameters

value (number)

Returns

(number | Quake)

▸ longitude(value)

src/quakeml.js

longitude(value: number): (number | Quake)

Parameters

value (number)

Returns

(number | Quake)

▸ depth(value)

src/quakeml.js

depth(value: number): (number | Quake)

Parameters

value (number)

Returns

(number | Quake)

▸ description(value)

src/quakeml.js

description(value: string): (string | Quake)

Parameters

value (string)

Returns

(string | Quake)

▸ magnitude(value)

src/quakeml.js

magnitude(value: Magnitude): (Magnitude | Quake)

Parameters

value (Magnitude)

Returns

(Magnitude | Quake)

▸ originList(value)

src/quakeml.js

originList(value: Array<Origin>): (Array<Origin> | Quake)

Parameters

value (Array<Origin>)

Returns

(Array<Origin> | Quake)

▸ magnitudeList(value)

src/quakeml.js

magnitudeList(value: Array<Magnitude>): (Array<Magnitude> | Quake)

Parameters

value (Array<Magnitude>)

Returns

(Array<Magnitude> | Quake)

▸ arrivals(value)

src/quakeml.js

arrivals(value: Array<Arrival>): (Array<Arrival> | Quake)

Parameters

value (Array<Arrival>)

Returns

(Array<Arrival> | Quake)

▸ arrivalList(value)

src/quakeml.js

arrivalList(value: Array<Arrival>): (Array<Arrival> | Quake)

Parameters

value (Array<Arrival>)

Returns

(Array<Arrival> | Quake)

▸ picks(value)

src/quakeml.js

picks(value: Array<Pick>): (Array<Pick> | Quake)

Parameters

value (Array<Pick>)

Returns

(Array<Pick> | Quake)

▸ pickList(value)

src/quakeml.js

pickList(value: Array<Pick>): (Array<Pick> | Quake)

Parameters

value (Array<Pick>)

Returns

(Array<Pick> | Quake)

▸ toString()

src/quakeml.js

toString()

Origin

src/quakeml.js

Represents a QuakeML Origin.

new Origin()

Instance Members

▸ time(value)

src/quakeml.js

time(value: moment): (moment | Origin)

Parameters

value (moment)

Returns

(moment | Origin)

▸ latitude(value)

src/quakeml.js

latitude(value: number): (number | Origin)

Parameters

value (number)

Returns

(number | Origin)

▸ longitude(value)

src/quakeml.js

longitude(value: number): (number | Origin)

Parameters

value (number)

Returns

(number | Origin)

▸ depth(value)

src/quakeml.js

depth(value: number): (number | Origin)

Parameters

value (number)

Returns

(number | Origin)

▸ toString()

src/quakeml.js

toString()

Magnitude

src/quakeml.js

Represents a QuakeML Magnitude.

new Magnitude(mag: number, type: string)

Parameters

mag (number)

type (string)

Instance Members

▸ mag(value)

src/quakeml.js

mag(value: number): (number | Magnitude)

Parameters

value (number)

Returns

(number | Magnitude)

▸ type(value)

src/quakeml.js

type(value: string): (string | Magnitude)

Parameters

value (string)

Returns

(string | Magnitude)

▸ toString()

src/quakeml.js

toString()

Arrival

src/quakeml.js

Represents a QuakeML Arrival, a combination of a Pick with a phase name.

new Arrival(phase: string, pick: Pick)

Parameters

phase (string)

pick (Pick)

Instance Members

▸ phase(value)

src/quakeml.js

phase(value: string): (string | Arrival)

Parameters

value (string)

Returns

(string | Arrival)

▸ publicID(value)

src/quakeml.js

publicID(value: string): (string | Arrival)

Parameters

value (string)

Returns

(string | Arrival)

▸ pick(value)

src/quakeml.js

pick(value: Pick): (Pick | Arrival)

Parameters

value (Pick)

Returns

(Pick | Arrival)

Pick

src/quakeml.js

Represents a QuakeML Pick.

new Pick(time: moment, networkCode: string, stationCode: string, locationCode: string, channelCode: string)

Parameters

time (moment)

networkCode (string)

stationCode (string)

locationCode (string)

channelCode (string)

Instance Members

▸ publicID(value)

src/quakeml.js

publicID(value: string): (string | Pick)

Parameters

value (string)

Returns

(string | Pick)

▸ time(value)

src/quakeml.js

time(value: moment): (moment | Pick)

Parameters

value (moment)

Returns

(moment | Pick)

▸ networkCode(value)

src/quakeml.js

networkCode(value: string): (string | Pick)

Parameters

value (string)

Returns

(string | Pick)

▸ stationCode(value)

src/quakeml.js

stationCode(value: string): (string | Pick)

Parameters

value (string)

Returns

(string | Pick)

▸ locationCode(value)

src/quakeml.js

locationCode(value: string): (string | Pick)

Parameters

value (string)

Returns

(string | Pick)

▸ channelCode(value)

src/quakeml.js

channelCode(value: string): (string | Pick)

Parameters

value (string)

Returns

(string | Pick)

Seismogram

src/seismogram.js

A Seismogram object.

new Seismogram(yArray: Array, sampleRate: number, start: moment)

Parameters

yArray (Array) array of Y sample values, ie the timeseries

sampleRate (number) sample rate of the seismogram, hertz

start (moment) start time of seismogrm as a momentjs moment in utc or a string that can be parsed

Instance Members

▸ sampleRate(value)

src/seismogram.js

Get or set the sampleRate. If value is defined, sets the sampleRate and returns the seismogram. If undefined, returns the sampleRate.

sampleRate(value: number): number

Parameters

value (number)

Returns

number: the sample rate in hertz or this.

▸ start(value)

src/seismogram.js

start(value: moment): (moment | Seismogram)

Parameters

value (moment)

Returns

(moment | Seismogram)

▸ end()

src/seismogram.js

end(): moment

Returns

moment

▸ numPoints()

src/seismogram.js

numPoints(): number

Returns

number

▸ netCode(value)

src/seismogram.js

netCode(value: string): (string | Seismogram)

Parameters

value (string)

Returns

(string | Seismogram)

▸ networkCode(value)

src/seismogram.js

networkCode(value: string): (string | Seismogram)

Parameters

value (string)

Returns

(string | Seismogram)

▸ staCode(value)

src/seismogram.js

staCode(value: string): (string | Seismogram)

Parameters

value (string)

Returns

(string | Seismogram)

▸ stationCode(value)

src/seismogram.js

stationCode(value: string): (string | Seismogram)

Parameters

value (string)

Returns

(string | Seismogram)

▸ locId(value)

src/seismogram.js

locId(value: string): (string | Seismogram)

Parameters

value (string)

Returns

(string | Seismogram)

▸ locCode(value)

src/seismogram.js

locCode(value: string): (string | Seismogram)

Parameters

value (string)

Returns

(string | Seismogram)

▸ chanCode(value)

src/seismogram.js

chanCode(value: string): (string | Seismogram)

Parameters

value (string)

Returns

(string | Seismogram)

▸ channelCode(value)

src/seismogram.js

channelCode(value: string): (string | Seismogram)

Parameters

value (string)

Returns

(string | Seismogram)

▸ yUnit(value)

src/seismogram.js

yUnit(value: string): (string | Seismogram)

Parameters

value (string)

Returns

(string | Seismogram)

▸ y(value)

src/seismogram.js

y(value: Array<number>): (Array<number> | Seismogram)

Parameters

value (Array<number>)

Returns

(Array<number> | Seismogram)

▸ yAtIndex(i)

src/seismogram.js

yAtIndex(i: number): number

Parameters

i (number)

Returns

number

▸ timeOfSample(i)

src/seismogram.js

timeOfSample(i: number): moment

Parameters

i (number)

Returns

moment

▸ codes()

src/seismogram.js

codes(): string

Returns

string

▸ seisId()

src/seismogram.js

seisId(): string

Returns

string

▸ clone()

src/seismogram.js

clone(): Seismogram

Returns

Seismogram

knownDataCenters

src/knownDataCenters.js

knownDataCenters

Static Members

▸ knownDataCentersJsonURL

src/knownDataCenters.js

knownDataCentersJsonURL

▸ DS

src/knownDataCenters.js

DS

▸ EV

src/knownDataCenters.js

EV

▸ ST

src/knownDataCenters.js

ST

▸ RS

src/knownDataCenters.js

RS

▸ allDCTypes

src/knownDataCenters.js

allDCTypes

▸ getDefaultDC(type)

src/knownDataCenters.js

getDefaultDC(type: string)

Parameters

type (string)

▸ getKnownDataCenters()

src/knownDataCenters.js

Loads all known data centers. JSON top level has: created - modification date, datacenters - array of objects, each with id, name, website, email, host, region and and supports that is an array of type and version. Returns a Promise that resolves to the returned json.

getKnownDataCenters(): Promise<KnownDCS_JSON>

Returns

Promise<KnownDCS_JSON>

▸ updateKnownDataCenters()

src/knownDataCenters.js

Forces a reload of the remote json. In general, because the data is updated infrequently, this is unlikely to be needed. However, a very long running instance may wish to update this periodically, likely at most daily. Returns a Promise.

updateKnownDataCenters(): Promise<KnownDCS_JSON>

Returns

Promise<KnownDCS_JSON>

▸ getDataCenter(id)

src/knownDataCenters.js

Gets the data center associated with the id. Returns a Promise.

getDataCenter(id: string): DataCenterType

Parameters

id (string)

Returns

DataCenterType

▸ doesSupport(dc, type)

src/knownDataCenters.js

returns true is the dc datacenter supports type web service, false otherwise.

doesSupport(dc: DataCenterType, type: string)

Parameters

dc (DataCenterType)

type (string)

▸ serviceHost(dc, type)

src/knownDataCenters.js

returns the hostname for type web service. In many cases this is the same as the host for the overall datacenter, but sometimes not all web services are hosted on the same machine. For example all fdsn web services at IRIS are hosted at service.iris.edu but the ringserver is hosted at rtserve.iris.edu

serviceHost(dc: DataCenterType, type: string): string

Parameters

dc (DataCenterType)

type (string)

Returns

string

▸ servicePort(dc, type)

src/knownDataCenters.js

returns the port for type web service. In many cases this is 80, but sometimes web services are hosted on alternative ports.

servicePort(dc: DataCenterType, type: string): number

Parameters

dc (DataCenterType)

type (string)

Returns

number

ComplexType

src/util.js

ComplexType

Type: {real: number, imag: number}

Properties

real (number)

imag (number)

createComplex

src/util.js

createComplex(real: number, imag: number): ComplexType

Parameters

real (number)

imag (number)

Returns

ComplexType

moment

src/util.js

moment

hasArgs

src/util.js

hasArgs(value: any): boolean

Parameters

value (any)

Returns

boolean

hasNoArgs

src/util.js

hasNoArgs(value: any): boolean

Parameters

value (any)

Returns

boolean

isStringArg

src/util.js

isStringArg(value: any): boolean

Parameters

value (any)

Returns

boolean

isNumArg

src/util.js

isNumArg(value: any): boolean

Parameters

value (any)

Returns

boolean

stringify

src/util.js

String representation of input. THis is kind of dumb but makes flow happier.

stringify(value: any): string

Parameters

value (any)

Returns

string

checkStringOrDate

src/util.js

converts the input value is a moment, throws Error if not a string, Date or moment.

checkStringOrDate(d: any): moment

Parameters

d (any)

Returns

moment

toIsoWoZ

src/util.js

converts to ISO8601 but removes the trailing Z as FDSN web services do not allow that.

toIsoWoZ(date: moment): string

Parameters

date (moment)

Returns

string

isDef

src/util.js

isDef(v: any): boolean

Parameters

v (any)

Returns

boolean