These functions provide an API to instantiate a new cube object and access/retrieve information from services or local files to fill cube attributes.
A cube is formed by images (items) organized in tiles. To create a sits
cube object (a tibble
), a set of functions are called in order
to retrieve metadata.
.source_cube()
is called to start the cube creation
from a source.
.source_item_get_date()
retrieves the date of an item
(a set of images from different bands that forms a scene).
.source_item_get_hrefs()
retrieves the paths or URLs of
each file bands of an item.
.source_item_get_cloud_cover()
retrieves the percentage
of cloud cover of an image.
.source_item_get_bands()
retrieves the bands present
in an item.
.source_items_new()
this function is called to create
an items object. In case of Web services, this function is responsible for
making the Web requests to the server.
.source_items_fid()
retrieves the feature id of
all items.
.source_items_file_info()
creates the fileinfo
specification from items object.
.source_items_tile()
organizes items by tiles
and arrange items in each tile by date.
.source_items_get_sensor()
retrieves the sensor from
items object.
.source_items_get_satellite()
retrieves the satellite
name (platform) from items object.
.source_tile_get_bbox()
retrieves the bounding
box from items of a tile.
.source_items_cube()
is called to create a data cubes
tile, that is, a row in sits data cube.
.source_tile_get_bbox()
retrieves the bounding
box from items of a tile.
.source_cube(source, collection, ...).source_item_get_date(source, item, ..., collection = NULL)
.source_item_get_hrefs(source, item, ..., collection = NULL)
.source_item_get_cloud_cover(source, ..., item, collection = NULL)
.source_item_get_bands(source, item, ..., collection = NULL)
.source_items_new(source, ..., collection = NULL)
.source_items_bands_select(source, items, bands, ..., collection = NULL)
.source_items_fid(source, items, ..., collection = NULL)
.source_items_file_info(source, items, ..., collection = NULL)
.source_items_tile(source, items, ..., collection = NULL)
.source_collection_sensor(source, collection)
.source_collection_satellite(source, collection)
.source_tile_get_bbox(source, ..., file_info, collection = NULL)
.source_items_cube(source, collection, items, ...)
# S3 method for stac_cube
.source_tile_get_bbox(source, file_info, ..., collection = NULL)
The values returned by each function are described as follows.
.source_cube()
returns a sits tibble
with cube
metadata.
.source_item_get_date()
returns a Date
value.
.source_item_get_hrefs()
returns a character
vector
containing paths to each image band of an item.
.source_item_get_cloud_cover()
returns a numeric
vector
containing the percentage of cloud cover to each image band of an item.
.source_item_get_bands()
returns a character
vector
containing bands name of an item.
.source_items_new()
returns any object referring the images
of a sits cube.
.source_items_bands_select()
returns the same object as
items
with selected bands.
.source_items_fid()
returns a character
vector.
.source_items_file_info()
returns a tibble
containing
sits cube.
.source_items_tile()
returns a list
of
items.
.source_items_get_sensor()
returns a character
value.
.source_items_get_satellite()
returns a character
value.
.source_tile_get_bbox()
returns a numeric
vector with 4 elements (xmin, ymin, xmax, ymax).
.source_items_cube()
returns a tibble
containing a sits
cube tile (one row).
.source_tile_get_bbox()
returns a list
vector with 4 elements (xmin, ymin, xmax, ymax).
Data source.
Image collection.
Additional parameters.
Images that compose a cube.
Bands to be selected in the collection.
A tibble
that organizes the metadata about each
file in the tile: date, band, resolution, and path (or URL).
A raster
object to retrieve information.
Directory where local files are stored