Visual Components
/
/
/
Namespace - RemoteReaderD...
Last updated

API / geotoolkit / seismic / data / RemoteReaderDataProvider / RemoteReaderDataProvider

Namespace: RemoteReaderDataProvider

data.RemoteReaderDataProvider.RemoteReaderDataProvider

Table of contents

Type Aliases
DataGridCoordinatesParsedData
QueryQueryDataQueryKey
QueryPathKeySeismicKeyTraceHeader
TraceHeaderFieldTracesOptions

Contents

Type Aliases

Data

Ƭ Data: Object

Information about data source from server of version

Index signature

▪ [key: string]: any

Type declaration

NameTypeDescription
binary?string[]binary header if exists
compression?{ map?: boolean ; types?: string[] }supported compression algorithms if it exists
compression.map?booleanif map compression is supported
compression.types?string[]algorithms of compression
ebcdic?string[]ebcidic header if exists
gridCoordinates?GridCoordinates[]grid coordinates of corners
indexType?stringindex type from: 2DLINE, VOLUME, GATHER, NONINDEXED
keys?SeismicKey[]an array of keys to make query, where key has options key, max, min, sampleKey
numberOfSamplesnumbernumber of samples in the trace
numberOfTracesnumbernumber of traces in data source
sampleRatenumbersample rate
startValue?numberstart value
statisticsStatisticsstatistics
traceHeader?TraceHeaderinformation about using trace headers
traceOrders?number[]an array of trace order
version?string | numberversion number
volumeDefaultKeyNames?{ i?: string ; j?: string }default keys to be used for volume i and j
volumeDefaultKeyNames.i?stringkey name for i. Like "INLINE"
volumeDefaultKeyNames.j?stringkey name for j like "XLINE"
volumeKeyNames?{ i?: string ; j?: string }keys to be used for volume i and j
volumeKeyNames.i?stringkey name for i. Like "INLINE"
volumeKeyNames.j?stringkey name for j like "XLINE"
xyKeyNames?{ xKeyName?: string ; yKeyName?: string }optional key names to be used to specify X and Y values
xyKeyNames.xKeyName?stringoptional x key name
xyKeyNames.yKeyName?stringoptional y key name
zUnit?stringunit of measure used for Z axis

GridCoordinates

Ƭ GridCoordinates: Object

Define grid coordinates type

Type declaration

NameTypeDescription
valuesnumber[]Contains 4 numbers i and je keys and x and y [i, j, x, y]

ParsedData

Ƭ ParsedData: Object

Parsed information about data source from server version

Index signature

▪ [key: string]: any

Type declaration

NameTypeDescription
compression?{ map?: boolean ; types?: string[] }supported compression algorithms if it exists
compression.map?booleanif map compression is supported
compression.types?string[]algorithms of compression
ebcdic?string[]ebcidic header if exists
keys?SeismicKey[]Seismic keys
mapTraceHeader?BinaryHeaderMap trace header
metadataSeismicMetaDataMeta data
numberOfSamples?numberNumber of samples
numberOfTraces?numberNumber of traces
sampleRate?numberSample rate
sourceId?string | numberSource id
statisticsStatisticsStatistics
traceHeader?BinaryHeaderTrace header
version?string | numberversion number

Query

Ƭ Query: Object

a query in JSON format

Type declaration

NameTypeDescription
agc?booleanAGC is enabled
byteorder?"LITTLE_ENDIAN" | "BIG_ENDIAN"byte order
chunkSize?numberChunk size of compression in samples ZFP and LosslessZFP workflow
decimation?booleandecimation
decimationalgorithm?stringSpecify which decimation algorithm to use in the query, if supported.
There are two types of decimation algorithm:
Level of Details:
- retrieve pre-calculated, lower resolution representation of seismic traces and sample data
- availability depends on data source
Uniform 2D:
- decimate (skip) seismic traces and sample datas
- always available
decimationlevel?numberSpecify level of decimation applied The LOD level numeration system for slices works as follow:
  • Level 0 is full resolution
  • Level 1 is half the resolution (in all axis, so 4x smaller)
  • Level 2 is a quarter of the resolution (16x smaller)
  • and so on...
For Uniform 2D the level numeration system corresponds to actual decimation level:
  • Level 0: full resolution
  • Level 2: decimate by 2 (return every 2nd value)
  • Level 3: decimate by 3
  • Level 5: decimate by 5
g
emptyTraces?booleangenerated empty traces on server
emptyTracesKey?{ max: number ; min: number ; name: string }optional empty trace key
emptyTracesKey.maxnumberMaximum value
emptyTracesKey.minnumberMinimum value
emptyTracesKey.namestringKey name
enableNullSamples?booleanEnable null value support if is supported
error?numberError of compression ZFP workflow if it is supported
includesamples?booleaninclude samples flag
keys?QueryKey[] | QueryPathKey[]optional array of keys to make a query
nullSample?numberNull value sample
options?Record<string, any>additional options to send to server
queryType?stringquery type. It can be 'seismicPath' or null. if it is null then query is done by keys overwise by path.
sampleformat?SampleTypeSpecify sample type
traceOrder?numberdefine type of the query. A traceOrder of 1 indicates a XSection query. The Time key is ignored for XSection queries. A trace order of 2 indicates a Map query. The Time key is required for Map queries, with identical min and max values (a time slice).
workflow?WorkflowType | stringcompression properties

QueryData

Ƭ QueryData: Object

information about data source from server

Type declaration

NameTypeDescription
numberOfSamplesnumbernumber of samples in the trace
numberOfTracesnumbernumber of traces in data source
queryId?stringoptional id of the query
sampleRatenumbersample rate
sections?number[]If the reader has sections, the number of traces in each section.
startValue?numberstart value
statisticsStatisticsstatistics
traceHeader?BinaryHeaderTrace header
version?string | numberversion number

QueryKey

Ƭ QueryKey: Object

Seismic query key to make a query

Type declaration

NameTypeDescription
max?numbermaximum value
min?numberminimum value
namestringname of the key
order?QueryKeyOrderType | stringorder
step?numberincrement

QueryPathKey

Ƭ QueryPathKey: Object

Seismic query key to make query by path

Type declaration

NameTypeDescription
namestringname of the key
values?number[]an array of values instead of min, max, step

SeismicKey

Ƭ SeismicKey: Object

Seismic keys to make query

Type declaration

NameTypeDescription
increment?numberincrement
keystringname of the key
maxnumbermaximum value
minnumberminimum value
order?stringorder
sampleKey?booleansample key

TraceHeader

Ƭ TraceHeader: Object

Represent trace header

Type declaration

NameTypeDescription
fields?TraceHeaderField[]an array of trace header field, which contains: name: string, id: number, type: string, size: number
size?numberSize of the header in bytes

TraceHeaderField

Ƭ TraceHeaderField: Object

TraceHeaderType

Type declaration

NameTypeDescription
idstring | numberidentifier (type)
namestringname of the field
sizenumbersize of the header in bytes
typestring | FieldTypeField type

TracesOptions

Ƭ TracesOptions: Object

read traces properties

Type declaration

NameTypeDescription
byteOrder?"LITTLE_ENDIAN" | "BIG_ENDIAN"byte order
from?numberstart trace number
headers?booleanrequest samples
query?Queryquery
queryId?stringoptional id of the query
samples?booleanrequest samples
sourceId?stringoptional id of the source
to?numberend trace number
traceIndexes?number[]optional array of traces indices

Enumeration - QueryKeyOrderType

Class - RemoteReaderDataProvider