API / geotoolkit / seismic / data / RemoteSeismicReader / RemoteSeismicReader
data.RemoteSeismicReader.RemoteSeismicReader
RemoteSeismicReader is a reader that can access data on a server rather than on a local file.
This implementation follows the INTGeoServer(© Interactive Network Technologies, Inc.) API.
Meaning that it can be used out of the box to fetch traces from an INTGeoServer(© Interactive Network Technologies, Inc.).
This class uses internally xhr and binary transfer to fetch the traces from the server.
↳
RemoteSeismicReader
Properties
Accessors
Methods
Constructors
• new RemoteSeismicReader(datasource, options?, nullValue?)
Creates reader
| Name | Type | Description |
|---|---|---|
datasource | RemoteSeismicDataSource | The datasource for this reader |
Optional options | number | Options | The options to use |
Optional nullValue | number | nullValue 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 |
SeismicReader.constructor
Accessors
• Static get DefaultWorkflow(): string
The default workflow constant. By default no compression will be done.
Constant
Default
string
Methods
▸ Protected copyConstructor(src, deepCopy?): RemoteSeismicReader
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
▸ getDataProvider(): RemoteReaderDataProvider
Return instance of data provider
▸ getHost(): string
Returns host name
string
▸ getMetaData(): SeismicMetaData
Returns seismic meta data information
▸ getModelLimits(): Rect
Returns seismic model limits
▸ getNullValue(): number
Returns null value
number
null value
▸ getNumberOfSamples(): number
Returns number of samples
number
SeismicReader.getNumberOfSamples
▸ getNumberOfTraces(): number
Returns number of traces
number
SeismicReader.getNumberOfTraces
▸ getOriginalMetaData(): SeismicMetaData
Returns seismic original meta data information before any decimation
SeismicReader.getOriginalMetaData
▸ getSampleRate(): number
Returns sample rate
number
▸ getSeismicFileName(): string
Returns file name
string
▸ getStatistics(): Statistics
Returns statistics
data statistics
▸ getTimeStamp(): number
Return the value to indicate if data was changed
number
▸ getTraceHeaderFields(): FieldDesc[]
Returns an array of field descriptors for the dataset read by this seismic reader.
array of header descriptors
SeismicReader.getTraceHeaderFields
▸ 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
SeismicReader.hasEventListener
▸ 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
▸ 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?): RemoteSeismicReader
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?): RemoteSeismicReader
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: RemoteSeismicReader, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): RemoteSeismicReader
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: RemoteSeismicReader, 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
▸ release(): void
Notify server that reader resources can be released on server
void
▸ select(query, callback): Promise<void>
Select seismic trace sections and then call "callback" method. This function executes a 'select' operation using the given query.
The query is executed server side (for RemoteSeismicReader) to filter the traces requested by the client side.
The servers sends back the data, and when the request is finalized, the given callback function is called with the result.
| Name | Type | Description |
|---|---|---|
query | SelectQuery | a condition in JSON format |
callback | SelectCallback | callback to be called when section is loaded |
Promise<void>
▸ setSilent(bool): RemoteSeismicReader
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ update(query?, callback?): void
Update reader by making new seismic query
| Name | Type | Description |
|---|---|---|
Optional query | 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