API / geotoolkit / seismic / data / SeismicMetaData / SeismicMetaData
data.SeismicMetaData.SeismicMetaData
Seismic meta data is a map of general properties of the seismic data source like: number of traces, sample rate, ... The seismic toolkit creates instances of SeismicMetaData inside the toolkit. Toolkit users do not need to create instances of this class.
Constructors
Methods
Constructors
• new SeismicMetaData(samplePower?)
Creates meta data
| Name | Type | Description |
|---|---|---|
Optional samplePower | number | An integer power of 10 that is multiplied by the sample rate from the seismic dataset header before the sample rate is used. Defaults to -6 if not specified. This default value implies that the sample rate in the dataset is stored in micro-seconds. |
Methods
▸ clone(): SeismicMetaData
Create a copy of seismic meat data
a new instance of meta data
▸ getBinaryHeader(): string
Gets Binary header information or text.
Example
// to get binary header information if it's available and assume you have pipeline instance.
pipeline.getReader().getMetaData().getBinaryHeader();string
Binary header text, which can also be null.
▸ getClassName(): string
string
▸ getEBCDICHeader(): string | string[]
Gets EBCDIC header information or text.
Example
// to get EBCDIC information if it's available and assume you have pipeline instance.
pipeline.getReader().getMetaData().getEBCDICHeader();string | string[]
EBCDIC text, can be null.
▸ getHeaderValues(): Map<string | number, number>
Map<string | number, number>
▸ getIndexType(): IndexType
Returns the index type of the under
▸ getLineHeadersSize(): number
Return header line size in bytes
number
▸ getNullSampleValue(): number
Return sample null value
number
▸ getNumberOfTraces(): number
Gets the number of traces
number
▸ getSampleDataFormat(): SampleDataFormatType
Returns sample data format
▸ getSampleRate(): number
Gets the sample rate for the seismic data. The sample rate is specified in the units returned by
number
▸ getSampleSize(): number
Return sample size in bytes
number
▸ getSamplesPerTrace(): number
Gets the samples per trace
number
▸ getSections(): number[]
Gets the sections.
Sections describes any optional seismic subdivisions.
This is typically used to identify seismic panels in an arbitrary line.
number[]
The sections
▸ getStartValue(): number
Returns start value of first sample.
number
▸ getTraceHeaderSize(): number
Return trace header size in bytes
number
▸ getTraceSize(): number
Gets trace size in bytes
number
▸ getVolumeDefaultKeyNames(): VolumeKeyNames
Returns the volume default key names If available, null otherwise. Those keys are the grid coordinates key names that may eventually be used to map IJ to XY
Json containing default key names
▸ getVolumeKeyNames(): VolumeKeyNames
Returns the volume key names IF available, null otherwise. Those keys are the grid coordinates key names that can eventually be used to map IJ to XY
Json containing key names
▸ getXYKeyInformation(): XYKeyInformation
Returns the XY key information IF available, null otherwise. Those keys can be used to retrieve the X,Y coordinate of a given trace by looking up the values in the header.
Json containing default key names
▸ getZUnit(): AbstractUnit
Returns the sample unit
▸ setOptions(options): SeismicMetaData
Sets options
| Name | Type | Description |
|---|---|---|
options | Options | options |
this
▸ Static getClassName(): string
string