seisplotjs 3.1.4 | Documentation

seisplotjs

3.1.4

json_object
MINISEED_THREE_MIME
UNKNOWN_DATA_VERSION
CRC_OFFSET
FIXED_HEADER_SIZE
FDSN_PREFIX
LITTLE_ENDIAN
BIG_ENDIAN
toMSeed3
parseMSeed3Records
MSeed3Record ▸
- Static members
- .parseSingleDataRecord
- Instance members
- #header
- #extraHeaders
- #rawData
- #calcSize
- #getSize
- #decompress
- #asEncodedDataSegment
- #codes
- #save
- #calcCrc
- #toString
MSeed3Header ▸
- Static members
- .createFromDataView
- Instance members
- #recordIndicator
- #formatVersion
- #flags
- #nanosecond
- #year
- #dayOfYear
- #hour
- #minute
- #second
- #encoding
- #sampleRateOrPeriod
- #numSamples
- #crc
- #publicationVersion
- #identifierLength
- #extraHeadersLength
- #identifier
- #extraHeaders
- #dataLength
- #start
- #end
- #sampleRate
- #samplePeriod
- #getSize
- #encodingName
- #toString
- #startFieldsInUtilFormat
- #getStartFieldsAsISO
- #setStart
- #timeOfSample
- #save
- #startAsDateTime
parseExtraHeaders
padZeros
makeString
areContiguous
createSeismogramSegment
merge
mergeSegments
byChannel
seismogramSegmentPerChannel
seismogramPerChannel
sddPerChannel
convertMS2toMSeed3
convertMS2Record
calculateCRC32C
crcToHexString

Need help reading this?

json_object

src/mseed3.ts

json_object

Type: Record<string, any>

MINISEED_THREE_MIME

src/mseed3.ts

MINISEED_THREE_MIME

Type: string

UNKNOWN_DATA_VERSION

src/mseed3.ts

const for unknown data version, 0

UNKNOWN_DATA_VERSION

Type: number

CRC_OFFSET

src/mseed3.ts

const for offset to crc in record, 28

CRC_OFFSET

Type: number

FIXED_HEADER_SIZE

src/mseed3.ts

const for size of fixed header part of record, 40

FIXED_HEADER_SIZE

Type: number

FDSN_PREFIX

src/mseed3.ts

const for fdsn prefix for extra headers, FDSN

FDSN_PREFIX

Type: string

LITTLE_ENDIAN

src/mseed3.ts

const for little endian, true

LITTLE_ENDIAN

Type: boolean

BIG_ENDIAN

src/mseed3.ts

const for big endian, false

BIG_ENDIAN

Type: boolean

toMSeed3

src/mseed3.ts

toMSeed3(seis: Seismogram, extraHeaders: Record<string, any>?): Array<MSeed3Record>

Parameters

seis (Seismogram)

extraHeaders (Record<string, any>?)

Returns

Array<MSeed3Record>

parseMSeed3Records

src/mseed3.ts

parse arrayBuffer into an array of MSeed3Records.

parseMSeed3Records(arrayBuffer: ArrayBuffer): Array<MSeed3Record>

Parameters

arrayBuffer (ArrayBuffer) bytes to extract miniseed3 records from

Returns

Array<MSeed3Record>: array of all miniseed3 records contained in the buffer

MSeed3Record

src/mseed3.ts

Represents a MSEED3 Data Record, with header, extras and data.

new MSeed3Record(header: MSeed3Header, extraHeaders: Record<string, any>, rawData: DataView)

Parameters

header (MSeed3Header) miniseed3 fixed record header

extraHeaders (Record<string, any>) json compatible object with extra headers

rawData (DataView) waveform data, in correct compression for value in header

Static Members

▸ parseSingleDataRecord(dataView)

src/mseed3.ts

Parses an miniseed3 data record from a DataView.

parseSingleDataRecord(dataView: DataView): MSeed3Record

Parameters

dataView (DataView) bytes to parse

Returns

MSeed3Record: parsed record

Instance Members

▸ header

src/mseed3.ts

header

Type: MSeed3Header

▸ extraHeaders

src/mseed3.ts

extraHeaders

Type: Record<string, any>

▸ rawData

src/mseed3.ts

rawData

Type: DataView

▸ calcSize()

src/mseed3.ts

Calculates the byte size of the miniseed3 record to hold this data. This should be called if the size is needed after modification of the extraHeaders.

calcSize(): number

Returns

number: size in bytes

▸ getSize()

src/mseed3.ts

Gets the byte size of the miniseed3 record to hold this data. Note that unless calcSize() has been called, this may not take into account modifications to the extra headers.

getSize(): number

Returns

number: size in bytes

▸ decompress()

src/mseed3.ts

Decompresses the data , if the compression type is known

decompress(): (Int32Array | Float32Array | Float64Array)

Returns

(Int32Array | Float32Array | Float64Array): decompressed data as a typed array, usually Int32Array or Float32Array

▸ asEncodedDataSegment()

src/mseed3.ts

Wraps data in an EncodedDataSegment for future decompression.

asEncodedDataSegment(): EncodedDataSegment

Returns

EncodedDataSegment: waveform data

▸ codes()

src/mseed3.ts

Just the header.identifier, included as codes() for compatiblility with parsed miniseed2 data records.

codes(): string

Returns

string: string identifier

▸ save(dataView)

src/mseed3.ts

Saves miniseed3 record into a DataView, recalculating crc.

save(dataView: DataView): number

Parameters

dataView (DataView) DataView to save into, must be large enough to hold the record.

Returns

number: the number of bytes written to the DataView, can be used as offset for writting the next record.

▸ calcCrc()

src/mseed3.ts

Calculates crc by saving to a DataView, which sets the crc header to zero and then calculates it based on the rest of the record.

calcCrc(): number

Returns

number: crc pulled from saved miniseed3 record

▸ toString()

src/mseed3.ts

toString(): string

Returns

string

MSeed3Header

src/mseed3.ts

Fixed header of an MSeed3 data record.

new MSeed3Header()

Static Members

▸ createFromDataView(dataView)

src/mseed3.ts

Parses an miniseed3 fixed header from a DataView.

createFromDataView(dataView: DataView): MSeed3Header

Parameters

dataView (DataView) bytes to parse

Returns

MSeed3Header: parsed header object

Instance Members

▸ recordIndicator

src/mseed3.ts

recordIndicator

Type: string

▸ formatVersion

src/mseed3.ts

formatVersion

Type: number

▸ flags

src/mseed3.ts

flags

Type: number

▸ nanosecond

src/mseed3.ts

nanosecond

Type: number

▸ year

src/mseed3.ts

year

Type: number

▸ dayOfYear

src/mseed3.ts

dayOfYear

Type: number

▸ hour

src/mseed3.ts

hour

Type: number

▸ minute

src/mseed3.ts

minute

Type: number

▸ second

src/mseed3.ts

second

Type: number

▸ encoding

src/mseed3.ts

encoding

Type: number

▸ sampleRateOrPeriod

src/mseed3.ts

sampleRateOrPeriod

Type: number

▸ numSamples

src/mseed3.ts

numSamples

Type: number

▸ crc

src/mseed3.ts

crc

Type: number

▸ publicationVersion

src/mseed3.ts

publicationVersion

Type: number

▸ identifierLength

src/mseed3.ts

identifierLength

Type: number

▸ extraHeadersLength

src/mseed3.ts

extraHeadersLength

Type: number

▸ identifier

src/mseed3.ts

identifier

Type: string

▸ extraHeaders

src/mseed3.ts

extraHeaders

Type: json_object

▸ dataLength

src/mseed3.ts

dataLength

Type: number

▸ start

src/mseed3.ts

start

▸ end

src/mseed3.ts

end

▸ sampleRate

src/mseed3.ts

sampleRate

▸ samplePeriod

src/mseed3.ts

samplePeriod

▸ getSize()

src/mseed3.ts

Calculates size of the fixed header including the variable length identifier, but without the extra headers.

getSize(): number

Returns

number: size in bytes of fixed header

▸ encodingName()

src/mseed3.ts

encodingName(): string

Returns

string

▸ toString()

src/mseed3.ts

Text representation of the miniseed3 header. This is modeled after the output of mseed3-text from the mseed3-utils package from IRIS.

toString(): string

Returns

string: textual repersentation

▸ startFieldsInUtilFormat()

src/mseed3.ts

Start time in the format output by mseed3-utils from IRIS. Format is yyyy,ooo,HH:mm:ss.SSSSSS

startFieldsInUtilFormat(): string

Returns

string: start time

▸ getStartFieldsAsISO(trimMicroNano)

src/mseed3.ts

Converts start time header fields to ISO8601 time string. This will include factional seconds to nanosecond precision.

getStartFieldsAsISO(trimMicroNano: any): string

Parameters

trimMicroNano

(any
            = true)

trim to microsecond precision if nanos are 000

Returns

string: iso start time

▸ setStart(starttime)

src/mseed3.ts

sets start time headers.

setStart(starttime: DateTime)

Parameters

starttime (DateTime) start as DateTime

▸ timeOfSample(i)

src/mseed3.ts

Calculates time of the ith sample.

timeOfSample(i: number): DateTime

Parameters

i (number) sample number

Returns

DateTime: the time

▸ save(dataView, offset, zeroCrc)

src/mseed3.ts

Writes to the given dataview.

save(dataView: DataView, offset: any, zeroCrc: any): number

Parameters

dataView (DataView) write buffer

offset

(any
            = 0)

offset within the buffer

zeroCrc

(any
            = false)

optionally zero out the crc field in order to recalculate

Returns

number: new offset after this record

▸ startAsDateTime()

src/mseed3.ts

Converts header start time to DateTime

startAsDateTime(): DateTime

Returns

DateTime: start time as DateTime

parseExtraHeaders

src/mseed3.ts

Parses extra headers as json.

parseExtraHeaders(dataView: DataView): Record<string, any>

Parameters

dataView (DataView) json bytes as DataView

Returns

Record<string, any>: json object

padZeros

src/mseed3.ts

Creates a string version of a number with zero prefix padding. For example padZeros(5, 3) is 005.

padZeros(val: number, len: number): string

Parameters

val (number) number to stringify

len (number) total length of string

Returns

string: zero padded string

makeString

src/mseed3.ts

creates a string from utf-8 bytes in a DataView.

makeString(dataView: DataView, offset: number, length: number): string

Parameters

dataView (DataView) data bytes

offset (number) offset to first byte to use

length (number) number of bytes to convert

Returns

string: string resulting from utf-8 conversion

areContiguous

src/mseed3.ts

Checks if two miniseed3 records are (nearly) contiguous.

areContiguous(dr1: MSeed3Record, dr2: MSeed3Record, sampRatio: any): boolean

Parameters

dr1 (MSeed3Record) first record

dr2 (MSeed3Record) second record

sampRatio

(any
            = 1.5)

tolerence expressed as ratio of sample period, default 1.5

Returns

boolean: true if contiguous

createSeismogramSegment

src/mseed3.ts

Concatentates a sequence of MSeed3 Records into a single seismogram object. Assumes that they are all contiguous (no gaps or overlaps) and in order. Header values from the first MSeed3 Record are used.

createSeismogramSegment(contig: Array<MSeed3Record>): SeismogramSegment

Parameters

contig (Array<MSeed3Record>) array of miniseed3 records

Returns

SeismogramSegment: seismogram segment for the records

merge

src/mseed3.ts

Merges miniseed3 records into a Seismogram object, each of which consists of SeismogramSegment objects containing the data as EncodedDataSegment objects. DataRecords are sorted by startTime. This assumes all data records are from the same channel, byChannel can be used first if multiple channels may be present. Gaps may be present.

merge(drList: Array<MSeed3Record>): Seismogram

Parameters

drList (Array<MSeed3Record>) list of miniseed3 records to convert

Returns

Seismogram: the seismogram

mergeSegments

src/mseed3.ts

merges contiguous MSeed3Record into SeismogramSegments.

mergeSegments(drList: Array<MSeed3Record>): Array<SeismogramSegment>

Parameters

drList (Array<MSeed3Record>) array of data records

Returns

Array<SeismogramSegment>: array of SeismogramSegments for contiguous data

byChannel

src/mseed3.ts

splits a list of data records by channel identifier, returning an object with each NSLC mapped to an array of data records.

byChannel(drList: Array<MSeed3Record>): Map<string, Array<MSeed3Record>>

Parameters

drList (Array<MSeed3Record>) array of miniseed3 records

Returns

Map<string, Array<MSeed3Record>>: map of channel id to array of miniseed3 records, possibly not contiguous

seismogramSegmentPerChannel

src/mseed3.ts

splits the records by channel and creates a single SeismogramSegment for each contiguous window from each channel.

seismogramSegmentPerChannel(drList: Array<MSeed3Record>): Array<SeismogramSegment>

Parameters

drList (Array<MSeed3Record>) MSeed3Records array

Returns

Array<SeismogramSegment>: Array of SeismogramSegment

seismogramPerChannel

src/mseed3.ts

splits the MSeed3Records by channel and creates a single Seismogram for each channel.

seismogramPerChannel(drList: Array<MSeed3Record>): Array<Seismogram>

Parameters

drList (Array<MSeed3Record>) MSeed3Records array

Returns

Array<Seismogram>: Map of code to Seismogram

sddPerChannel

src/mseed3.ts

splits the MSeed3Records by channel and creates a single SeismogramDisplayData for each channel. BAG extra headers are extracted and Quake and Markers are created.

sddPerChannel(drList: Array<MSeed3Record>): Array<SeismogramDisplayData>

Parameters

drList (Array<MSeed3Record>) MSeed3Records array

Returns

Array<SeismogramDisplayData>: Map of code to Seismogram

convertMS2toMSeed3

src/mseed3.ts

Convert array of Miniseed2 DataRecords into an array of MSeed3Records.

convertMS2toMSeed3(mseed2: Array<DataRecord>): Array<MSeed3Record>

Parameters

mseed2 (Array<DataRecord>) array of DataRecords

Returns

Array<MSeed3Record>: array of MSeed3Records

convertMS2Record

src/mseed3.ts

Converts a single miniseed2 DataRecord into a single MSeed3Record.

convertMS2Record(ms2record: DataRecord): MSeed3Record

Parameters

ms2record (DataRecord) Miniseed2 DataRecord to convert

Returns

MSeed3Record: MSeed3Record

calculateCRC32C

src/mseed3.ts

Copy from https://github.com/ashi009/node-fast-crc32c/blob/master/impls/js_crc32c.js and modify to use ArrayBuffer. Rename calculateCRC32C

This code is a manual javascript translation of c code generated by pycrc 0.7.1 (https://www.tty1.net/pycrc/). Command line used: './pycrc.py --model=crc-32c --generate c --algorithm=table-driven'

calculateCRC32C(buf: (ArrayBuffer | Uint8Array), initial: any): number

Parameters

buf ((ArrayBuffer | Uint8Array)) input data

initial

(any
            = 0)

starting value, from earlier data

Returns

number: calculated crc32c value

crcToHexString

src/mseed3.ts

Convert crc as a number into a hex string.

crcToHexString(crc: number): string

Parameters

crc (number) crc as a number

Returns

string: hex representation