API / geotoolkit / ivaapbackend / well / RemoteWellLogDataSource / RemoteWellLogDataSource
well.RemoteWellLogDataSource.RemoteWellLogDataSource
Provides utility class to load wells data from IVAAP backend
↳
RemoteWellLogDataSource
Constructors
- [new RemoteWellLogDataSource(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.ivaapbackend.well.remotewelllogdatasource.remotewelllogdatasource.md#new remotewelllogdatasource(options))
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
hostname | string | The host name for requests |
Constructors
• new RemoteWellLogDataSource(options?)
| Name | Type |
|---|---|
Optional options | Options |
CommonRemoteDataSource.constructor
Methods
▸ createRasterLogTileProvider(dataset, options?): RasterLogProvider
Creates a RasterLogProvider for displaying a raster log image. The provider wraps the IVAAP tile service and applies WebGL image transformation (morphing correction) on each tile.
Throws
if no matching image section is found in the dataset
| Name | Type | Description |
|---|---|---|
dataset | RasterLogDataset | the raster log dataset returned by loadRasterLogData |
Optional options | Object | tile provider options |
Optional options.contentType | string | image section type to display; defaults to 'body' |
Optional options.metadataUrl | string | full URL used to load the dataset; when provided, the provider uses it to fetch image types not present in the dataset (e.g. 'TopScale' header images) by substituting the content-type value in the URL and appending /content |
Optional options.segmentId | string | specific segment id; if omitted, the first matching section is used |
configured raster log tile provider
▸ dispose(): void
Dispose
void
CommonRemoteDataSource.dispose
▸ getClassName(): string
string
CommonRemoteDataSource.getClassName
▸ getHostName(): string
Gets host name
string
CommonRemoteDataSource.getHostName
▸ getHttpService(): AbstractHttpService
Gets a http service associated with this data source
CommonRemoteDataSource.getHttpService
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
An object containing the properties
CommonRemoteDataSource.getProperties
▸ Protected loadCollection<T>(url): Promise<DataCollection<T>>
Loads datasets collection
| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> |
| Name | Type | Description |
|---|---|---|
url | string | the collection url |
Promise<DataCollection<T>>
CommonRemoteDataSource.loadCollection
▸ Protected loadDataSet<T>(url): Promise<T>
Loads an individual dataset
| Name | Type | Description |
|---|---|---|
url | string | the data url |
Promise<T>
CommonRemoteDataSource.loadDataSet
▸ loadDeviationCurveValues(deviationData, curveIds?, minIndex?, maxIndex?, indexType?): Promise<CurveInfo[]>
Loads the values of an individual well deviation curve along with the values of its index curve
| Name | Type | Description |
|---|---|---|
deviationData | Dataset<Record<string, any>> | the well deviation dataset |
Optional curveIds | number[] | the collection of curve indices within the specified well |
Optional minIndex | number | the minimum index of the values to query |
Optional maxIndex | number | the maximum index of the values to query |
Optional indexType | string | the hint on the type of min/max index being passed. This can be <em>datetime</em> or <em>long</em>, otherwise <em>double</em> will be used |
Promise<CurveInfo[]>
▸ loadDeviationData<T>(data): Promise<T>
Loads info about an individual well deviation
| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> = DeviationDataset |
| Name | Type | Description |
|---|---|---|
data | Dataset<Record<string, any>> | the dataset containing link to well deviation metadata |
Promise<T>
▸ loadDeviationsMeta<T>(data): Promise<DataCollection<T>>
Loads info about all well deviations of an individual well
| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> = DeviationDataset |
| Name | Type | Description |
|---|---|---|
data | Dataset<Record<string, any>> | the dataset containing link to well deviations collection |
Promise<DataCollection<T>>
▸ loadLogCurveValues(logData, curveIds?, minIndex?, maxIndex?, indexType?): Promise<CurveInfo[]>
Loads the values of an individual well curve along with the values of its index curve
| Name | Type | Description |
|---|---|---|
logData | Dataset<Record<string, any>> | the well log dataset |
Optional curveIds | number[] | the collection of curve indices within the specified well |
Optional minIndex | number | the minimum index of the values to query |
Optional maxIndex | number | the maximum index of the values to query |
Optional indexType | string | the hint on the type of min/max index being passed. This can be <em>datetime</em> or <em>long</em>, otherwise <em>double</em> will be used |
Promise<CurveInfo[]>
▸ loadLogData<T>(data): Promise<T>
Loads info about an individual well log
| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> = LogDataset |
| Name | Type | Description |
|---|---|---|
data | Dataset<Record<string, any>> | the dataset containing link to well log metadata |
Promise<T>
▸ loadLogsMeta<T>(data): Promise<DataCollection<T>>
Loads info about all well logs of an individual well
| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> = LogDataset |
| Name | Type | Description |
|---|---|---|
data | Dataset<Record<string, any>> | the dataset containing link to well logs collection |
Promise<DataCollection<T>>
▸ loadMeta(url): Promise<Data>
Loads meta data
| Name | Type | Description |
|---|---|---|
url | string | url of meta information |
Promise<Data>
CommonRemoteDataSource.loadMeta
▸ loadMudLogData<T>(mudLogMeta): Promise<T>
Loads info about an individual well mud log
| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> = MudLogDataset |
| Name | Type | Description |
|---|---|---|
mudLogMeta | Dataset<Record<string, any>> | the dataset containing link to well mud log metadata |
Promise<T>
▸ loadMudLogsMeta<T>(data): Promise<DataCollection<T>>
Loads info about all well mud logs of an individual well bore
| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> = MudLogDataset |
| Name | Type | Description |
|---|---|---|
data | Dataset<Record<string, any>> | the dataset containing link to well mud logs collection |
Promise<DataCollection<T>>
▸ loadRasterLogData<T>(data): Promise<T>
Loads metadata for an individual raster log from the IVAAP rasterlogimages endpoint. The returned dataset contains the list of available image sections (body, header, etc.) with depth range and tile link information.
Example
const dataset = await remoteWellLogDataSource.loadRasterLogData(RASTER_LOG_URL);
const provider = remoteWellLogDataSource.createRasterLogTileProvider(dataset);| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> = RasterLogDataset |
| Name | Type | Description |
|---|---|---|
data | string | Dataset<Record<string, any>> | the raster log metadata URL, or a dataset whose self link points to the metadata |
Promise<T>
promise that resolves to the raster log metadata dataset
▸ loadWellBoreData<T>(data): Promise<T>
Loads info about an individual well bore
| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> = WellBoreDataset |
| Name | Type | Description |
|---|---|---|
data | Dataset<Record<string, any>> | the dataset containing link to well bore metadata |
Promise<T>
▸ loadWellBoreProperties(data): Promise<DatasetInfo>
Loads info about available properties of an individual well bore
| Name | Type | Description |
|---|---|---|
data | Dataset<Record<string, any>> | the dataset containing link to well bore metadata |
Promise<DatasetInfo>
▸ loadWellBoresMeta<T>(data): Promise<DataCollection<T>>
Loads info about well bores of an individual well
| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> = WellBoreDataset |
| Name | Type | Description |
|---|---|---|
data | Dataset<Record<string, any>> | the dataset containing link to well bores collection |
Promise<DataCollection<T>>
▸ loadWellData<T>(data): Promise<T>
Loads info about an individual well
| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> = WellDataset |
| Name | Type | Description |
|---|---|---|
data | string | Dataset<Record<string, any>> | the dataset containing link to well metadata or well metadata url |
Promise<T>
▸ loadWellProperties(data): Promise<DatasetInfo>
Loads info about available properties of an individual well
| Name | Type | Description |
|---|---|---|
data | Dataset<Record<string, any>> | the dataset containing link to well metadata |
Promise<DatasetInfo>
▸ loadWellsMeta<T>(data): Promise<DataCollection<T>>
Loads info about wells collection
| Name | Type |
|---|---|
T | extends Dataset<Record<string, any>> = WellDataset |
| Name | Type | Description |
|---|---|---|
data | string | Dataset<Record<string, any>> | the dataset containing link to wells collection or wells collection url |
Promise<DataCollection<T>>
▸ Protected setHostName(host): RemoteWellLogDataSource
Sets host name
| Name | Type | Description |
|---|---|---|
host | string | the host name |
CommonRemoteDataSource.setHostName
▸ Protected setHttpService(service): RemoteWellLogDataSource
Sets a http service associated with this data source
| Name | Type | Description |
|---|---|---|
service | AbstractHttpService | the http service |
CommonRemoteDataSource.setHttpService
▸ setProperties(properties?): RemoteWellLogDataSource
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | An object containing the properties to set |
this
CommonRemoteDataSource.setProperties
▸ Static getClassName(): string
string