ol/source/SentinelHub

Классы

SentinelHub

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

AccessTokenClaims{Объект}

Свойства:

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

AuthConfig{Объект}

Свойства:

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

Collections{Объект}

Свойства:

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

CustomData{Объект.<строка, неизвестное>}

DataFilter{Объект}

Свойства:

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

Evalscript{Объект}

Свойства:

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

EvaluatePixel()

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

InputDescription{Объект}

Свойства:

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

InputMetadata{Объект}

Свойства:

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

Options{Объект}

Свойства:

Имя	Тип	Описание
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 API Sentinel Hub для обработки.
projection	ProjectionLike | undefined	Проекция. По умолчанию — проекция представления.
attributionsCollapsible	boolean (по умолчанию true)	Разрешить сворачивание атрибутов.
interpolate	boolean (по умолчанию true)	Использовать интерполированные значения при ресемплировании. По умолчанию используется линейная интерполяция при ресемплировании. Установите в значение false, чтобы использовать ближайший сосед вместо этого.
wrapX	boolean (по умолчанию true)	Оборачивать мир по горизонтали.
transition	number | undefined	Длительность перехода непрозрачности для рендеринга. Чтобы отключить переход непрозрачности, передайте transition: 0.

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	строка | undefined	Тип входных данных.
id	строка | undefined	Идентификатор входных данных.
dataFilter	DataFilter | undefined	Фильтр, применяемый к входным данным.
processing	Объект.<строка, неизвестный> | undefined	Обработка, применяемая к входным данным.

ProcessRequestOutput{Объект}

Свойства:

Имя	Тип	Описание
width	число | undefined	Ширина изображения в пикселях.
height	число | undefined	Высота изображения в пикселях.
resx	число | undefined	Пространственное разрешение по оси x.
resy	число | undefined	Пространственное разрешение по оси y.
responses	Массив<ProcessRequestOutputResponse> | undefined	Настройка ответа.

ProcessRequestOutputFormat{Объект}

Свойства:

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

ProcessRequestOutputResponse{Объект}

Свойства:

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

Sample{Объект.<строка, число>}

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

Scenes{Объект}

Свойства:

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

Setup()

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

SetupResult{Объект}

Свойства:

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

Tile{Объект}

Свойства:

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

TimeRange{Объект}

Свойства:

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

UpdateOutput()

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

UpdateOutputMetadata()

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

UpdatedOutputDescription{Объект}

Свойства:

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