ol/source/SentinelHub

Классы

SentinelHub

Определения типов

AccessTokenClaims{Object}

Свойства:

Имя	Тип	Описание
exp	number	Время истечения срока действия токена (в секундах).

AuthConfig{Object}

Свойства:

Имя	Тип	Описание
tokenUrl	string (по умолчанию 'https://services.sentinel-hub.com/auth/realms/main/protocol/openid-connect/token')	URL для получения токена аутентификации.
clientId	string	Идентификатор клиента.
clientSecret	string	Секрет клиента.

Collections{Object}

Свойства:

Имя	Тип	Описание
from	string | undefined	При мозаицировании «ORBIT» это начало интервала поиска.
to	string | undefined	При мозаицировании «ORBIT» это конец интервала поиска.
scenes	Scenes	Сцены в коллекции.

CustomData{Object.<string, unknown>}

DataFilter{Object}

Свойства:

Имя	Тип	Описание
timeRange	TimeRange | undefined	Временной диапазон данных.
maxCloudCoverage	number | undefined	Максимальная облачность (0–100).

Evalscript{Object}

Свойства:

Имя	Тип	Описание
setup	Setup	Функция настройки.
evaluatePixel	EvaluatePixel	Функция для преобразования входных выборок в выходные значения.
updateOutput	UpdateOutput | undefined	Необязательная функция для настройки выходных каналов.
updateOutputMetadata	UpdateOutputMetadata | undefined	Необязательная функция для обновления выходных метаданных.
preProcessScenes	Collections | undefined	Необязательная функция, вызываемая перед обработкой.
version	string (по умолчанию '3')	Версия Evalscript.

EvaluatePixel()

source/SentinelHub.js, строка 67

InputDescription{Object}

Свойства:

Имя	Тип	Описание
bands	Array.<string>	Идентификаторы входных каналов.
units	string | Array.<string> | undefined	Единицы измерения входных каналов.
metadata	Array.<string> | undefined	Свойства, включаемые во входные метаданные.

InputMetadata{Object}

Свойства:

Имя	Тип	Описание
serviceVersion	string	Версия службы, использованной для обработки.
normalizationFactor	number	Коэффициент для преобразования значений цифрового числа (DN) в отражательную способность.

Options{Object}

Свойства:

Имя	Тип	Описание
auth	AuthConfig | string | undefined	Конфигурация аутентификации с clientId и clientSecret или токен доступа. Подробности см. в документации по аутентификации Sentinel Hub. Если параметр не указан в конструкторе, источник не будет отображаться, пока не будет вызван setAuth.
data	Array<ProcessRequestInputDataItem> | undefined	Конфигурация входных данных. Если параметр не указан в конструкторе, источник не будет отображаться, пока не будет вызван setData.
evalscript	Evalscript | string | undefined	Обработка, применяемая к входным данным. Если параметр не указан в конструкторе, источник не будет отображаться, пока не будет вызван setEvalscript. Подробные сведения об ограничениях при передаче функций обработки см. в документации setEvalscript.
tileSize	number | Size (по умолчанию [512, 512])	Ширина и высота исходных тайлов в пикселях.
url	string (по умолчанию 'https://services.sentinel-hub.com/api/v1/process')	URL Processing API Sentinel Hub.
projection	ProjectionLike | undefined	Проекция. По умолчанию используется проекция представления.
attributionsCollapsible	boolean (по умолчанию true)	Разрешить сворачивать атрибуцию.
interpolate	boolean (по умолчанию true)	Использовать интерполированные значения при передискретизации. По умолчанию при передискретизации используется линейная интерполяция. Установите значение false, чтобы вместо неё использовать метод ближайшего соседа.
wrapX	boolean (по умолчанию true)	Зацикливать мир по горизонтали.
transition	number | undefined	Длительность перехода прозрачности при отрисовке. Чтобы отключить переход прозрачности, передайте transition: 0.
format	string (по умолчанию 'image/png')	Тип MIME для каждого ответа обработки (responses[].format.type), например image/png или image/jpeg.

Orbit{Object}

Свойства:

Имя	Тип	Описание
dateFrom	string	Самая ранняя дата среди всех сцен, включённых в тайл.
dateTo	string	Самая поздняя дата среди сцен, включённых в тайл.
tiles	Array	Метаданные для каждого тайла.

OutputDescription{Object}

Свойства:

Имя	Тип	Описание
id	string (по умолчанию 'default')	Идентификатор выходных данных.
bands	number	Количество выходных каналов.
sampleType	SampleType (по умолчанию 'AUTO')	Тип выходных выборок.
nodataValue	number | undefined	Выходное значение nodata.

OutputMetadata{Object}

Свойства:

Имя	Тип	Описание
userData	Object	Произвольные пользовательские данные.

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

ProcessRequest{Object}

Свойства:

Имя	Тип	Описание
input	ProcessRequestInput	Конфигурация входных данных.
evalscript	string	Evalscript, используемый для обработки.
output	ProcessRequestOutput | undefined	Конфигурация выходных данных.

ProcessRequestInput{Object}

Свойства:

Имя	Тип	Описание
bounds	ProcessRequestInputBounds	Ограничивающий прямоугольник входных данных.
data	Array<ProcessRequestInputDataItem>	Входные данные.

ProcessRequestInputBounds{Object}

Свойства:

Имя	Тип	Описание
bbox	Array.<number> | undefined	Ограничивающий прямоугольник входных данных.
properties	ProcessRequestInputBoundsProperties | undefined	Свойства ограничивающего прямоугольника.
geometry	module:geojson~Geometry | undefined	Геометрия ограничивающего прямоугольника.

ProcessRequestInputBoundsProperties{Object}

Свойства:

Имя	Тип	Описание
crs	string	Система координат ограничивающего прямоугольника.

ProcessRequestInputDataItem{Object}

Свойства:

Имя	Тип	Описание
type	string | undefined	Тип входных данных.
id	string | undefined	Идентификатор входных данных.
dataFilter	DataFilter | undefined	Фильтр, применяемый к входным данным.
processing	Object.<string, unknown> | undefined	Обработка, применяемая к входным данным.

ProcessRequestOutput{Object}

Свойства:

Имя	Тип	Описание
width	number | undefined	Ширина изображения в пикселях.
height	number | undefined	Высота изображения в пикселях.
resx	number | undefined	Пространственное разрешение по оси x.
resy	number | undefined	Пространственное разрешение по оси y.
responses	Array<ProcessRequestOutputResponse> | undefined	Конфигурация ответа.

ProcessRequestOutputFormat{Object}

Свойства:

Имя	Тип	Описание
type	string | undefined	Тип выходного формата.

ProcessRequestOutputResponse{Object}

Свойства:

Имя	Тип	Описание
identifier	string | undefined	Идентификатор, используемый для сопоставления результатов с выходными данными из настройки.
format	ProcessRequestOutputFormat | undefined	Формат ответа.

Sample{Object.<string, number>}

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

Scenes{Object}

Свойства:

Имя	Тип	Описание
orbit	Array<Orbit> | undefined	Информация о сценах, включённых в тайл, если значение «mosaicking» — «ORBIT».
tiles	Array<Tile> | undefined	Информация о сценах, включённых в тайл, если значение «mosaicking» — «TILE».

Setup()

source/SentinelHub.js, строка 63

SetupResult{Object}

Свойства:

Имя	Тип	Описание
input	Array.<string> | Array<InputDescription>	Описание входных данных.
output	OutputDescription | Array<OutputDescription>	Описание выходных данных.
mosaicking	'SIMPLE' | 'ORBIT' | 'TILE' (по умолчанию 'SIMPLE')	Определяет способ объединения выборок из входных сцен.

Tile{Object}

Свойства:

Имя	Тип	Описание
date	string	Дата сцены, использованной в тайле.
cloudCoverage	number	Расчётная доля пикселей сцены, закрытых облаками.
dataPath	string	Путь к данным в хранилище.
shId	number	Внутренний идентификатор сцены.

TimeRange{Object}

Свойства:

Имя	Тип	Описание
from	string | undefined	Время начала (включительно).
to	string | undefined	Время окончания (включительно).

UpdateOutput()

source/SentinelHub.js, строка 71

UpdateOutputMetadata()

source/SentinelHub.js, строка 75

UpdatedOutputDescription{Object}

Свойства:

Имя	Тип	Описание
bands	number	Количество выходных каналов.