def thermal_shape(self) -> Optional[List[int]]:
"""Shape for thermal bands (Bands 10–11).
None if thermal bands not present.
Used for proj:shape. In [row, col] order"""
rows = map_opt(
int, self._root.find_text("PROJECTION_ATTRIBUTES/THERMAL_LINES"))
cols = map_opt(
int, self._root.find_text("PROJECTION_ATTRIBUTES/THERMAL_SAMPLES"))
if rows is not None and cols is not None:
return [rows, cols]
else:
return None
def proj_bbox(self) -> List[float]:
"""The bbox of the image in the CRS of the image data"""
nrows, ncols = self.resolution_to_shape[10]
geoposition = self._geocoding_node.find('Geoposition')
if geoposition is None:
raise GranuleMetadataError(
f'Cannot find geoposition node in {self.href}')
ulx = map_opt(float, geoposition.find_text('ULX'))
if ulx is None:
raise GranuleMetadataError('Could not get upper left X coordinate')
uly = map_opt(float, geoposition.find_text('ULY'))
if uly is None:
raise GranuleMetadataError('Could not get upper left Y coordinate')
return [ulx, uly - (10 * nrows), ulx + (10 * ncols), uly]
def metadata_dict(self) -> Dict[str, Any]:
result = {
's2:product_uri':
self.product_id,
's2:generation_time':
self.product_info_node.find_text('GENERATION_TIME'),
's2:processing_baseline':
self.product_info_node.find_text('PROCESSING_BASELINE'),
's2:product_type':
self.product_info_node.find_text('PRODUCT_TYPE'),
's2:datatake_id':
self.datatake_node.get_attr('datatakeIdentifier'),
's2:datatake_type':
self.datatake_node.find_text('DATATAKE_TYPE'),
's2:datastrip_id':
self.granule_node.get_attr('datastripIdentifier'),
's2:granule_id':
self.granule_node.get_attr('granuleIdentifier'),
's2:mgrs_tile':
self.mgrs_tile,
's2:reflectance_conversion_factor':
map_opt(float, self.reflectance_conversion_node.find_text('U'))
}
return {k: v for k, v in result.items() if v is not None}
def __init__(self,
href,
read_href_modifier: Optional[ReadHrefModifier] = None):
self.href = href
self._root = XmlElement.from_file(href, read_href_modifier)
geocoding_node = self._root.find('n1:Geometric_Info/Tile_Geocoding')
if geocoding_node is None:
raise GranuleMetadataError(
f"Cannot find geocoding node in {self.href}")
self._geocoding_node = geocoding_node
tile_angles_node = self._root.find('n1:Geometric_Info/Tile_Angles')
if tile_angles_node is None:
raise GranuleMetadataError(
f"Cannot find tile angles node in {self.href}")
self._tile_angles_node = tile_angles_node
self._viewing_angle_nodes = self._tile_angles_node.findall(
'Mean_Viewing_Incidence_Angle_List/Mean_Viewing_Incidence_Angle')
self._image_content_node = self._root.find(
'n1:Quality_Indicators_Info/Image_Content_QI')
self.resolution_to_shape: Dict[int, Tuple[int, int]] = {}
for size_node in self._geocoding_node.findall("Size"):
res = size_node.get_attr("resolution")
if res is None:
raise GranuleMetadataError(
'Size element does not have resolution.')
nrows = map_opt(int, size_node.find_text('NROWS'))
if nrows is None:
raise GranuleMetadataError(
f'Could not get rows from size for resolution {res}')
ncols = map_opt(int, size_node.find_text('NCOLS'))
if ncols is None:
raise GranuleMetadataError(
f'Could not get columns from size for resolution {res}')
self.resolution_to_shape[int(res)] = (nrows, ncols)
def mean_solar_azimuth(self) -> Optional[float]:
return map_opt(
float,
self._tile_angles_node.find_text('Mean_Sun_Angle/AZIMUTH_ANGLE'))
def cloudiness_percentage(self) -> Optional[float]:
return map_opt(
float,
self._image_content_node.find_text('CLOUDY_PIXEL_PERCENTAGE'))
def metadata_dict(self):
image_content_properties = {
's2:degraded_msi_data_percentage':
map_opt(
float,
self._image_content_node.find_text(
'DEGRADED_MSI_DATA_PERCENTAGE')),
's2:nodata_pixel_percentage':
map_opt(
float,
self._image_content_node.find_text('NODATA_PIXEL_PERCENTAGE')),
's2:saturated_defective_pixel_percentage':
map_opt(
float,
self._image_content_node.find_text(
'SATURATED_DEFECTIVE_PIXEL_PERCENTAGE')),
's2:dark_features_percentage':
map_opt(
float,
self._image_content_node.find_text(
'DARK_FEATURES_PERCENTAGE')),
's2:cloud_shadow_percentage':
map_opt(
float,
self._image_content_node.find_text('CLOUD_SHADOW_PERCENTAGE')),
's2:vegetation_percentage':
map_opt(
float,
self._image_content_node.find_text('VEGETATION_PERCENTAGE')),
's2:not_vegetated_percentage':
map_opt(
float,
self._image_content_node.find_text(
'NOT_VEGETATED_PERCENTAGE')),
's2:water_percentage':
map_opt(float,
self._image_content_node.find_text('WATER_PERCENTAGE')),
's2:unclassified_percentage':
map_opt(
float,
self._image_content_node.find_text('UNCLASSIFIED_PERCENTAGE')),
's2:medium_proba_clouds_percentage':
map_opt(
float,
self._image_content_node.find_text(
'MEDIUM_PROBA_CLOUDS_PERCENTAGE')),
's2:high_proba_clouds_percentage':
map_opt(
float,
self._image_content_node.find_text(
'HIGH_PROBA_CLOUDS_PERCENTAGE')),
's2:thin_sirrus_percentage':
map_opt(
float,
self._image_content_node.find_text('THIN_CIRRUS_PERCENTAGE')),
's2:snow_ice_percentage':
map_opt(float,
self._image_content_node.find_text('SNOW_ICE_PERCENTAGE'))
}
result = {
**image_content_properties,
's2:mean_solar_zenith': self.mean_solar_zenith,
's2:mean_solar_azimuth': self.mean_solar_azimuth,
}
return {k: v for k, v in result.items() if v is not None}
def updated(self) -> Optional[datetime]:
return map_opt(str_to_datetime,
self.root.find_text('GranuleURMetaData/LastUpdate'))
def created(self) -> Optional[datetime]:
return map_opt(str_to_datetime,
self.root.find_text('GranuleURMetaData/InsertTime'))
def relative_orbit(self) -> Optional[int]:
return map_opt(int,
self.datatake_node.find_text('SENSING_ORBIT_NUMBER'))
def thermal_gsd(self) -> Optional[float]:
return map_opt(
float,
self._root.find_text(
'LEVEL1_PROJECTION_PARAMETERS/GRID_CELL_SIZE_THERMAL'))
def thermal_transform(self) -> Optional[List[float]]:
return map_opt(
lambda shape: transform_from_bbox(self.proj_bbox, shape),
self.thermal_shape)
