| Title: | Download and Manage Data from Theia |
|---|---|
| Description: | Provides a simple interface to search available data provided by Theia (<https://theia.cnes.fr>), download it, and manage it. Data can be downloaded based on a search result or from a cart file downloaded from Theia website. |
| Authors: | Xavier Laviron [aut, cre] |
| Maintainer: | Xavier Laviron <[email protected]> |
| License: | GPL (>= 3.0) |
| Version: | 0.4.2 |
| Built: | 2025-02-27 03:19:36 UTC |
| Source: | https://github.com/norival/theiar |
Generate and manage authentication to Theia website from login and password. It requests a token to download tiles when created and automatically request a new one when it has expired (after 2h). It is used to download tiles from TheiaTile and TheiaCollection objects.
a <- TheiaAuth$new(auth.file) a$token()
A TheiaAuth object
The path to the file containing login and password. It will be created if it does not exist. See 'Details' for more informations
TheiaAuth$new(auth.file) Create a new instance of the class
a$token() Return the current token or generate a next one if it has
expired
This class is used to manage authentication to Theia website, without intervention from the user. Login and password must be stored in a separate text file with these two lines:
login password
File content is read each time authentication is needed (to request a new token), so login and password are not stored in R's memory. If this file does not exist, R will prompt you to enter your login and password and will create the file.
## Not run: # create an authentication object myauth <- TheiaAuth$new("path_to_auth_file.txt") # show the access token (and request a new one if needed) myauth$token ## End(Not run)## Not run: # create an authentication object myauth <- TheiaAuth$new("path_to_auth_file.txt") # show the access token (and request a new one if needed) myauth$token ## End(Not run)
Generate and manage collection of tiles from Theia. This collection can be
created either from a cart file ('.meta4') downloaded from Theia website,
from a TheiaQuery object or from a list of
TheiaTile (not implemented yet).
c <- TheiaCollection$new(cart.path = NULL,
tiles = NULL,
query = NULL,
dir.path = NULL,
check = TRUE)
quiet = TRUE)
c$download(auth, overwrite = FALSE, check = TRUE, quiet = TRUE)
c$check()
c$status
c$extract(overwrite = FALSE, dest.dir = NULL)
c$read(bands)
c$as_gdalcube(out.file = "gdalcube_collection.sqlite")
A TheiaCollection object
The path to the directory containing zip files
Whether or not to check existing files on collection's creation
Control verbose output
A list of TheiaTile objects
An XML cart parsed from a 'meta4' file downloaded from Theia
website. Used only if Collection is created from a cart
A TheiaQuery object, used only if collection is created
from a TheiaQuery object. Can also be a list with search terms. In this
case, it will create a 'TheiaQuery' object from it. See
TheiaQuery for details on query syntax
A character string giving the file path to Theia credentials.
Or a TheiaAuth object
Overwrite existing tiles (default to 'FALSE')
A character vector of bands to load from tiles
Filename to store gdalcubes' image collection
TheiaCollection$new() Create a new instance of the class
c$download(overwrite = FALSE, check = TRUE) Download the tiles of the collection
and check the resulting files
$ccheck() Check the tiles of the collection
c$status Return the status of each tile of the collection
c$extract(overwrite = FALSE, dest.dir = NULL) Extract archives to
dest.dir if supplied, or to the same directory as the archives otherwise
c$read(bands) Read requested bands, apply corrections on values
(as specified in Theia's product information), and return a list of
RasterStack objects (one stack per tile)
c$as_gdalcube(out.file) Create a 'gdalcubes' image collection from
downloaded tiles. See https://github.com/appelmar/gdalcubes_R for
more details.
# Create a collection from a query ## Create a query to Theia database, looking for tiles from Sentinel2 ## satellite around Grenoble, between 2018-07-01 and 2018-07-06. query <- list(collection = "SENTINEL2", town = "Grenoble", start.date = "2018-07-01", end.date = "2018-07-06") ## Create a collecion of tiles from this query mycollection <- TheiaCollection$new(query = query, dir.path = ".") print(mycollection) # Alternatively, you can create a collection from a cart file (that you can # download from Theia's website) cart.path <- system.file("extdata", "cart.meta4", package = "theiaR") mycollection <- TheiaCollection$new(cart.path = cart.path, dir.path = ".") print(mycollection) ## Not run: # Download the tiles in the collection mycollection$download() ## End(Not run) ## Not run: # Finally, you can extract zip archives containing the tiles mycollection$extract(overwrite = FALSE) ## End(Not run)# Create a collection from a query ## Create a query to Theia database, looking for tiles from Sentinel2 ## satellite around Grenoble, between 2018-07-01 and 2018-07-06. query <- list(collection = "SENTINEL2", town = "Grenoble", start.date = "2018-07-01", end.date = "2018-07-06") ## Create a collecion of tiles from this query mycollection <- TheiaCollection$new(query = query, dir.path = ".") print(mycollection) # Alternatively, you can create a collection from a cart file (that you can # download from Theia's website) cart.path <- system.file("extdata", "cart.meta4", package = "theiaR") mycollection <- TheiaCollection$new(cart.path = cart.path, dir.path = ".") print(mycollection) ## Not run: # Download the tiles in the collection mycollection$download() ## End(Not run) ## Not run: # Finally, you can extract zip archives containing the tiles mycollection$extract(overwrite = FALSE) ## End(Not run)
Generate an send a query to Theia web API to get and download tiles based on input given by the user.
q <- TheiaQuery$new(query) q$update_token() q$submit()
A TheiaQuery object
list, the users' request, see 'Queries' for
more informations
TheiaQuery$new() Create a new instance of the class, parse 'query'
list and submit the query to Theia to retrieve files catalog
q$submit() Submit the query to Theia and get a list of tiles
corresponding to search criteria
Search criteria are given with a 'list' accepting these fields:
collection: The collection to look for. Accepted values are: 'SENTINEL2', 'LANDSAT', 'Landsat57', 'SpotWorldHeritage', 'Snow', 'VENUS' and 'VENUSVM05'. Defaults to 'SENTINEL2'
platform: The platform to look for. Accepted values are: 'LANDSAT5', 'LANDSAT7', 'LANDSAT8', 'SPOT1', 'SPOT2', 'SPOT3', 'SPOT4', 'SPOT5', 'SENTINEL2A', 'SENTINEL2B', 'L2B-SNOW', 'L3B-SNOW'
level: Processing level. Accepted values are: 'LEVEL1C', 'LEVEL2A', LEVEL3A', 'N2A'. Defaults to 'LEVEL2A' (or 'N2A' if querying Landsat57 collection).
town: The location to look for. Give a common town name.
tile: The tile identifier to retrieve.
start.date: The first date to look for (format: YYYY-MM-DD).
end.date: The last date to look for (format: YYYY-MM-DD). Must be after start.date. Defaults to today's date.
latitude: The x coordinate of a point
longitude: The y coordinate of a point
latmin: The minimum latitude to search
latmax: The maximum latitude to search
lonmin: The minimum longitude to search
lonmax: The maximum longitude to search
orbit.number: The orbit number
rel.orbit.number: The relative orbit number
max.clouds: The maximum of cloud cover wanted (0-100)
max.records: The maximum of tiles to search
https://github.com/olivierhagolle/theia_download for an alternative download method based on Python. Inspiration for this function.
# Create a query to Theia database, looking for tiles from Sentinel2 # satellite around Grenoble, between 2018-07-01 and 2018-07-06. query <- list(collection = "SENTINEL2", town = "Grenoble", start.date = "2018-07-01", end.date = "2018-07-06") q <- TheiaQuery$new(query) # Show informations on found tiles print(q$tiles)# Create a query to Theia database, looking for tiles from Sentinel2 # satellite around Grenoble, between 2018-07-01 and 2018-07-06. query <- list(collection = "SENTINEL2", town = "Grenoble", start.date = "2018-07-01", end.date = "2018-07-06") q <- TheiaQuery$new(query) # Show informations on found tiles print(q$tiles)
Search, manage and download data from Theia website
Generate and manage a tile from Theia (download, check, load).
t <- TheiaTile$new(file.path,
url,
file.hash,
check = TRUE,
quiet = TRUE)
t$download(overwrite = FALSE, check = TRUE, quiet = TRUE)
t$check()
t$extract(overwrite = FALSE, dest.dir = NULL)
t$read(bands)
A TheiaTile object
The path to the zip file containing the tile
The url to download the tile
The md5sum used to check the zip file
Whether or not to check existing files on tile's creation
Control verbose output
A character string giving the file path to Theia credentials.
Or a TheiaAuth object
Overwrite existing tiles (default to 'FALSE')
A character vector of bands to load from tiles
TheiaTile$new(file.path, url, file.hash, check) Create a new instance of
the class
t$download(auth, overwrite = FALSE, check = TRUE) Download the
tiles of the collection and check the resulting files
t$check() Check the tiles of the collection
t$extract(overwrite = FALSE, dest.dir = NULL) Extract archive to
dest.dir if supplied, or to the same directory as the archive otherwise
t$read(bands) Read requested bands, apply corrections on values
(as specified in Theia's product information), and return a RasterStack
t$bands List bands available in the tile