sisppeo.products.L3MaskProduct¶
- class sisppeo.products.L3MaskProduct(dataset)[source]¶
Bases:
sisppeo.products.l3.L3Product
An L3Product embedding data obtained by using a mask algorithm.
- dataset¶
A dataset containing processed data.
- Type
xarray.core.dataset.Dataset
- __init__(dataset)¶
Methods
__init__
(dataset)extract_point
(data_var, coordinates[, ...])Returns value(s) at the given coordinates.
extract_points
(data_var, lst_coordinates[, ...])Returns value(s) at each tuple of coordinates of the given list.
from_file
(filename)index
(x, y)Gets (i, j) from (x, y)
plot
(data_var)Plots a given variable.
save
(filename)See base class.
xy
(i, j)Gets (x, y) from (i, j).
Attributes
(xmin, ymin, xmax, ymax).
Returns a list of DataArrays corresponding to variables.
Returns the name of the mask used to get this dataset.
Returns the product_type of the product used to get this dataset.
Returns the spatial resolution of this product.
Returns the title of the underlying dataset.
Returns x-coords.
Returns y-coords.
- property bounds¶
(xmin, ymin, xmax, ymax).
- Type
Returns the boundaries of this product
- property data_vars¶
Returns a list of DataArrays corresponding to variables.
- extract_point(data_var, coordinates, buffer=None, epsg=4326, mode='xy')¶
Returns value(s) at the given coordinates.
- Parameters
data_var – The name of the variable/DataArray of interest (e.g., a band, aCDOM, etc).
coordinates – A tuple of geographic or projected coordinates; see “mode”.
buffer – Optional; The radius (in pixels) of the circle (centered on coordinates) to extract. Defaults to None.
epsg – Optional; The EPSG code. Defaults to 4326.
mode – Optional; Either ‘xy’ or ‘latlon’. Defaults to ‘xy’.
- Returns
An xr.DataArray containing the wanted information.
- extract_points(data_var, lst_coordinates, buffer=None, epsg=4326, mode='xy')¶
Returns value(s) at each tuple of coordinates of the given list.
- Parameters
data_var – The name of the variable/DataArray of interest (e.g., a band, aCDOM, etc).
lst_coordinates – A list of tuples of geographic or projected coordinates; see “mode”.
buffer – Optional; The radius (in pixels) of the circle (centered on coordinates) to extract. Defaults to None.
epsg – Optional; The EPSG code. Defaults to 4326.
mode – Optional; Either ‘xy’ or ‘latlon’. Defaults to ‘xy’.
- Returns
A list of xr.DataArray (one per coordinates tuple) containing the wanted information.
- index(x, y)¶
Gets (i, j) from (x, y)
- property mask¶
Returns the name of the mask used to get this dataset.
- plot(data_var)¶
Plots a given variable.
- data_var: The name of the variable/DataArray of interest (e.g., a
band, aCDOM, etc).
- property product_type¶
Returns the product_type of the product used to get this dataset.
- property res¶
Returns the spatial resolution of this product.
- property title¶
Returns the title of the underlying dataset.
- property x¶
Returns x-coords.
- xy(i, j)¶
Gets (x, y) from (i, j).
- property y¶
Returns y-coords.