eoio.readers.landsat.layout module

eoio.readers.landsat.layout - Helper for Landsat product layout parsing.

class eoio.readers.landsat.layout.LandsatLayout(path: str)

Bases: object

Layout helper for Landsat products (e.g. Landsat 8 OLI/TIRS L1/L2).

Responsible for filesystem/path logic. No heavy dependencies.

available_band_tokens() → Set[str]

Return the unique set of available band tokens based on the product files, e.g.: {‘B1’, ‘B2’, ‘B3’, …’B11’}

Returns:

Set of available band tokens.

default_meas_vars() → List[str]

Return the default measurement variables for Landsat to read if user does not specify.

Returns:

List of default measurement variables inferred from filenames.

get_angle_files() → Dict[str, str]

Return a dictionary of angle file paths for illumination and viewing angles.

Matches both uppercase (.TIF) and lowercase (.tif) extensions so the method works on case-sensitive filesystems (e.g. OneDrive on macOS/Linux).

Returns:

Dict of angle file paths.

Raises:

LandsatLayoutError – If any expected angle file is missing.

path: str

property product_dir: Path

product_metadata_json() → Path | None

Return the product metadata JSON file for the Landsat product (STAC preferred), or None if the product doesn’t have one.

Missing rather than raising: every value this file supplies (per-band GSD/central wavelength, EPSG, proj:shape/proj:transform) has an equivalent source elsewhere – MTL.xml’s own GRID_CELL_SIZE_* fields, fixed OLI/TIRS instrument-spec band centres, and the product’s own GeoTIFF band files’ raster metadata respectively – see eoio.readers.landsat.metadata.ls_mtd_fallback, which eoio.readers.landsat.metadata.extractor.LSMetadataExtractor falls back to when this returns None. In practice this file is usually genuinely present in a USGS Collection 2 Level-1 delivery; its absence more often means an interrupted local extraction left some archive members missing (see eoio.utils.read_utils._extraction_is_complete(), which now detects and heals that) than a real product-format difference.

Returns:

Path to the product metadata JSON file, or None if not found.

product_metadata_xml() → Path | None

Return the product metadata XML file for the Landsat product.

Returns:

Path to the product metadata XML file, if it exists.

tif_band_files(meas_vars=None) → dict

Return a mapping of band name to TIFF file path for the requested bands.

Uses exact stem-suffix matching (stem.endswith("_<band>")), so B1 never accidentally matches B10 or B11.

Returns:

Dict of {band_name: file_path}.

exception eoio.readers.landsat.layout.LandsatLayoutError

Bases: ValueError

Raised when a Landsat layout is missing expected files/structure.