seisplotjs

3.1.1

COUNT_UNIT

COUNT_UNIT

Type: string

HighLowType

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

MarkerType

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

Properties
name (string)
time (DateTime)
markertype (string)
description (string)
link (string?)

isValidMarker

isValidMarker(v: any): any
Parameters
v (any)
Returns
any

Seismogram

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
fromContiguousData(yArray, sampleRate, startTime, sourceId?)
Instance Members
_segmentArray
_interval
_y
checkAllSimilar()
checkSimilar(f, s)
findStartEnd()
findMinMax(minMaxAccumulator?)
mean()
start
startTime
end
endTime
timeRange
networkCode
stationCode
locationCode
channelCode
sourceId
sourceId
sampleRate
samplePeriod
yUnit
isYUnitCount()
numPoints
hasCodes()
nslc
nslcId
codes()
segments
append(seismogram)
cut(timeRange)
trim(timeRange)
break(duration)
isContiguous()
merge()
y
clone()
cloneWithNewData(newY)

NonContiguousData

new NonContiguousData(message: string?)

Extends Error

Parameters
message (string?)

ensureIsSeismogram

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

SeismogramDisplayData

new SeismogramDisplayData(timeRange: Interval)
Parameters
timeRange (Interval)
Static Members
fromSeismogram(seismogram)
fromSeismogramSegment(seisSegment)
fromContiguousData(yArray, sampleRate, startTime, sourceId?)
fromChannelAndTimeWindow(channel, timeRange)
fromChannelAndTimes(channel, startTime, endTime)
fromSourceIdAndTimes(sourceId, startTime, endTime)
fromCodesAndTimes(networkCode, stationCode, locationCode, channelCode, startTime, endTime)
Instance Members
_id
_sourceId
label
markerList
traveltimeList
channel
_instrumentSensitivity
quakeList
quakeReferenceList
timeRange
alignmentTime
doShow
_statsCache
addQuake(quake)
addQuakeId(publicId)
addMarker(marker)
addMarkers(markers)
addTravelTimes(ttimes)
hasQuake()
quake
hasSeismogram()
append(seismogram)
hasChannel()
hasSensitivity()
id
id
networkCode
stationCode
locationCode
channelCode
sourceId
nslc
nslcId
codes(sep)
startTime
start
endTime
end
numPoints
associateChannel(nets)
alignStartTime()
alignOriginTime()
alignPhaseTime(phaseRegExp)
relativeTimeWindow(alignmentOffset, duration)
sensitivity
sensitivity
min
max
mean
middle
seismogram
seismogram
segments
calcStats()
distazList
distaz
cloneWithNewSeismogram(seis)
cut(timeRange)
trim(timeRange?)
trimInPlace(timeRange?)
toString()

SeismogramDisplayStats

new SeismogramDisplayStats()
Instance Members
min
max
mean
trendSlope
middle

findStartEnd

findStartEnd(sddList: Array<SeismogramDisplayData>): Interval
Parameters
Returns
Interval

findMaxDuration

findMaxDuration(sddList: Array<SeismogramDisplayData>): Duration
Parameters
Returns
Duration

findMaxDurationOfType

Finds max duration of from one of starttime of sdd, origin time of earthquake, or alignmentTime.

findMaxDurationOfType(type: string, sddList: Array<SeismogramDisplayData>): Duration
Parameters
type (string) one of start, origin or align
sddList (Array<SeismogramDisplayData>) list of seis data
Returns
Duration: max duration

findMinMax

Finds the min and max amplitude over the seismogram list, considering gain and how to center the seismograms, either Rw, MinMax or Mean.

findMinMax(sddList: Array<SeismogramDisplayData>, doGain: any, ampCentering: AMPLITUDE_MODE): MinMaxable
Parameters
sddList (Array<SeismogramDisplayData>) list of seismogramdisplaydata
doGain (any = false) should gain be used
ampCentering (AMPLITUDE_MODE = AMPLITUDE_MODE.MinMax) centering style
Returns
MinMaxable: min max

findMinMaxOverTimeRange

findMinMaxOverTimeRange(sddList: Array<SeismogramDisplayData>, timeRange: (Interval | null), doGain: any, ampCentering: AMPLITUDE_MODE): MinMaxable
Parameters
timeRange ((Interval | null) = null)
doGain (any = false)
ampCentering (AMPLITUDE_MODE = AMPLITUDE_MODE.MinMax)
Returns
MinMaxable

findMinMaxOverRelativeTimeRange

findMinMaxOverRelativeTimeRange(sddList: Array<SeismogramDisplayData>, alignmentOffset: Duration, duration: Duration, doGain: any, ampCentering: AMPLITUDE_MODE): MinMaxable
Parameters
alignmentOffset (Duration)
duration (Duration)
doGain (any = false)
ampCentering (AMPLITUDE_MODE = AMPLITUDE_MODE.MinMax)
Returns
MinMaxable

calcMinMax

calcMinMax(sdd: SeismogramDisplayData, timeRange: (Interval | null), doGain: any, ampCentering: AMPLITUDE_MODE): (MinMaxable | null)
Parameters
timeRange ((Interval | null) = null)
doGain (any = false)
ampCentering (AMPLITUDE_MODE = AMPLITUDE_MODE.MinMax)
Returns
(MinMaxable | null)

findStartEndOfSeismograms

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

findMinMaxOfSeismograms

findMinMaxOfSeismograms(data: Array<Seismogram>, minMaxAccumulator: MinMaxable?): MinMaxable
Parameters
data (Array<Seismogram>)
minMaxAccumulator (MinMaxable?)
Returns
MinMaxable

findMinMaxOfSDD

findMinMaxOfSDD(data: Array<SeismogramDisplayData>, minMaxAccumulator: MinMaxable?): MinMaxable
Parameters
minMaxAccumulator (MinMaxable?)
Returns
MinMaxable

uniqueStations

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

uniqueChannels

uniqueChannels(seisData: Array<SeismogramDisplayData>): Array<Channel>
Parameters
Returns
Array<Channel>

uniqueQuakes

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