seisplotjs.seismogram 3.0.0-alpha.0

seisplotjs.seismogram

3.0.0-alpha.0

COUNT_UNIT
HighLowType
MarkerType
Seismogram ▸
- Static members
- .createFromContiguousData
- Instance members
- #_segmentArray
- #_startTime
- #_endTime
- #_y
- #checkAllSimilar
- #checkSimilar
- #findStartEnd
- #findMinMax
- #mean
- #start
- #startTime
- #end
- #endTime
- #timeRange
- #timeWindow
- #networkCode
- #networkCode
- #stationCode
- #stationCode
- #locationCode
- #locationCode
- #channelCode
- #channelCode
- #sourceId
- #sampleRate
- #samplePeriod
- #yUnit
- #numPoints
- #hasCodes
- #nslc
- #codes
- #segments
- #append
- #cut
- #trim
- #break
- #isContiguous
- #merge
- #y
- #y
- #clone
- #cloneWithNewData
NonContiguousData
ensureIsSeismogram
SeismogramDisplayData ▸
- Static members
- .fromSeismogram
- .fromContiguousData
- .fromChannelAndTimeWindow
- .fromChannelAndTimes
- .fromCodesAndTimes
- Instance members
- #_id
- #_sourceId
- #label
- #markerList
- #traveltimeList
- #channel
- #channelCodesHolder
- #_instrumentSensitivity
- #quakeList
- #timeRange
- #alignmentTime
- #doShow
- #_statsCache
- #addQuake
- #addMarker
- #addMarkers
- #addTravelTimes
- #hasQuake
- #quake
- #hasSeismogram
- #hasChannel
- #hasSensitivity
- #id
- #id
- #networkCode
- #stationCode
- #locationCode
- #channelCode
- #sourceId
- #nslc
- #codes
- #startTime
- #start
- #endTime
- #end
- #timeWindow
- #alignStartTime
- #alignOriginTime
- #alignPhaseTime
- #relativeTimeWindow
- #sensitivity
- #sensitivity
- #min
- #max
- #mean
- #middle
- #seismogram
- #seismogram
- #segments
- #calcStats
- #distazList
- #distaz
- #clone
- #cloneWithNewSeismogram
- #cut
- #toString
SeismogramDisplayStats ▸
- Instance members
- #min
- #max
- #mean
- #trendSlope
- #middle
findStartEnd
findMaxDuration
findMaxDurationOfType
findMinMax
findMinMaxOverTimeRange
findMinMaxOverRelativeTimeRange
findStartEndOfSeismograms
findMinMaxOfSeismograms
findMinMaxOfSDD
uniqueStations
uniqueQuakes

Need help reading this?

COUNT_UNIT

src/seismogram.ts

COUNT_UNIT

Type: string

HighLowType

src/seismogram.ts

HighLowType

Type: {xScaleDomain: Array<Date>, xScaleRange: Array<number>, secondsPerPixel: number, samplesPerPixel: number, highlowArray: Array<number>}

Properties

xScaleDomain (Array<Date>)

xScaleRange (Array<number>)

secondsPerPixel (number)

samplesPerPixel (number)

highlowArray (Array<number>)

MarkerType

src/seismogram.ts

MarkerType

Type: {name: string, time: DateTime, type: string, description: string, link: string?}

Properties

name (string)

time (DateTime)

type (string)

description (string)

link (string?)

Seismogram

src/seismogram.ts

Represents time window for a single channel that may contain gaps or overlaps, but is otherwise more or less continuous, or at least adjacent data from the channel. Each segment within the Seismogram will have the same units, channel identifiers and sample rate, but cover different times.

new Seismogram(segmentArray: (SeismogramSegment | Array<SeismogramSegment>))

Parameters

segmentArray ((SeismogramSegment | Array<SeismogramSegment>))

Static Members

▸ createFromContiguousData(yArray, sampleRate, startTime)

src/seismogram.ts

factory method to create a single segment Seismogram from either encoded data or a TypedArray, along with sample rate and start time.

createFromContiguousData(yArray: (Array<seedcodec.EncodedDataSegment> | Int32Array | Float32Array | Float64Array), sampleRate: number, startTime: DateTime): Seismogram

Parameters

yArray ((Array<seedcodec.EncodedDataSegment> | Int32Array | Float32Array | Float64Array)) array of encoded data or typed array

sampleRate (number) sample rate, samples per second of the data

startTime (DateTime) time of first sample

Returns

Seismogram: seismogram initialized with the data

Instance Members

▸ _segmentArray

src/seismogram.ts

_segmentArray

Type: Array<SeismogramSegment>

▸ _startTime

src/seismogram.ts

_startTime

Type: DateTime

▸ _endTime

src/seismogram.ts

_endTime

Type: DateTime

▸ _y

src/seismogram.ts

Type: (null | Int32Array | Float32Array | Float64Array)

▸ checkAllSimilar()

src/seismogram.ts

checkAllSimilar()

▸ checkSimilar(f, s)

src/seismogram.ts

checkSimilar(f: SeismogramSegment, s: SeismogramSegment)

Parameters

f (SeismogramSegment)

s (SeismogramSegment)

▸ findStartEnd()

src/seismogram.ts

findStartEnd(): [DateTime, DateTime]

Returns

[DateTime, DateTime]

▸ findMinMax(minMaxAccumulator?)

src/seismogram.ts

findMinMax(minMaxAccumulator: Array<number>?): Array<number>

Parameters

minMaxAccumulator (Array<number>?)

Returns

Array<number>

▸ mean()

src/seismogram.ts

calculates the mean of a seismogrma.

mean(): number

Returns

number: mean value

▸ start

src/seismogram.ts

start

Type: DateTime

Returns

DateTime

▸ startTime

src/seismogram.ts

startTime

Type: DateTime

Returns

DateTime

▸ end

src/seismogram.ts

end

Type: DateTime

Returns

DateTime

▸ endTime

src/seismogram.ts

endTime

Type: DateTime

Returns

DateTime

▸ timeRange

src/seismogram.ts

timeRange

Type: Interval

Returns

Interval

▸ timeWindow

src/seismogram.ts

timeWindow

Type: Interval

Returns

Interval

▸ networkCode

src/seismogram.ts

networkCode

Type: (string | null)

Returns

(string | null)

▸ networkCode

src/seismogram.ts

networkCode

Type: (string | null)

Parameters

value ((string | null))

▸ stationCode

src/seismogram.ts

stationCode

Type: (string | null)

Returns

(string | null)

▸ stationCode

src/seismogram.ts

stationCode

Type: (string | null)

Parameters

value ((string | null))

▸ locationCode

src/seismogram.ts

locationCode

Type: (string | null)

Returns

(string | null)

▸ locationCode

src/seismogram.ts

locationCode

Type: (string | null)

Parameters

value ((string | null))

▸ channelCode

src/seismogram.ts

channelCode

Type: (string | null)

Returns

(string | null)

▸ channelCode

src/seismogram.ts

channelCode

Type: (string | null)

Parameters

value ((string | null))

▸ sourceId

src/seismogram.ts

return FDSN source id as a string.

sourceId

Type: (FDSNSourceId | null)

Returns

(FDSNSourceId | null): FDSN source id

▸ sampleRate

src/seismogram.ts

sampleRate

Type: number

Returns

number

▸ samplePeriod

src/seismogram.ts

samplePeriod

Type: number

Returns

number

▸ yUnit

src/seismogram.ts

yUnit

Type: (string | null)

Returns

(string | null)

▸ numPoints

src/seismogram.ts

numPoints

Type: number

Returns

number

▸ hasCodes()

src/seismogram.ts

hasCodes(): boolean

Returns

boolean

▸ nslc

src/seismogram.ts

return network, station, location and channels codes as one string. Uses this.channel if it exists, this.seismogram if not.

nslc

Type: string

Returns

string: net.sta.loc.chan

▸ codes()

src/seismogram.ts

codes(): string

Returns

string

▸ segments

src/seismogram.ts

segments

Type: Array<SeismogramSegment>

Returns

Array<SeismogramSegment>

▸ append(seismogram)

src/seismogram.ts

append(seismogram: (SeismogramSegment | Seismogram))

Parameters

seismogram ((SeismogramSegment | Seismogram))

▸ cut(timeRange)

src/seismogram.ts

Cut the seismogram. Creates a new seismogram with all datapoints contained in the time window.

cut(timeRange: Interval): (null | Seismogram)

Parameters

timeRange (Interval) start and end of cut

Returns

(null | Seismogram): new seismogram

▸ trim(timeRange)

src/seismogram.ts

Creates a new Seismogram composed of all seismogram segments that overlap the given time window. If none do, this returns null. This is a faster but coarser version of cut as it only removes whole segments that do not overlap the time window. For most seismograms that consist of a single contiguous data segment, this will do nothing.

trim(timeRange: Interval): (null | Seismogram)

Parameters

timeRange (Interval) time range to trim to

Returns

(null | Seismogram): seismogram if data in the window, null otherwise

cut

▸ break(duration)

src/seismogram.ts

break(duration: Duration): void

Parameters

duration (Duration)

Returns

void

▸ isContiguous()

src/seismogram.ts

isContiguous(): boolean

Returns

boolean

▸ merge()

src/seismogram.ts

Merges all segments into a single array of the same type as the first segment. No checking is done for gaps or overlaps, this is a simple congatination. Be careful!

merge(): (Int32Array | Float32Array | Float64Array)

Returns

(Int32Array | Float32Array | Float64Array): contatenated data

▸ y

src/seismogram.ts

Gets the timeseries as an typed array if it is contiguous.

Type: (Int32Array | Float32Array | Float64Array)

Returns

(Int32Array | Float32Array | Float64Array): timeseries as array of number

Throws

NonContiguousData: if data is not contiguous.

▸ y

src/seismogram.ts

Type: (Int32Array | Float32Array | Float64Array)

Parameters

val ((Int32Array | Float32Array | Float64Array))

▸ clone()

src/seismogram.ts

clone(): Seismogram

Returns

Seismogram

▸ cloneWithNewData(newY)

src/seismogram.ts

cloneWithNewData(newY: (Int32Array | Float32Array | Float64Array)): Seismogram

Parameters

newY ((Int32Array | Float32Array | Float64Array))

Returns

Seismogram

NonContiguousData

src/seismogram.ts

new NonContiguousData(message: string?)

Extends Error

Parameters

message (string?)

ensureIsSeismogram

src/seismogram.ts

ensureIsSeismogram(seisSeismogram: (Seismogram | SeismogramSegment)): Seismogram

Parameters

seisSeismogram ((Seismogram | SeismogramSegment))

Returns

Seismogram

SeismogramDisplayData

src/seismogram.ts

new SeismogramDisplayData(timeRange: Interval)

Parameters

timeRange (Interval)

Static Members

▸ fromSeismogram(seismogram)

src/seismogram.ts

fromSeismogram(seismogram: Seismogram): SeismogramDisplayData

Parameters

seismogram (Seismogram)

Returns

SeismogramDisplayData

▸ fromContiguousData(yArray, sampleRate, startTime)

src/seismogram.ts

Useful for creating fake data from an array, sample rate and start time

fromContiguousData(yArray: (Array<seedcodec.EncodedDataSegment> | Int32Array | Float32Array | Float64Array), sampleRate: number, startTime: DateTime): SeismogramDisplayData

Parameters

yArray ((Array<seedcodec.EncodedDataSegment> | Int32Array | Float32Array | Float64Array))

sampleRate (number)

startTime (DateTime)

Returns

SeismogramDisplayData: [description]

▸ fromChannelAndTimeWindow(channel, timeRange)

src/seismogram.ts

fromChannelAndTimeWindow(channel: Channel, timeRange: Interval): SeismogramDisplayData

Parameters

channel (Channel)

timeRange (Interval)

Returns

SeismogramDisplayData

▸ fromChannelAndTimes(channel, startTime, endTime)

src/seismogram.ts

fromChannelAndTimes(channel: Channel, startTime: DateTime, endTime: DateTime): SeismogramDisplayData

Parameters

channel (Channel)

startTime (DateTime)

endTime (DateTime)

Returns

SeismogramDisplayData

▸ fromCodesAndTimes(networkCode, stationCode, locationCode, channelCode, startTime, endTime)

src/seismogram.ts

fromCodesAndTimes(networkCode: string, stationCode: string, locationCode: string, channelCode: string, startTime: DateTime, endTime: DateTime): SeismogramDisplayData

Parameters

networkCode (string)

stationCode (string)

locationCode (string)

channelCode (string)

startTime (DateTime)

endTime (DateTime)

Returns

SeismogramDisplayData

Instance Members

▸ _id

src/seismogram.ts

_id

Type: (string | null)

▸ _sourceId

src/seismogram.ts

_sourceId

Type: (FDSNSourceId | null)

▸ label

src/seismogram.ts

label

Type: (string | null)

▸ markerList

src/seismogram.ts

markerList

Type: Array<MarkerType>

▸ traveltimeList

src/seismogram.ts

traveltimeList

Type: Array<TraveltimeArrivalType>

▸ channel

src/seismogram.ts

channel

Type: (Channel | null)

▸ channelCodesHolder

src/seismogram.ts

channelCodesHolder

Type: (NslcId | null)

▸ _instrumentSensitivity

src/seismogram.ts

_instrumentSensitivity

Type: (InstrumentSensitivity | null)

▸ quakeList

src/seismogram.ts

quakeList

Type: Array<Quake>

▸ timeRange

src/seismogram.ts

timeRange

Type: Interval

▸ alignmentTime

src/seismogram.ts

alignmentTime

Type: DateTime

▸ doShow

src/seismogram.ts

doShow

Type: boolean

▸ _statsCache

src/seismogram.ts

_statsCache

Type: (SeismogramDisplayStats | null)

▸ addQuake(quake)

src/seismogram.ts

addQuake(quake: (Quake | Array<Quake>))

Parameters

quake ((Quake | Array<Quake>))

▸ addMarker(marker)

src/seismogram.ts

addMarker(marker: MarkerType)

Parameters

marker (MarkerType)

▸ addMarkers(markers)

src/seismogram.ts

addMarkers(markers: (MarkerType | Array<MarkerType>))

Parameters

markers ((MarkerType | Array<MarkerType>))

▸ addTravelTimes(ttimes)

src/seismogram.ts

addTravelTimes(ttimes: (TraveltimeJsonType | TraveltimeArrivalType | Array<TraveltimeArrivalType>))

Parameters

ttimes ((TraveltimeJsonType | TraveltimeArrivalType | Array<TraveltimeArrivalType>))

▸ hasQuake()

src/seismogram.ts

hasQuake(): boolean

Returns

boolean

▸ quake

src/seismogram.ts

quake

Type: (Quake | null)

Returns

(Quake | null)

▸ hasSeismogram()

src/seismogram.ts

hasSeismogram(): any

Returns

any

▸ hasChannel()

src/seismogram.ts

hasChannel(): any

Returns

any

▸ hasSensitivity()

src/seismogram.ts

hasSensitivity(): any

Returns

any

▸ id

src/seismogram.ts

Allows id-ing a seismogram. Optional.

Type: (string | null)

Returns

(string | null): string id

▸ id

src/seismogram.ts

Allows iding a seismogram. Optional.

Type: (string | null)

Parameters

value ((string | null)) string id

▸ networkCode

src/seismogram.ts

return network code as a string. Uses this.channel if it exists, this.seismogram if not.

networkCode

Type: string

Returns

string: network code

▸ stationCode

src/seismogram.ts

return station code as a string. Uses this.channel if it exists, this.seismogram if not.

stationCode

Type: string

Returns

string: station code

▸ locationCode

src/seismogram.ts

return location code a a string. Uses this.channel if it exists, this.seismogram if not.

locationCode

Type: string

Returns

string: location code

▸ channelCode

src/seismogram.ts

return channels code as a string. Uses this.channel if it exists, this.seismogram if not.

channelCode

Type: string

Returns

string: channel code

▸ sourceId

src/seismogram.ts

return FDSN source id as a string. Uses this.channel if it exists, this.seismogram if not.

sourceId

Type: (FDSNSourceId | null)

Returns

(FDSNSourceId | null): FDSN source id

▸ nslc

src/seismogram.ts

return network, station, location and channels codes as one string. Uses this.channel if it exists, this.seismogram if not

nslc

Type: string

Returns

string: net.sta.loc.chan

▸ codes(sep)

src/seismogram.ts

return network, station, location and channels codes as one string. Uses this.channel if it exists, this.seismogram if not.

codes(sep: any): string

Parameters

sep

(any
            = ".")

separator, defaults to '.'

Returns

string: nslc codes separated by sep

▸ startTime

src/seismogram.ts

startTime

Type: DateTime

Returns

DateTime

▸ start

src/seismogram.ts

start

Type: DateTime

Returns

DateTime

▸ endTime

src/seismogram.ts

endTime

Type: DateTime

Returns

DateTime

▸ end

src/seismogram.ts

end

Type: DateTime

Returns

DateTime

▸ timeWindow

src/seismogram.ts

timeWindow

Type: Interval

Returns

Interval

▸ alignStartTime()

src/seismogram.ts

alignStartTime()

▸ alignOriginTime()

src/seismogram.ts

alignOriginTime()

▸ alignPhaseTime(phaseRegExp)

src/seismogram.ts

alignPhaseTime(phaseRegExp: (RegExp | string))

Parameters

phaseRegExp ((RegExp | string))

▸ relativeTimeWindow(startOffset, duration)

src/seismogram.ts

relativeTimeWindow(startOffset: Duration, duration: Duration): Interval

Parameters

startOffset (Duration)

duration (Duration)

Returns

Interval

▸ sensitivity

src/seismogram.ts

sensitivity

Type: (InstrumentSensitivity | null)

Returns

(InstrumentSensitivity | null)

▸ sensitivity

src/seismogram.ts

sensitivity

Type: (InstrumentSensitivity | null)

Parameters

value ((InstrumentSensitivity | null))

▸ min

src/seismogram.ts

min

Type: number

Returns

number

▸ max

src/seismogram.ts

max

Type: number

Returns

number

▸ mean

src/seismogram.ts

mean

Type: number

Returns

number

▸ middle

src/seismogram.ts

middle

Type: number

Returns

number

▸ seismogram

src/seismogram.ts

seismogram

Type: (Seismogram | null)

Returns

(Seismogram | null)

▸ seismogram

src/seismogram.ts

seismogram

Type: (Seismogram | null)

Parameters

value ((Seismogram | null))

▸ segments

src/seismogram.ts

segments

Type: Array<SeismogramSegment>

Returns

Array<SeismogramSegment>

▸ calcStats()

src/seismogram.ts

calcStats(): SeismogramDisplayStats

Returns

SeismogramDisplayStats

▸ distazList

src/seismogram.ts

Calculates distance and azimuth for each event in quakeList.

distazList

Type: Array<DistAzOutput>

Returns

Array<DistAzOutput>: Array of DistAzOutput, empty array if no quakes.

▸ distaz

src/seismogram.ts

Calculates distance and azimuth for the first event in quakeList. This is a convienence method as usually there will only be one quake.

distaz

Type: (null | DistAzOutput)

Returns

(null | DistAzOutput): DistAzOutput, null if no quakes.

▸ clone()

src/seismogram.ts

clone(): SeismogramDisplayData

Returns

SeismogramDisplayData

▸ cloneWithNewSeismogram(seis)

src/seismogram.ts

cloneWithNewSeismogram(seis: (Seismogram | null)): SeismogramDisplayData

Parameters

seis ((Seismogram | null))

Returns

SeismogramDisplayData

▸ cut(timeRange)

src/seismogram.ts

Cut the seismogram. Creates a new seismogramDisplayData with the cut seismogram and the timeRange set to the new time window.

cut(timeRange: Interval): (null | SeismogramDisplayData)

Parameters

timeRange (Interval) start and end of cut

Returns

(null | SeismogramDisplayData): new seismogramDisplayData

▸ toString()

src/seismogram.ts

toString(): string

Returns

string

SeismogramDisplayStats

src/seismogram.ts

new SeismogramDisplayStats()

Instance Members

▸ min

src/seismogram.ts

min

Type: number

▸ max

src/seismogram.ts

max

Type: number

▸ mean

src/seismogram.ts

mean

Type: number

▸ trendSlope

src/seismogram.ts

trendSlope

Type: number

▸ middle

src/seismogram.ts

middle

Type: number

Returns

number

findStartEnd

src/seismogram.ts

findStartEnd(sddList: Array<SeismogramDisplayData>): Interval

Parameters

sddList (Array<SeismogramDisplayData>)

Returns

Interval

findMaxDuration

src/seismogram.ts

findMaxDuration(sddList: Array<SeismogramDisplayData>): Duration

Parameters

sddList (Array<SeismogramDisplayData>)

Returns

Duration

findMaxDurationOfType

src/seismogram.ts

findMaxDurationOfType(type: string, sddList: Array<SeismogramDisplayData>): Duration

Parameters

type (string)

sddList (Array<SeismogramDisplayData>)

Returns

Duration

findMinMax

src/seismogram.ts

findMinMax(sddList: Array<SeismogramDisplayData>, doGain: any, centeredAmp: any): Array<number>

Parameters

sddList (Array<SeismogramDisplayData>)

doGain

(any
            = false)

centeredAmp

(any
            = false)

Returns

Array<number>

findMinMaxOverTimeRange

src/seismogram.ts

findMinMaxOverTimeRange(sddList: Array<SeismogramDisplayData>, timeRange: Interval, doGain: any, centeredAmp: any): Array<number>

Parameters

sddList (Array<SeismogramDisplayData>)

timeRange (Interval)

doGain

(any
            = false)

centeredAmp

(any
            = false)

Returns

Array<number>

findMinMaxOverRelativeTimeRange

src/seismogram.ts

findMinMaxOverRelativeTimeRange(sddList: Array<SeismogramDisplayData>, startOffset: Duration, duration: Duration, doGain: any, centeredAmp: any): Array<number>

Parameters

sddList (Array<SeismogramDisplayData>)

startOffset (Duration)

duration (Duration)

doGain

(any
            = false)

centeredAmp

(any
            = false)

Returns

Array<number>

findStartEndOfSeismograms

src/seismogram.ts

findStartEndOfSeismograms(data: Array<Seismogram>, accumulator: Interval?): Interval

Parameters

data (Array<Seismogram>)

accumulator (Interval?)

Returns

Interval

findMinMaxOfSeismograms

src/seismogram.ts

findMinMaxOfSeismograms(data: Array<Seismogram>, minMaxAccumulator: Array<number>?): Array<number>

Parameters

data (Array<Seismogram>)

minMaxAccumulator (Array<number>?)

Returns

Array<number>

findMinMaxOfSDD

src/seismogram.ts

findMinMaxOfSDD(data: Array<SeismogramDisplayData>, minMaxAccumulator: Array<number>?): Array<number>

Parameters

data (Array<SeismogramDisplayData>)

minMaxAccumulator (Array<number>?)

Returns

Array<number>

uniqueStations

src/seismogram.ts

uniqueStations(seisData: Array<SeismogramDisplayData>): Array<Station>

Parameters

seisData (Array<SeismogramDisplayData>)

Returns

Array<Station>

uniqueQuakes

src/seismogram.ts

uniqueQuakes(seisData: Array<SeismogramDisplayData>): Array<Quake>

Parameters

seisData (Array<SeismogramDisplayData>)

Returns

Array<Quake>