API / geotoolkit / seismic / data / SeismicReader / SeismicReader
data.SeismicReader.SeismicReader
Seismic reader reads seismic data from the different sources and provides it to trace processor in uniform representation as a collection of traces,
where a trace is a collection of samples. A trace is logically subdivided into zero or more trace headers and zero or more samples.
Seismic Reader also returns information about seismic data, like number of many traces it has, number of samples per trace,
unit of samples, sample rate and also provides trace headers information.
↳
SeismicReader↳↳
MemoryReader
Constructors
Methods
Constructors
• Protected new SeismicReader(options?)
Creates reader
| Name | Type | Description |
|---|---|---|
Optional options | number | Options | nullValue or options is passed when a value does not exist. There will be a break in the wiggles in that area. Fill will not fill that area. User can set a custom color for NullValue |
SeismicData.constructor
Methods
▸ Protected copyConstructor(src, deepCopy?): SeismicReader
Copy constructor function.
Function used as part of the cloning mechanism.
Implementations should copy the given instance state to this instance.
| Name | Type | Description |
|---|---|---|
src | SeismicReader | Source to copy from |
Optional deepCopy | boolean | deep copy |
this
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ Abstract getMetaData(): SeismicMetaData
Returns seismic meta data information
▸ Abstract getModelLimits(): Rect
Returns seismic model limits
▸ getNullValue(): number
Returns null value
number
null value
▸ Abstract getNumberOfSamples(): number
Returns number of samples
number
▸ Abstract getNumberOfTraces(): number
Returns number of traces
number
▸ getOptions(): any
Returns supported extra options
any
options options
▸ getOriginalMetaData(): SeismicMetaData
Returns seismic original meta data information before any decimation
▸ Abstract getSampleRate(): number
Returns sample rate . Sample rate is the number of times an analog signal is measured (sampled) per second.
Basically it is a difference between nearest sample values. This term comes from digital signal processing and defines how
continuous signal is sampled. For example: 0.004/ second
number
▸ Abstract getStatistics(): Statistics
Gets statistics such as min, max, average, rms
▸ getTimeStamp(): number
Return the value to indicate if data was changed
number
▸ Abstract getTraceHeaderFields(): FieldDesc[]
Returns an array of field descriptors for the dataset read by this seismic reader.
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
▸ invalidate(rect?): void
Invalidate data and notify that data is changed
| Name | Type | Description |
|---|---|---|
Optional rect | Rect | optional area of tracers and samples to invalidate. It is not supported now |
void
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ Abstract loadMetaData(callback): void
Load SeismicMetaData seismic metadata. Seismic metadata is a map of general properties of the seismic data source like: number of traces, sample rate.
| Name | Type | Description |
|---|---|---|
callback | (reader: SeismicReader) => void | method to be called when data is ready |
void
▸ notify<E>(type, source, args?): SeismicReader
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | SeismicReader | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): SeismicReader
Detach listener on event. Calling .off() with no arguments removes all attached listeners. Calling .off(type) with no callback removes all attached listeners for specific type.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: SeismicReader, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): SeismicReader
Attach listener on event that will be called whenever the specified event is delivered to the target
If the callback function is already in the list of event listeners for this target, the function is not added a second time.
If a particular anonymous function is in the list of event listeners registered for a certain target, and then later in the code, an identical anonymous function is given in an "on" call, the second function will also be added to the list of event listeners for that target.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: SeismicReader, args: EventMap[E]) => void | to be called |
this
▸ queryInterface<T>(someInterface): InstanceType<T>
Returns interface, if reader can provide it
| Name | Type |
|---|---|
T | extends Constructor<any> |
| Name | Type | Description |
|---|---|---|
someInterface | T | interface |
InstanceType<T>
internal instance of this interface
▸ Abstract select(query, callback): void
returns seismic trace section
Example
// to read a specific range of traces
reader.select({
'from': 10,
'to': 20
}, (fetchResult) => {
// fetchResult is instance of @int/geotoolkit/seismic/data/QueryResult
fetchResult.foreach((index, section) => {
for (let i = 10; i <= 20; i++) {
console.log(section.getTrace(i));
}
});
});Example
// selection by trace indices
reader.select({
'traceIndexes': [15, 20]
}, (fetchResult) => { ... });| Name | Type | Description |
|---|---|---|
query | SelectQuery | this specifies the condition of the request |
callback | SelectCallback | method to be called when data is ready |
void
▸ setSilent(bool): SeismicReader
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ update(options?, callback?): void
Update seismic query and returns meta information
| Name | Type | Description |
|---|---|---|
Optional options | Record<string, any> | this specifies the condition of the request |
Optional callback | UpdateCallback | method to be called when data is ready |
void
▸ Protected updateTimeStamp(): void
Update time stamp
void
▸ Static getClassName(): string
string