def get_band_paths(self,
band_list: list,
resolution: float = None) -> dict:
"""
Return the paths of required bands.
.. code-block:: python
>>> from eoreader.reader import Reader
>>> from eoreader.bands.alias import *
>>> path = r"S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip"
>>> prod = Reader().open(path)
>>> prod.get_band_paths([GREEN, RED])
{
<OpticalBandNames.GREEN: 'GREEN'>: 'zip+file://S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip!/S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE/GRANULE/L1C_T30TTK_A027018_20200824T111345/IMG_DATA/T30TTK_20200824T110631_B03.jp2',
<OpticalBandNames.RED: 'RED'>: 'zip+file://S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE.zip!/S2A_MSIL1C_20200824T110631_N0209_R137_T30TTK_20200824T150432.SAFE/GRANULE/L1C_T30TTK_A027018_20200824T111345/IMG_DATA/T30TTK_20200824T110631_B04.jp2'
}
Args:
band_list (list): List of the wanted bands
resolution (float): Band resolution
Returns:
dict: Dictionary containing the path of each queried band
"""
band_folders = self._get_res_band_folder(band_list, resolution)
band_paths = {}
for band in band_list:
try:
if self.is_archived:
band_paths[band] = files.get_archived_rio_path(
self.path,
f".*{band_folders[band]}.*_B{self.band_names[band]}.*.jp2",
)
else:
band_paths[band] = files.get_file_in_dir(
band_folders[band],
"_B" + self.band_names[band],
extension="jp2",
)
except (FileNotFoundError, IndexError) as ex:
raise InvalidProductError(
f"Non existing {band} ({self.band_names[band]}) band for {self.path}"
) from ex
return band_paths
def get_band_paths(self, band_list: list, resolution: float = None) -> dict:
"""
Return the paths of required bands.
.. code-block:: python
>>> from eoreader.reader import Reader
>>> from eoreader.bands.alias import *
>>> path = r"SENTINEL2A_20190625-105728-756_L2A_T31UEQ_C_V2-2"
>>> prod = Reader().open(path)
>>> prod.get_band_paths([GREEN, RED])
{
<OpticalBandNames.GREEN: 'GREEN'>: 'SENTINEL2A_20190625-105728-756_L2A_T31UEQ_C_V2-2\\SENTINEL2A_20190625-105728-756_L2A_T31UEQ_C_V2-2_FRE_B3.tif',
<OpticalBandNames.RED: 'RED'>: 'SENTINEL2A_20190625-105728-756_L2A_T31UEQ_C_V2-2\\SENTINEL2A_20190625-105728-756_L2A_T31UEQ_C_V2-2_FRE_B4.tif'
}
Args:
band_list (list): List of the wanted bands
resolution (float): Band resolution
Returns:
dict: Dictionary containing the path of each queried band
"""
band_paths = {}
for band in band_list:
try:
if self.is_archived:
band_paths[band] = files.get_archived_rio_path(
self.path, f".*FRE_B{self.band_names[band]}\.tif"
)
else:
band_paths[band] = files.get_file_in_dir(
self.path, f"FRE_B{self.band_names[band]}.tif"
)
except (FileNotFoundError, IndexError) as ex:
raise InvalidProductError(
f"Non existing {band} ({self.band_names[band]}) band for {self.path}"
) from ex
return band_paths
def _get_path(self, band_id: str) -> str:
"""
Get either the archived path of the normal path of a tif file
Args:
band_id (str): Band ID
Returns:
str: band path
"""
if self.is_archived:
# Because of gap_mask files that have the same name structure and exists only for L7
if self.product_type == LandsatProductType.L1_ETM:
regex = f".*RT{band_id}.*"
else:
regex = f".*{band_id}.*"
path = files.get_archived_rio_path(self.path, regex)
else:
path = files.get_file_in_dir(self.path, band_id, extension="TIF")
return path
def get_mask_path(self, mask_id: str, res_id: str) -> str:
"""
Get mask path from its id and file_id (`R1` for 10m resolution, `R2` for 20m resolution)
Accepted mask IDs:
- `DFP`: Defective pixels (do not always exist ! Will raise `InvalidProductError` if not)
- `EDG`: Nodata pixels mask
- `SAT`: Saturated pixels mask
- `MG2`: Geophysical mask (classification)
- `IAB`: Mask where water vapor and TOA pixels have been interpolated
- `CLM`: Cloud mask
Args:
mask_id (str): Mask ID
res_id (str): Resolution ID (`R1` or `R2`)
Returns:
str: Mask path
"""
assert res_id in ["R1", "R2"]
mask_regex = f"*{mask_id}_{res_id}.tif"
try:
if self.is_archived:
mask_path = files.get_archived_rio_path(
self.path, mask_regex.replace("*", ".*")
)
else:
mask_path = files.get_file_in_dir(
os.path.join(self.path, "MASKS"), mask_regex, exact_name=True
)
except (FileNotFoundError, IndexError) as ex:
raise InvalidProductError(
f"Non existing mask {mask_regex} in {self.name}"
) from ex
return mask_path