seisplotjs.seismogramsegment 3.0.0-alpha.0 | Documentation

seisplotjs.seismogramsegment

3.0.0-alpha.0

COUNT_UNIT
HighLowType
SeismogramSegment ▸
- Instance members
- #_y
- #_compressed
- #_endTime_cache
- #_endTime_cache_numPoints
- #_sourceId
- #networkCode
- #stationCode
- #locationCode
- #channelCode
- #yUnit
- #_highlow
- #y
- #y
- #start
- #start
- #startTime
- #startTime
- #end
- #endTime
- #timeWindow
- #timeRange
- #sampleRate
- #sampleRate
- #samplePeriod
- #numPoints
- #netCode
- #staCode
- #locId
- #locCode
- #chanCode
- #isEncoded
- #getEncoded
- #yAtIndex
- #findMinMax
- #timeOfSample
- #indexOfTime
- #hasCodes
- #nslc
- #codes
- #seisId
- #sourceId
- #clone
- #cloneWithNewData
- #cut
- #_invalidate_endTime_cache

Need help reading this?

COUNT_UNIT

src/seismogramsegment.ts

COUNT_UNIT

Type: string

HighLowType

src/seismogramsegment.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>)

SeismogramSegment

src/seismogramsegment.ts

A contiguous segment of a Seismogram.

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

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 (DateTime) start time of seismogrm as a luxon DateTime in utc or a string that can be parsed

Instance Members

▸ _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

▸ networkCode

src/seismogramsegment.ts

networkCode

▸ stationCode

src/seismogramsegment.ts

stationCode

▸ locationCode

src/seismogramsegment.ts

locationCode

▸ channelCode

src/seismogramsegment.ts

channelCode

▸ 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

▸ timeWindow

src/seismogramsegment.ts

timeWindow

Type: Interval

Deprecated: This is deprecated.

Returns

Interval

▸ 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

▸ netCode

src/seismogramsegment.ts

netCode

Type: (string | null)

Returns

(string | null)

▸ staCode

src/seismogramsegment.ts

staCode

Type: (string | null)

Returns

(string | null)

▸ locId

src/seismogramsegment.ts

locId

Type: (string | null)

Returns

(string | null)

▸ locCode

src/seismogramsegment.ts

locCode

Type: (string | null)

Returns

(string | null)

▸ chanCode

src/seismogramsegment.ts

chanCode

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

timeOfSample(i: number): DateTime

Parameters

i (number)

Returns

DateTime

▸ 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 '.'

▸ 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 | null)

Returns

(FDSNSourceId | null): FDSN source id

▸ 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()