API Reference¶
tellus_traveler.api
¶
Functions corresponding to Tellus Traveler API endpoints.
dataset(id)
¶
Gets a dataset by ID.
https://www.tellusxdp.com/docs/travelers/#/データセット/get_datasets__dataset_id__
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id |
str
|
Dataset ID. |
required |
Returns:
| Type | Description |
|---|---|
dict[str, Any]
|
A dataset dictionary. |
Source code in src/tellus_traveler/api/_datasets.py
dataset_manual_url(id)
¶
Gets a dataset manual URL by ID.
https://www.tellusxdp.com/docs/travelers/#/データセットメディア/get_datasets__dataset_id__manual_
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id |
str
|
Dataset ID. |
required |
Returns:
| Type | Description |
|---|---|
str
|
A dataset manual URL. |
Source code in src/tellus_traveler/api/_datasets.py
dataset_terms_url(id)
¶
Gets a dataset terms of use URL by ID.
https://www.tellusxdp.com/docs/travelers/#/データセットメディア/get_datasets__dataset_id__terms_of_use_
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
id |
str
|
Dataset ID. |
required |
Returns:
| Type | Description |
|---|---|
str
|
A dataset terms of use URL. |
Source code in src/tellus_traveler/api/_datasets.py
datasets(is_order_required=None, has_order=None)
¶
Gets a list of datasets with automatic pagination.
https://www.tellusxdp.com/docs/travelers/#/データセット/get_datasets_
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
is_order_required |
bool | None
|
Whether orders are required to download files. |
None
|
has_order |
bool | None
|
Whether active orders exists. |
None
|
Returns:
| Type | Description |
|---|---|
list[dict[str, Any]]
|
A list of dataset dictionaries. |
Source code in src/tellus_traveler/api/_datasets.py
scene(dataset_id, scene_id)
¶
Get a scene info.
https://www.tellusxdp.com/docs/travelers/#/シーン/get_datasets__dataset_id__data__data_id__
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset_id |
str
|
Dataset ID. |
required |
scene_id |
str
|
Scene ID. |
required |
Returns:
| Type | Description |
|---|---|
Scene
|
A |
Source code in src/tellus_traveler/api/_scenes.py
scene_file_url(dataset_id, scene_id, file_id)
¶
Get a download URL of a file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset_id |
str
|
Dataset ID. |
required |
scene_id |
str
|
Scene ID. |
required |
file_id |
int
|
File ID. |
required |
Returns:
| Type | Description |
|---|---|
str
|
A download URL of the file. |
Source code in src/tellus_traveler/api/_files.py
scene_files(dataset_id, scene_id)
¶
Get a list of file info belonging to a scene.
https://www.tellusxdp.com/docs/travelers/#/ファイル/get_datasets__dataset_id__data__data_id__files_
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset_id |
str
|
Dataset ID. |
required |
scene_id |
str
|
Scene ID. |
required |
Returns:
| Type | Description |
|---|---|
list[File]
|
A list of |
Source code in src/tellus_traveler/api/_files.py
scene_thumbnail_url(dataset_id, scene_id, file_id)
¶
Get a download URL of a thumbnail.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset_id |
str
|
Dataset ID. |
required |
scene_id |
str
|
Scene ID. |
required |
file_id |
int
|
File ID. |
required |
Returns:
| Type | Description |
|---|---|
str
|
A download URL of the thumbnail. |
Source code in src/tellus_traveler/api/_thumbnails.py
scene_thumbnails(dataset_id, scene_id)
¶
Get a list of thumbnail info belonging to a scene.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dataset_id |
str
|
Dataset ID. |
required |
scene_id |
str
|
Scene ID. |
required |
Returns:
| Type | Description |
|---|---|
list[File]
|
A list of |
Source code in src/tellus_traveler/api/_thumbnails.py
search(datasets=None, bbox=None, intersects=None, start_datetime=None, end_datetime=None, query=None, is_order_required=None, only_downloadable_file=None, sort_by=None)
¶
Search scenes.
https://www.tellusxdp.com/docs/travelers/#/シーン/post_data_search_
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
datasets |
list[str] | None
|
Dataset IDs. |
None
|
bbox |
list[float] | tuple[float, ...] | None
|
Bounding box of coordinates. |
None
|
intersects |
dict[str, Any] | None
|
GeoJSON Polygon geometry. |
None
|
start_datetime |
str | datetime | None
|
Observation start datetime. |
None
|
end_datetime |
str | datetime | None
|
Observation end datetime. |
None
|
query |
dict[str, Any] | None
|
Other queries for dataset properties. See the API doc for more details. |
None
|
is_order_required |
bool | None
|
Whether orders are required to download files. |
None
|
only_downloadable_file |
bool | None
|
Whether to return only scenes which files are downloadable. |
None
|
sort_by |
list[dict[str, str]] | dict[str, str] | str | None
|
Dataset properties to sort by. |
None
|
Returns:
| Type | Description |
|---|---|
SceneSearch
|
A SceneSearch instance that represents deferred query. |
Source code in src/tellus_traveler/api/_scenes.py
tellus_traveler.models
¶
Model classes.
File
¶
File model.
Attributes:
| Name | Type | Description |
|---|---|---|
dataset_id |
str
|
Dataset ID that the file belongs to. |
scene_id |
str
|
Scene ID that the file belongs to. |
is_thumbnail |
bool
|
Whether the file is a thumbnail. |
Source code in src/tellus_traveler/models/_file.py
download(dir='.', name=None)
¶
Download the file.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dir |
Path | str
|
Directory path to save the file. |
'.'
|
name |
str | None
|
File name to save the file. If not given, the original file name is used. |
None
|
Returns:
| Type | Description |
|---|---|
Path
|
A |
Source code in src/tellus_traveler/models/_file.py
Scene
¶
Scene model that wraps a GeoJSON Feature.
Attributes:
| Name | Type | Description |
|---|---|---|
__geo_interface__ |
dict[str, Any]
|
GeoJSON Feature dictionary. See https://gist.github.com/sgillies/2217756. |
Source code in src/tellus_traveler/models/_scene.py
dataset_id: str
property
¶
Dataset ID that the scene belongs to.
geometry: dict[str, Any]
property
¶
GeoJSON Geometry dictionary.
id: str
property
¶
Scene ID.
properties: dict[str, Any]
property
¶
Dataset properties.
__getitem__(key)
¶
download_all_files(dir=None)
¶
Download all files concurrently.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dir |
Path | str | None
|
Directory path to save the files. If not given, creates a directory
with |
None
|
Returns:
| Type | Description |
|---|---|
Path
|
A |
Source code in src/tellus_traveler/models/_scene.py
files()
¶
get(key, default=None)
¶
Gets a property value by key. Returns default if the key is not found.
SceneSearch
¶
Search query for scenes.
Attributes:
| Name | Type | Description |
|---|---|---|
params |
dict[str, Any]
|
Search query parameters. |
Source code in src/tellus_traveler/models/_scene_search.py
pages()
¶
Returns Iterator of the search result pages.
Yields:
| Type | Description |
|---|---|
dict[str, Any]
|
Search result dict that represents GeoJSON FeatureCollection. |
Source code in src/tellus_traveler/models/_scene_search.py
scenes()
¶
tellus_traveler.http_client
¶
Thin HTTP client for Tellus Traveler API.
HTTPError
¶
get(path, **params)
¶
post(path, **json)
¶
Creates a POST request to Tellus Traveler API.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path |
str
|
Path to the API endpoint. |
required |
json |
Any
|
JSON data to send in the request body. |
{}
|
Returns:
| Type | Description |
|---|---|
Any
|
The JSON response body as a Python object. |