seisplotjs.seismogram 2.0.0-alpha.6 | Documentation

seisplotjs.seismogram

2.0.0-alpha.6

COUNT_UNIT
HighLowType
MarkerType
SeismogramSegment ▸
- Instance members
- #_y
- #_compressed
- #_endTime_cache
- #_endTime_cache_numPoints
- #networkCode
- #stationCode
- #locationCode
- #channelCode
- #yUnit
- #_highlow
- #y
- #y
- #startTime
- #startTime
- #endTime
- #timeWindow
- #sampleRate
- #sampleRate
- #numPoints
- #netCode
- #staCode
- #locId
- #locCode
- #chanCode
- #isEncoded
- #getEncoded
- #yAtIndex
- #findMinMax
- #timeOfSample
- #indexOfTime
- #hasCodes
- #codes
- #seisId
- #clone
- #cloneWithNewData
- #cut
- #_invalidate_endTime_cache
Seismogram ▸
- Static members
- .createFromContiguousData
- Instance members
- #_segmentArray
- #_startTime
- #_endTime
- #_y
- #checkAllSimilar
- #checkSimilar
- #findStartEnd
- #findMinMax
- #mean
- #startTime
- #endTime
- #timeRange
- #networkCode
- #networkCode
- #stationCode
- #stationCode
- #locationCode
- #locationCode
- #channelCode
- #channelCode
- #sampleRate
- #yUnit
- #numPoints
- #hasCodes
- #codes
- #segments
- #append
- #cut
- #trim
- #break
- #isContiguous
- #merge
- #y
- #y
- #clone
- #cloneWithNewData
NonContiguousData
ensureIsSeismogram
SeismogramDisplayData ▸
- Static members
- .fromSeismogram
- .fromChannelAndTimeWindow
- .fromChannelAndTimes
- Instance members
- #_id
- #label
- #markerList
- #channel
- #_instrumentSensitivity
- #quakeList
- #timeWindow
- #alignmentTime
- #doShow
- #_statsCache
- #addQuake
- #addMarkers
- #hasQuake
- #hasSeismogram
- #hasChannel
- #hasSensitivity
- #id
- #id
- #networkCode
- #stationCode
- #locationCode
- #channelCode
- #codes
- #startTime
- #endTime
- #sensitivity
- #sensitivity
- #min
- #max
- #mean
- #seismogram
- #seismogram
- #calcStats
- #clone
- #cloneWithNewSeismogram
- #cut
SeismogramDisplayStats ▸
- Instance members
- #min
- #max
- #mean
- #trendSlope
findStartEnd
findMinMax
findMinMaxOverTimeRange
findStartEndOfSeismograms
findMinMaxOfSeismograms

Need help reading this?

COUNT_UNIT

src/seismogram.js

COUNT_UNIT

Type: string

HighLowType

src/seismogram.js

HighLowType

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

Properties

xScaleDomain (Array<number>)

xScaleRange (Array<number>)

secondsPerPixel (number)

samplesPerPixel (number)

highlowArray (Array<number>)

MarkerType

src/seismogram.js

MarkerType

Type: {name: string, time: moment, type: string, description: string}

Properties

name (string)

time (moment)

type (string)

description (string)

SeismogramSegment

src/seismogram.js

A contiguous segment of a Seismogram.

new SeismogramSegment(yArray: (Array<seedcodec.EncodedDataSegment> | Int32Array | Float32Array | Float64Array), sampleRate: number, startTime: moment)

Parameters

yArray ((Array<seedcodec.EncodedDataSegment> | Int32Array | Float32Array | Float64Array)) array of Y sample values, ie the timeseries

sampleRate (number) sample rate of the seismogram, hertz

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

Instance Members

▸ _y

src/seismogram.js

Array of y values

_y

Type: (null | Int32Array | Float32Array | Float64Array)

▸ _compressed

src/seismogram.js

_compressed

Type: (null | Array<seedcodec.EncodedDataSegment>)

▸ _endTime_cache

src/seismogram.js

_endTime_cache

Type: (null | moment)

▸ _endTime_cache_numPoints

src/seismogram.js

_endTime_cache_numPoints

Type: number

▸ networkCode

src/seismogram.js

networkCode

Type: string

▸ stationCode

src/seismogram.js

stationCode

Type: string

▸ locationCode

src/seismogram.js

locationCode

Type: string

▸ channelCode

src/seismogram.js

channelCode

Type: string

▸ yUnit

src/seismogram.js

yUnit

Type: string

▸ _highlow

src/seismogram.js

_highlow

Type: HighLowType

▸ y

src/seismogram.js

Y data of the seismogram. Decompresses data if needed.

y

Type: (Int32Array | Float32Array | Float64Array)

Returns

(Int32Array | Float32Array | Float64Array): y data as typed array

▸ y

src/seismogram.js

y

Type: (Int32Array | Float32Array | Float64Array)

Parameters

value ((Int32Array | Float32Array | Float64Array))

▸ startTime

src/seismogram.js

startTime

Type: moment

Returns

moment

▸ startTime

src/seismogram.js

startTime

Type: (moment | string)

Parameters

value ((moment | string))

▸ endTime

src/seismogram.js

endTime

Type: moment

Returns

moment

▸ timeWindow

src/seismogram.js

timeWindow

Type: StartEndDuration

Returns

StartEndDuration

▸ sampleRate

src/seismogram.js

sampleRate

▸ sampleRate

src/seismogram.js

sampleRate

Type: number

Parameters

value (number)

▸ numPoints

src/seismogram.js

numPoints

Type: number

Returns

number

▸ netCode

src/seismogram.js

netCode

Type: string

Returns

string

▸ staCode

src/seismogram.js

staCode

Type: string

Returns

string

▸ locId

src/seismogram.js

locId

Type: string

Returns

string

▸ locCode

src/seismogram.js

locCode

Type: string

Returns

string

▸ chanCode

src/seismogram.js

chanCode

Type: string

Returns

string

▸ isEncoded()

src/seismogram.js

Checks if the data is encoded

isEncoded(): boolean

Returns

boolean: true if encoded, false otherwise

▸ getEncoded()

src/seismogram.js

Gets encoded data, if it is.

getEncoded(): Array<seedcodec.EncodedDataSegment>

Returns

Array<seedcodec.EncodedDataSegment>: array of encoded data segments

Throws

any: Error if data is not encoded

▸ yAtIndex(i)

src/seismogram.js

yAtIndex(i: number): number

Parameters

i (number)

Returns

number

▸ findMinMax(minMaxAccumulator?)

src/seismogram.js

Finds the min and max values of a SeismogramSegment, with an optional accumulator for use with gappy data.

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

Parameters

minMaxAccumulator (Array<number>?) optional initialized accumulator as an array of two numbers, min and max

Returns

Array<number>: min, max as arry of length two

▸ timeOfSample(i)

src/seismogram.js

timeOfSample(i: number): moment

Parameters

i (number)

Returns

moment

▸ indexOfTime(t)

src/seismogram.js

indexOfTime(t: moment): number

Parameters

t (moment)

Returns

number

▸ hasCodes()

src/seismogram.js

hasCodes(): boolean

Returns

boolean

▸ codes(sep)

src/seismogram.js

return network, station, location and channels codes as one string

codes(sep: string): string

Parameters

sep

(string
            = '.')

separator, defaults to '.'

Returns

string: nslc codes separated by sep

▸ seisId()

src/seismogram.js

seisId(): string

Returns

string

▸ clone()

src/seismogram.js

clone(): SeismogramSegment

Returns

SeismogramSegment

▸ cloneWithNewData(clonedData, clonedStartTime)

src/seismogram.js

cloneWithNewData(clonedData: (Array<seedcodec.EncodedDataSegment> | Int32Array | Float32Array | Float64Array), clonedStartTime: moment): SeismogramSegment

Parameters

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

clonedStartTime

(moment
            = this._startTime)

Returns

SeismogramSegment

▸ cut(timeWindow)

src/seismogram.js

cut(timeWindow: StartEndDuration): (SeismogramSegment | null)

Parameters

timeWindow (StartEndDuration)

Returns

(SeismogramSegment | null)

▸ _invalidate_endTime_cache()

src/seismogram.js

_invalidate_endTime_cache()

Seismogram

src/seismogram.js

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

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: moment): any

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 (moment) time of first sample

Returns

any: seismogram initialized with the data

Instance Members

▸ _segmentArray

src/seismogram.js

_segmentArray

Type: Array<SeismogramSegment>

▸ _startTime

src/seismogram.js

_startTime

Type: moment

▸ _endTime

src/seismogram.js

_endTime

Type: moment

▸ _y

src/seismogram.js

_y

Type: (null | Int32Array | Float32Array | Float64Array)

▸ checkAllSimilar()

src/seismogram.js

checkAllSimilar()

▸ checkSimilar(f, s)

src/seismogram.js

checkSimilar(f: SeismogramSegment, s: SeismogramSegment)

Parameters

f (SeismogramSegment)

s (SeismogramSegment)

▸ findStartEnd()

src/seismogram.js

findStartEnd()

▸ findMinMax(minMaxAccumulator?)

src/seismogram.js

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

Parameters

minMaxAccumulator (Array<number>?)

Returns

Array<number>

▸ mean()

src/seismogram.js

calculates the mean of a seismogrma.

mean(): number

Returns

number: mean value

▸ startTime

src/seismogram.js

startTime

Type: moment

Returns

moment

▸ endTime

src/seismogram.js

endTime

Type: moment

Returns

moment

▸ timeRange

src/seismogram.js

timeRange

Type: StartEndDuration

Returns

StartEndDuration

▸ networkCode

src/seismogram.js

networkCode

Type: string

Returns

string

▸ networkCode

src/seismogram.js

networkCode

Type: string

Parameters

value (string)

▸ stationCode

src/seismogram.js

stationCode

Type: string

Returns

string

▸ stationCode

src/seismogram.js

stationCode

Type: string

Parameters

value (string)

▸ locationCode

src/seismogram.js

locationCode

Type: string

Returns

string

▸ locationCode

src/seismogram.js

locationCode

Type: string

Parameters

value (string)

▸ channelCode

src/seismogram.js

channelCode

Type: string

Returns

string

▸ channelCode

src/seismogram.js

channelCode

Type: string

Parameters

value (string)

▸ sampleRate

src/seismogram.js

sampleRate

Type: number

Returns

number

▸ yUnit

src/seismogram.js

yUnit

Type: string

Returns

string

▸ numPoints

src/seismogram.js

numPoints

Type: number

Returns

number

▸ hasCodes()

src/seismogram.js

hasCodes(): boolean

Returns

boolean

▸ codes()

src/seismogram.js

codes(): string

Returns

string

▸ segments

src/seismogram.js

segments

Type: Array<SeismogramSegment>

Returns

Array<SeismogramSegment>

▸ append(seismogram)

src/seismogram.js

append(seismogram: (SeismogramSegment | Seismogram))

Parameters

seismogram ((SeismogramSegment | Seismogram))

▸ cut(timeWindow)

src/seismogram.js

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

cut(timeWindow: StartEndDuration): (null | Seismogram)

Parameters

timeWindow (StartEndDuration) start and end of cut

Returns

(null | Seismogram): new seismogram

▸ trim(timeWindow)

src/seismogram.js

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(timeWindow: StartEndDuration): (null | Seismogram)

Parameters

timeWindow (StartEndDuration) time range to trim to

Returns

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

▸ break(duration)

src/seismogram.js

break(duration: moment.Duration)

Parameters

duration (moment.Duration)

▸ isContiguous()

src/seismogram.js

isContiguous()

▸ merge()

src/seismogram.js

merge(): (Int32Array | Float32Array | Float64Array)

Returns

(Int32Array | Float32Array | Float64Array)

▸ y

src/seismogram.js

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

y

Type: (Int32Array | Float32Array | Float64Array)

Returns

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

Throws

NonContiguousData: if data is not contiguous.

▸ y

src/seismogram.js

y

Type: (Int32Array | Float32Array | Float64Array)

Parameters

val ((Int32Array | Float32Array | Float64Array))

▸ clone()

src/seismogram.js

clone(): Seismogram

Returns

Seismogram

▸ cloneWithNewData(newY)

src/seismogram.js

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

Parameters

newY ((Int32Array | Float32Array | Float64Array))

Returns

Seismogram

NonContiguousData

src/seismogram.js

new NonContiguousData(message: string?)

Extends Error

Parameters

message (string?)

ensureIsSeismogram

src/seismogram.js

ensureIsSeismogram(seisSeismogram: (Seismogram | SeismogramSegment))

Parameters

seisSeismogram ((Seismogram | SeismogramSegment))

SeismogramDisplayData

src/seismogram.js

new SeismogramDisplayData(timeWindow: StartEndDuration)

Parameters

timeWindow (StartEndDuration)

Static Members

▸ fromSeismogram(seismogram)

src/seismogram.js

fromSeismogram(seismogram: Seismogram): SeismogramDisplayData

Parameters

seismogram (Seismogram)

Returns

SeismogramDisplayData

▸ fromChannelAndTimeWindow(channel, timeWindow)

src/seismogram.js

fromChannelAndTimeWindow(channel: Channel, timeWindow: StartEndDuration): SeismogramDisplayData

Parameters

channel (Channel)

timeWindow (StartEndDuration)

Returns

SeismogramDisplayData

▸ fromChannelAndTimes(channel, startTime, endTime)

src/seismogram.js

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

Parameters

channel (Channel)

startTime (moment)

endTime (moment)

Returns

SeismogramDisplayData

Instance Members

▸ _id

src/seismogram.js

_id

Type: (string | null)

▸ label

src/seismogram.js

label

Type: (string | null)

▸ markerList

src/seismogram.js

markerList

Type: Array<MarkerType>

▸ channel

src/seismogram.js

channel

Type: (Channel | null)

▸ _instrumentSensitivity

src/seismogram.js

_instrumentSensitivity

Type: (InstrumentSensitivity | null)

▸ quakeList

src/seismogram.js

quakeList

Type: Array<Quake>

▸ timeWindow

src/seismogram.js

timeWindow

Type: StartEndDuration

▸ alignmentTime

src/seismogram.js

alignmentTime

Type: (moment | null)

▸ doShow

src/seismogram.js

doShow

▸ _statsCache

src/seismogram.js

_statsCache

Type: (SeismogramDisplayStats | null)

▸ addQuake(quake)

src/seismogram.js

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

Parameters

quake ((Quake | Array<Quake>))

▸ addMarkers(markers)

src/seismogram.js

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

Parameters

markers ((MarkerType | Array<MarkerType>))

▸ hasQuake()

src/seismogram.js

hasQuake(): boolean

Returns

boolean

▸ hasSeismogram()

src/seismogram.js

hasSeismogram(): boolean

Returns

boolean

▸ hasChannel()

src/seismogram.js

hasChannel(): boolean

Returns

boolean

▸ hasSensitivity()

src/seismogram.js

hasSensitivity(): boolean

Returns

boolean

▸ id

src/seismogram.js

Allows id-ing a seismogram. Optional.

id

Type: (string | null)

Returns

(string | null): string id

▸ id

src/seismogram.js

Allows iding a seismogram. Optional.

id

Type: (string | null)

Parameters

value ((string | null)) string id

▸ networkCode

src/seismogram.js

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

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

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

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

channelCode

Type: string

Returns

string: channel code

▸ codes(sep)

src/seismogram.js

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

codes(sep: string): string

Parameters

sep

(string
            = '.')

separator, defaults to '.'

Returns

string: nslc codes separated by sep

▸ startTime

src/seismogram.js

startTime

Type: moment

Returns

moment

▸ endTime

src/seismogram.js

endTime

Type: moment

Returns

moment

▸ sensitivity

src/seismogram.js

sensitivity

Type: (InstrumentSensitivity | null)

Returns

(InstrumentSensitivity | null)

▸ sensitivity

src/seismogram.js

sensitivity

Type: (InstrumentSensitivity | null)

Parameters

value ((InstrumentSensitivity | null))

▸ min

src/seismogram.js

min

▸ max

src/seismogram.js

max

▸ mean

src/seismogram.js

mean

▸ seismogram

src/seismogram.js

seismogram

▸ seismogram

src/seismogram.js

seismogram

Type: (Seismogram | null)

Parameters

value ((Seismogram | null))

▸ calcStats()

src/seismogram.js

calcStats()

▸ clone()

src/seismogram.js

clone(): SeismogramDisplayData

Returns

SeismogramDisplayData

▸ cloneWithNewSeismogram(seis)

src/seismogram.js

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

Parameters

seis ((Seismogram | null))

Returns

SeismogramDisplayData

▸ cut(timeWindow)

src/seismogram.js

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

cut(timeWindow: StartEndDuration): (null | SeismogramDisplayData)

Parameters

timeWindow (StartEndDuration) start and end of cut

Returns

(null | SeismogramDisplayData): new seismogramDisplayData

SeismogramDisplayStats

src/seismogram.js

new SeismogramDisplayStats()

Instance Members

▸ min

src/seismogram.js

min

Type: number

▸ max

src/seismogram.js

max

Type: number

▸ mean

src/seismogram.js

mean

Type: number

▸ trendSlope

src/seismogram.js

trendSlope

Type: number

findStartEnd

src/seismogram.js

findStartEnd(sddList: Array<SeismogramDisplayData>): StartEndDuration

Parameters

sddList (Array<SeismogramDisplayData>)

Returns

StartEndDuration

findMinMax

src/seismogram.js

findMinMax(sddList: Array<SeismogramDisplayData>): Array<number>

Parameters

sddList (Array<SeismogramDisplayData>)

Returns

Array<number>

findMinMaxOverTimeRange

src/seismogram.js

findMinMaxOverTimeRange(sddList: Array<SeismogramDisplayData>, timeWindow: StartEndDuration): Array<number>

Parameters

sddList (Array<SeismogramDisplayData>)

timeWindow (StartEndDuration)

Returns

Array<number>

findStartEndOfSeismograms

src/seismogram.js

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

Parameters

data (Array<Seismogram>)

accumulator (StartEndDuration?)

Returns

StartEndDuration

findMinMaxOfSeismograms

src/seismogram.js

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

Parameters

data (Array<Seismogram>)

minMaxAccumulator (Array<number>?)

Returns

Array<number>