seisplotjs 3.1.3 | Documentation

▸ _y

src/seismogramsegment.ts

Array of y values

_y

Type: (null | Int32Array | Float32Array | Float64Array)

▸ _compressed

src/seismogramsegment.ts

_compressed

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

▸ _endTime_cache

src/seismogramsegment.ts

_endTime_cache

Type: (null | DateTime)

▸ _endTime_cache_numPoints

src/seismogramsegment.ts

_endTime_cache_numPoints

Type: number

▸ _sourceId

src/seismogramsegment.ts

_sourceId

Type: FDSNSourceId

▸ yUnit

src/seismogramsegment.ts

yUnit

Type: string

▸ _highlow

src/seismogramsegment.ts

_highlow

Type: (HighLowType | undefined)

▸ y

src/seismogramsegment.ts

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/seismogramsegment.ts

y

Type: (Int32Array | Float32Array | Float64Array)

Parameters

value ((Int32Array | Float32Array | Float64Array))

▸ start

src/seismogramsegment.ts

start

Type: DateTime

Returns

DateTime

▸ start

src/seismogramsegment.ts

start

Type: (DateTime | string)

Parameters

value ((DateTime | string))

▸ startTime

src/seismogramsegment.ts

startTime

Type: DateTime

Returns

DateTime

▸ startTime

src/seismogramsegment.ts

startTime

Type: (DateTime | string)

Parameters

value ((DateTime | string))

▸ end

src/seismogramsegment.ts

end

Type: DateTime

Returns

DateTime

▸ endTime

src/seismogramsegment.ts

endTime

Type: DateTime

Returns

DateTime

▸ timeRange

src/seismogramsegment.ts

timeRange

Type: Interval

Returns

Interval

▸ sampleRate

src/seismogramsegment.ts

sampleRate

Type: number

Returns

number

▸ sampleRate

src/seismogramsegment.ts

sampleRate

Type: number

Parameters

value (number)

▸ samplePeriod

src/seismogramsegment.ts

samplePeriod

Type: number

Returns

number

▸ numPoints

src/seismogramsegment.ts

numPoints

Type: number

Returns

number

▸ networkCode

src/seismogramsegment.ts

networkCode

Type: string

Returns

string

▸ stationCode

src/seismogramsegment.ts

stationCode

Type: (string | null)

Returns

(string | null)

▸ locationCode

src/seismogramsegment.ts

locationCode

Type: (string | null)

Returns

(string | null)

▸ channelCode

src/seismogramsegment.ts

channelCode

Type: (string | null)

Returns

(string | null)

▸ isEncoded()

src/seismogramsegment.ts

Checks if the data is encoded

isEncoded(): boolean

Returns

boolean: true if encoded, false otherwise

▸ getEncoded()

src/seismogramsegment.ts

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/seismogramsegment.ts

yAtIndex(i: number): number

Parameters

i (number)

Returns

number

▸ findMinMax(minMaxAccumulator?)

src/seismogramsegment.ts

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

findMinMax(minMaxAccumulator: MinMaxable?): MinMaxable

Parameters

minMaxAccumulator (MinMaxable?) optional initialized accumulator as an array of two numbers, min and max

Returns

MinMaxable: min, max as arry of length two

▸ timeOfSample(i)

src/seismogramsegment.ts

Time of the i-th sample, indexed from zero. If i is negative, counting from end, so timeOfSample(-1) is time of last data point;

timeOfSample(i: number): DateTime

Parameters

i (number) sample index

Returns

DateTime: time

▸ indexOfTime(t)

src/seismogramsegment.ts

indexOfTime(t: DateTime): number

Parameters

t (DateTime)

Returns

number

▸ hasCodes()

src/seismogramsegment.ts

hasCodes(): boolean

Returns

boolean

▸ nslc

src/seismogramsegment.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: nslc codes separated by '.'

▸ nslcId

src/seismogramsegment.ts

nslcId

Type: NslcId

Returns

NslcId

▸ codes(sep)

src/seismogramsegment.ts

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

codes(sep: any): string

Parameters

sep

(any
            = ".")

separator, defaults to '.'

Returns

string: nslc codes separated by sep

▸ seisId()

src/seismogramsegment.ts

seisId(): string

Returns

string

▸ sourceId

src/seismogramsegment.ts

return FDSN source id.

sourceId

Type: FDSNSourceId

Returns

FDSNSourceId: FDSN source id

▸ sourceId

src/seismogramsegment.ts

sourceId

Type: FDSNSourceId

Parameters

sid (FDSNSourceId)

▸ clone()

src/seismogramsegment.ts

clone(): SeismogramSegment

Returns

SeismogramSegment

▸ cloneWithNewData(clonedData, clonedStartTime)

src/seismogramsegment.ts

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

Parameters

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

clonedStartTime

(DateTime
            = this._startTime)

Returns

SeismogramSegment

▸ cut(timeRange)

src/seismogramsegment.ts

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

Parameters

timeRange (Interval)

Returns

(SeismogramSegment | null)

▸ _invalidate_endTime_cache()

src/seismogramsegment.ts

_invalidate_endTime_cache()

seisplotjs

COUNT_UNIT

HighLowType

SeismogramSegment