模块：ol/source/SentinelHub

类

SentinelHub

类型定义

AccessTokenClaims{Object}

属性:

Name	Type	描述
exp	number	令牌过期时间（秒）

AuthConfig{Object}

属性:

Name	Type	描述
tokenUrl	string (defaults to 'https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token')	用于获取身份验证令牌的URL。
clientId	string	客户端 ID。
clientSecret	string	客户端密钥。

Collections{Object}

属性:

Name	Type	描述
from	string | undefined	在‘ORBIT’镶嵌过程中，这将是搜索间隔的起始点。
to	string | undefined	在'ORBIT'镶嵌过程中，这标志着搜索间隔的结束。
scenes	Scenes	集合内的场景。

CustomData{Object.<string, unknown>}

DataFilter{Object}

属性:

Name	Type	描述
timeRange	TimeRange | undefined	数据时间范围。
maxCloudCoverage	number | undefined	最大云覆盖率（0-100）

Evalscript{Object}

属性:

Name	Type	描述
setup	Setup	设置函数。
evaluatePixel	EvaluatePixel	用于将输入样本转换为输出值的函数。
updateOutput	UpdateOutput | undefined	可选函数，用于调整输出波段。
updateOutputMetadata	UpdateOutputMetadata | undefined	用于更新输出元数据的可选函数。
preProcessScenes	Collections | undefined	处理前调用的可选函数。
version	string (defaults to '3')	Evalscript版本。

EvaluatePixel()

source/SentinelHub.js, line 52

InputDescription{Object}

属性:

Name	Type	描述
bands	Array.<string>	输入波段标识符
units	string | Array.<string> | undefined	输入波段单位。
metadata	Array.<string> | undefined	输入元数据中应包含的属性。

InputMetadata{Object}

属性:

Name	Type	描述
serviceVersion	string	处理所用服务的版本。
normalizationFactor	number	将数字量化值(DN)转换为反射率的系数。

Options{Object}

属性:

Name	Type	描述
auth	AuthConfig | string | undefined	身份验证配置clientId和clientSecret或访问令牌。请参阅。Sentinel Hub authentication详细信息请参考。如果未在构造函数中指定，则源将不会被渲染，直到setAuth被称为。
data	Array<ProcessRequestInputDataItem> | undefined	输入数据配置。如果未在构造函数中提供，则数据源将不会被渲染，直到setData被称为。
evalscript	Evalscript | string | undefined	应用于输入数据的过程。如果未在构造函数中提供，则源将不会被渲染，直到setEvalscript被称为。请参阅setEvalscript文档详述了传递过程函数时的限制。
tileSize	number | Size (defaults to [512, 512])	源瓦片的像素宽度和高度。
url	string (defaults to 'https://services.sentinel-hub.com/api/v1/process')	Sentinel Hub 处理API的URL。
projection	ProjectionLike | undefined	投影：默认为视图投影。
attributionsCollapsible	boolean (defaults to true)	允许折叠版权信息。
interpolate	boolean (defaults to true)	在重采样过程中，需要应用插值方法。默认采用线性插值；若参数设为false，则切换为最近邻插值。
wrapX	boolean (defaults to true)	水平环绕世界。
transition	number | undefined	渲染不透明度过渡的持续时间。要禁用不透明度过渡，请传递transition: 0.

Orbit{Object}

属性:

Name	Type	描述
dateFrom	string	瓦片内所有场景的最早日期。
dateTo	string	瓦片中所包含场景的最新日期。
tiles	Array	每个瓦片的元数据。

OutputDescription{Object}

属性:

Name	Type	描述
id	string (defaults to 'default')	输出标识符。
bands	number	输出波段数量
sampleType	SampleType (defaults to 'AUTO')	输出样本类型。
nodataValue	number | undefined	输出无数据值。

OutputMetadata{Object}

属性:

Name	Type	描述
userData	Object	用户自定义数据。

OutputValues{Object.<string, Array.<number>>}

ProcessRequest{Object}

属性:

Name	Type	描述
input	ProcessRequestInput	输入数据配置。
evalscript	string	用于数据处理的 Evalscript。
output	ProcessRequestOutput | undefined	输出配置。

ProcessRequestInput{Object}

属性:

Name	Type	描述
bounds	ProcessRequestInputBounds	输入数据的边界框。
data	Array<ProcessRequestInputDataItem>	输入数据。

ProcessRequestInputBounds{Object}

属性:

Name	Type	描述
bbox	Array.<number> | undefined	输入数据的边界框。
properties	ProcessRequestInputBoundsProperties | undefined	边界框的属性。
geometry	module:geojson~Geometry | undefined	边界框的几何

ProcessRequestInputBoundsProperties{Object}

属性:

Name	Type	描述
crs	string	边界框的坐标参考系统。

ProcessRequestInputDataItem{Object}

属性:

Name	Type	描述
type	string | undefined	输入数据的类型。
id	string | undefined	输入数据的标识符
dataFilter	DataFilter | undefined	应用于输入数据的过滤器。
processing	Object.<string, unknown> | undefined	对输入数据的处理。

ProcessRequestOutput{Object}

属性:

Name	Type	描述
width	number | undefined	图像宽度（像素）
height	number | undefined	图像高度（像素）
resx	number | undefined	x方向的空间分辨率。
resy	number | undefined	y方向的空间分辨率
responses	Array<ProcessRequestOutputResponse> | undefined	响应配置。

ProcessRequestOutputFormat{Object}

属性:

Name	Type	描述
type	string | undefined	输出格式类型。

ProcessRequestOutputResponse{Object}

属性:

Name	Type	描述
identifier	string | undefined	用于连接结果与设置输出的标识符。
format	ProcessRequestOutputFormat | undefined	响应格式。

Sample{Object.<string, number>}

SampleType{'INT8'} {'UINT8'} {'INT16'} {'UINT16'} {'FLOAT32'} {'AUTO'}

Scenes{Object}

属性:

Name	Type	描述
orbit	Array<Orbit> | undefined	当拼接模式为ORBIT时，图块中包含的场景信息。
tiles	Array<Tile> | undefined	当镶嵌模式为“瓦片”时，瓦片中所包含场景的信息。

Setup()

source/SentinelHub.js, line 48

SetupResult{Object}

属性:

Name	Type	描述
input	Array.<string> | Array<InputDescription>	输入数据描述
output	OutputDescription | Array<OutputDescription>	输出数据描述
mosaicking	'SIMPLE' | 'ORBIT' | 'TILE' (defaults to 'SIMPLE')	控制输入场景样本的组成方式。

Tile{Object}

属性:

Name	Type	描述
date	string	瓦片中所用场景的日期。
cloudCoverage	number	场景中受云遮挡像元的估计百分比。
dataPath	string	数据存储路径。
shId	number	场景的内部标识符。

TimeRange{Object}

属性:

Name	Type	描述
from	string | undefined	起始时间（包含）。
to	string | undefined	结束时间（包含）。

UpdateOutput()

source/SentinelHub.js, line 56

UpdateOutputMetadata()

source/SentinelHub.js, line 60

UpdatedOutputDescription{Object}

属性:

Name	Type	描述
bands	number	输出波段数。