eoio.readers.hypernets.reader module

eoio.readers.hypernets.reader module#

eoio.readers.hypernets.reader#

HYPERNETS NetCDF data reader classes for Level 1 Radiance, Level 1 Irradiance, and Level 2 Reflectance products.

Classes#

HYPERNETSReader(path[, vars_sel, subset, ...])

Reader for HYPERNETS data.

HYPERNETSL1RadReader(path[, vars_sel, ...])

Reader for HYPERNETS Level 1 Radiance products.

HYPERNETSL1IrrReader(path[, vars_sel, ...])

Reader for HYPERNETS Level 1 Irradiance products.

HYPERNETSL2RefReader(path[, vars_sel, ...])

Reader for HYPERNETS Level 2 Reflectance products.

Functions#

class eoio.readers.hypernets.reader.HYPERNETSL1IrrReader(path, vars_sel=None, subset=None, read_params=None)[source]#

Bases: HYPERNETSReader

Reader for HYPERNETS Level 1 Irradiance products.

meas_def#

Measurement variable definitions.

Type:

Dict[str, List[str]]

aux_def#

Auxiliary variable definitions.

Type:

Dict[str, List[str]]

uncertainty_vars#

List of uncertainty variable names.

Type:

List[str]

aux_def: Dict[str, List[str]] = {'all': ['acquisition_time', 'series_id', 'viewing_zenith_angle', 'viewing_azimuth_angle', 'solar_zenith_angle', 'solar_azimuth_angle', 'n_valid_scans', 'n_valid_scans_SWIR', 'bandwidth', 'std_radiance', 'acceleration_x_mean', 'acceleration_y_mean', 'acceleration_z_mean', 'acceleration_x_std', 'acceleration_y_std', 'acceleration_z_std'], 'basic': ['acquisition_time', 'series_id', 'viewing_zenith_angle', 'viewing_azimuth_angle', 'solar_zenith_angle', 'solar_azimuth_angle', 'bandwidth']}#
meas_def: Dict[str, List[str]] = {'all': ['irradiance']}#
uncertainty_vars: List[str] = ['u_rel_random_irradiance', 'u_rel_systematic_corr_rad_irr_irradiance', 'u_rel_systematic_indep_irradiance', 'err_corr_systematic_corr_rad_irr_irradiance', 'err_corr_systematic_indep_irradiance']#
class eoio.readers.hypernets.reader.HYPERNETSL1RadReader(path, vars_sel=None, subset=None, read_params=None)[source]#

Bases: HYPERNETSReader

Reader for HYPERNETS Level 1 Radiance products.

meas_def#

Measurement variable definitions.

Type:

Dict[str, List[str]]

aux_def#

Auxiliary variable definitions.

Type:

Dict[str, List[str]]

uncertainty_vars#

List of uncertainty variable names.

Type:

List[str]

aux_def: Dict[str, List[str]] = {'all': ['acquisition_time', 'series_id', 'viewing_zenith_angle', 'viewing_azimuth_angle', 'solar_zenith_angle', 'solar_azimuth_angle', 'n_valid_scans', 'n_valid_scans_SWIR', 'bandwidth', 'std_radiance', 'acceleration_x_mean', 'acceleration_y_mean', 'acceleration_z_mean', 'acceleration_x_std', 'acceleration_y_std', 'acceleration_z_std'], 'basic': ['acquisition_time', 'series_id', 'viewing_zenith_angle', 'viewing_azimuth_angle', 'solar_zenith_angle', 'solar_azimuth_angle', 'bandwidth']}#
meas_def: Dict[str, List[str]] = {'all': ['radiance']}#
uncertainty_vars: List[str] = ['u_rel_random_radiance', 'u_rel_systematic_corr_rad_irr_radiance', 'u_rel_systematic_indep_radiance', 'err_corr_systematic_corr_rad_irr_radiance', 'err_corr_systematic_indep_radiance']#
class eoio.readers.hypernets.reader.HYPERNETSL2RefReader(path, vars_sel=None, subset=None, read_params=None)[source]#

Bases: HYPERNETSReader

Reader for HYPERNETS Level 2 Reflectance products.

meas_def#

Measurement variable definitions.

Type:

Dict[str, List[str]]

aux_def#

Auxiliary variable definitions.

Type:

Dict[str, List[str]]

mask_def#

Mask definitions.

Type:

Dict[str, List[str]]

uncertainty_vars#

List of uncertainty variable names.

Type:

List[str]

aux_def: Dict[str, List[str]] = {'all': ['acquisition_time', 'series_id', 'viewing_zenith_angle', 'viewing_azimuth_angle', 'solar_zenith_angle', 'solar_azimuth_angle', 'n_valid_scans', 'n_valid_scans_SWIR', 'bandwidth', 'std_reflectance'], 'basic': ['acquisition_time', 'series_id', 'viewing_zenith_angle', 'viewing_azimuth_angle', 'solar_zenith_angle', 'solar_azimuth_angle', 'bandwidth']}#
mask_def: Dict[str, List[str]] = {'all': ['quality_flag']}#
meas_def: Dict[str, List[str]] = {'all': ['reflectance']}#
uncertainty_vars: List[str] = ['u_rel_random_reflectance', 'u_rel_systematic_reflectance', 'err_corr_systematic_reflectance']#
class eoio.readers.hypernets.reader.HYPERNETSReader(path, vars_sel=None, subset=None, read_params=None)[source]#

Bases: NetCDFReader

Reader for HYPERNETS data.

default_vars_sel#

Default variable selection options.

default_subset#

Default subsetting options.

Type:

Dict[str, Any]

default_read_params#

Default reading parameters.

Type:

Dict[str, Any]

all_read_params = {'include_uncertainties': 'True/False', 'metadata_level': 'all/basic/original/None', 'save_extracted': 'True/False'}#
all_subset: Dict[str, Any] = {'angle': {'raa': ['min', 'max', 'nearest', 'tolerance'], 'saa': ['min', 'max', 'nearest', 'tolerance'], 'sza': ['min', 'max', 'nearest', 'tolerance'], 'vaa': ['min', 'max', 'nearest', 'tolerance'], 'vza': ['min', 'max', 'nearest', 'tolerance']}, 'datetime': ['min', 'max', 'nearest', 'tolerance_days', 'tolerance_hours', 'tolerance_minutes'], 'mask': [True, False, 'name of quality flag (see https://hypernets-processor.readthedocs.io/en/latest/content/atbd/products/flags.html)'], 'time_of_day_utc': ['min', 'max', 'nearest', 'tolerance_hours', 'tolerance_minutes'], 'wavelength': ['min', 'max', 'nearest', 'tolerance']}#
default_read_params: Dict[str, Any] = {'include_uncertainties': True, 'metadata_level': 'all', 'save_extracted': 'True'}#
default_subset: Dict[str, Any] = {'angle': {'raa': {'max': 360, 'min': 0}, 'saa': {'max': 360, 'min': 0}, 'sza': {'max': 90, 'min': 0}, 'vaa': {'max': 360, 'min': 0}, 'vza': {'max': 90, 'min': 0}}, 'datetime': None, 'mask': None, 'time_of_day_utc': None, 'wavelength': {'max': 1700, 'min': 380}}#
default_vars_sel = {'aux': 'all', 'mask': 'all', 'meas': 'all'}#
open_dataset() → Dataset[source]#

Open the HYPERNETS dataset as an xarray.Dataset according to the request parameters.

Returns:

The opened and subsetted HYPERNETS dataset.

uncertainty_vars: List[str] = []#