seisplotjs 3.1.1 | Documentation

seisplotjs

3.1.1

FDSN_PREFIX
SEP
FDSNSourceId ▸
- Static members
- .createUnknown
- .parse
- .fromNslc
- .fromNslcId
- .parseNslc
- Instance members
- #networkCode
- #stationCode
- #locationCode
- #bandCode
- #sourceCode
- #subsourceCode
- #stationSourceId
- #networkSourceId
- #asNslc
- #formChannelCode
- #toString
- #toStringNoPrefix
- #equals
- #clone
NetworkSourceId ▸
- Static members
- .parse
- Instance members
- #networkCode
- #toString
- #equals
StationSourceId ▸
- Static members
- .parse
- Instance members
- #networkCode
- #stationCode
- #toString
- #networkSourceId
- #equals
LocationSourceId ▸
- Instance members
- #networkCode
- #stationCode
- #locationCode
- #toString
- #equals
bandCodeForRate
EMPTY_LOC_CODE
NslcId ▸
- Static members
- .parse
- Instance members
- #networkCode
- #stationCode
- #locationCode
- #channelCode
- #toString
- #equals
parseSourceId
SourceIdSorter

Need help reading this?

FDSN_PREFIX

Type: string

SEP

Type: string

FDSNSourceId

new FDSNSourceId(networkCode: string, stationCode: string, locationCode: string, bandCode: string, sourceCode: string, subsourceCode: string)

Parameters

networkCode (string)

stationCode (string)

locationCode (string)

bandCode (string)

sourceCode (string)

subsourceCode (string)

Static Members

▸ createUnknown(sampRate?, source?, subsource?)

createUnknown(sampRate: number?, source: string?, subsource: string?): FDSNSourceId

Parameters

sampRate (number?)

source (string?)

subsource (string?)

Returns

FDSNSourceId

▸ parse(id)

parse(id: string): FDSNSourceId

Parameters

id (string)

Returns

FDSNSourceId

▸ fromNslc(net, sta, loc, channelCode)

fromNslc(net: string, sta: string, loc: string, channelCode: string): FDSNSourceId

Parameters

net (string)

sta (string)

loc (string)

channelCode (string)

Returns

FDSNSourceId

▸ fromNslcId(nslcId)

fromNslcId(nslcId: NslcId): FDSNSourceId

Parameters

nslcId (NslcId)

Returns

FDSNSourceId

▸ parseNslc(nslc, sep)

parseNslc(nslc: string, sep: any): FDSNSourceId

Parameters

nslc (string)

sep

(any
            = '.')

Returns

FDSNSourceId

Instance Members

▸ networkCode

networkCode

Type: string

▸ stationCode

stationCode

Type: string

▸ locationCode

locationCode

Type: string

▸ bandCode

bandCode

Type: string

▸ sourceCode

sourceCode

Type: string

▸ subsourceCode

subsourceCode

Type: string

▸ stationSourceId()

stationSourceId(): StationSourceId

Returns

StationSourceId

▸ networkSourceId()

networkSourceId(): NetworkSourceId

Returns

NetworkSourceId

▸ asNslc()

asNslc(): NslcId

Returns

NslcId

▸ formChannelCode()

returns a channel code. If this is an old style NSLC, it will be 3 chars, but if either source or subsouce is more than one char, it will be three fields delimited by underscores.

formChannelCode(): string

Returns

string: the channel code part of the id

▸ toString()

toString(): string

Returns

string

▸ toStringNoPrefix()

toStringNoPrefix(): string

Returns

string

▸ equals(other)

equals(other: (FDSNSourceId | null)): boolean

Parameters

other ((FDSNSourceId | null))

Returns

boolean

▸ clone()

clone(): FDSNSourceId

Returns

FDSNSourceId

NetworkSourceId

new NetworkSourceId(networkCode: string)

Parameters

networkCode (string)

Static Members

▸ parse(id)

parse(id: string): NetworkSourceId

Parameters

id (string)

Returns

NetworkSourceId

Instance Members

▸ networkCode

networkCode

Type: string

▸ toString()

toString(): string

Returns

string

▸ equals(other)

equals(other: NetworkSourceId): boolean

Parameters

other (NetworkSourceId)

Returns

boolean

StationSourceId

new StationSourceId(networkCode: string, stationCode: string)

Parameters

networkCode (string)

stationCode (string)

Static Members

▸ parse(id)

parse(id: string): StationSourceId

Parameters

id (string)

Returns

StationSourceId

Instance Members

▸ networkCode

networkCode

Type: string

▸ stationCode

stationCode

Type: string

▸ toString()

toString(): string

Returns

string

▸ networkSourceId()

networkSourceId(): NetworkSourceId

Returns

NetworkSourceId

▸ equals(other)

equals(other: StationSourceId): boolean

Parameters

other (StationSourceId)

Returns

boolean

LocationSourceId

new LocationSourceId(networkCode: string, stationCode: string, locationCode: string)

Parameters

networkCode (string)

stationCode (string)

locationCode (string)

Instance Members

▸ networkCode

networkCode

Type: string

▸ stationCode

stationCode

Type: string

▸ locationCode

locationCode

Type: string

▸ toString()

toString(): string

Returns

string

▸ equals(other)

equals(other: LocationSourceId): boolean

Parameters

other (LocationSourceId)

Returns

boolean

bandCodeForRate

Generates the best band code for a channel based on the sample rate and optionally the response lower bound period, which is mostly useful for separating broadband from short period seismometers.

bandCodeForRate(sampRate: number?, resp_lb: number?): string

Parameters

sampRate (number?) sample rate in samples per second

resp_lb (number?) response long period bound in seconds

Returns

string: single character band code

EMPTY_LOC_CODE

Type: string

NslcId

new NslcId(net: string, sta: string, loc: string, chan: string)

Parameters

net (string)

sta (string)

loc (string)

chan (string)

Static Members

▸ parse(nslc, sep)

parse(nslc: string, sep: any): NslcId

Parameters

nslc (string)

sep

(any
            = '.')

Returns

NslcId

Instance Members

▸ networkCode

networkCode

Type: string

▸ stationCode

stationCode

Type: string

▸ locationCode

locationCode

Type: string

▸ channelCode

channelCode

Type: string

▸ toString()

toString(): string

Returns

string

▸ equals(other)

equals(other: NslcId): boolean

Parameters

other (NslcId)

Returns

boolean

parseSourceId

parseSourceId(id: string): (FDSNSourceId | NetworkSourceId | StationSourceId)

Parameters

id (string)

Returns

(FDSNSourceId | NetworkSourceId | StationSourceId)

SourceIdSorter

new SourceIdSorter(aSid: FDSNSourceId, bSid: FDSNSourceId): number

Parameters

aSid (FDSNSourceId)

bSid (FDSNSourceId)

Returns

number