Module: ol/source/SentinelHub

Classes

SentinelHub

Type Definitions

AccessTokenClaims{Object}

Properties:

Name	Type	Description
exp	number	令牌的过期时间（秒）。

AuthConfig{Object}

Properties:

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

Collections{Object}

Properties:

Name	Type	Description
from	string | undefined	对于 'ORBIT' 镶嵌，这将是搜索间隔的开始时间。
to	string | undefined	对于 'ORBIT' 镶嵌，这将是搜索间隔的结束时间。
scenes	Scenes	集合中的场景。

CustomData{对象。<string, unknown>}

DataFilter{Object}

Properties:

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

Evalscript{Object}

Properties:

Name	Type	Description
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}

Properties:

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

InputMetadata{Object}

Properties:

Name	Type	Description
serviceVersion	string	用于处理的服务版本。
normalizationFactor	number	用于将数字值（DN）转换为反射率的因子。

Options{Object}

Properties:

Name	Type	Description
auth	AuthConfig | string | undefined	包含 clientId 和 clientSecret 的认证配置或访问令牌。详见 Sentinel Hub 认证。如果构造时未提供，数据源将不会渲染，直到调用 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 可使用 the nearest neighbor instead.
wrapX	boolean (defaults to true)	水平包裹世界。
transition	number | undefined	渲染的不透明度过渡持续时间。要禁用不透明度过渡，请传递 transition: 0。

Orbit{Object}

Properties:

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

OutputDescription{Object}

Properties:

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

OutputMetadata{Object}

Properties:

Name	Type	Description
userData	Object	任意用户数据。

OutputValues{对象。<string, Array.<number>>}

ProcessRequest{Object}

Properties:

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

ProcessRequestInput{Object}

Properties:

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

ProcessRequestInputBounds{Object}

Properties:

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

ProcessRequestInputBoundsProperties{Object}

Properties:

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

ProcessRequestInputDataItem{Object}

Properties:

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

ProcessRequestOutput{Object}

Properties:

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

ProcessRequestOutputFormat{Object}

Properties:

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

ProcessRequestOutputResponse{Object}

Properties:

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

Sample{对象。<string, number>}

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

Scenes{Object}

Properties:

Name	Type	Description
orbit	Array<Orbit> | undefined	当 'mosaicking' 为 'ORBIT' 时瓦片中包含的场景信息。
tiles	Array<Tile> | undefined	当 'mosaicking' 为 'TILE' 时瓦片中包含的场景信息。

Setup()

source/SentinelHub.js, line 48

SetupResult{Object}

Properties:

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

Tile{Object}

Properties:

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

TimeRange{Object}

Properties:

Name	Type	Description
from	string | undefined	开始时间（含）。
to	string | undefined	结束时间（含）。

UpdateOutput()

source/SentinelHub.js, line 56

UpdateOutputMetadata()

source/SentinelHub.js, line 60

UpdatedOutputDescription{Object}

Properties:

Name	Type	Description
bands	number	输出波段数。