Brdf Topo¶

Module: spectralbridge.brdf_topo.

BRDF and topographic correction helpers for the streamlined pipeline.

API glossary · Workflow / scientific context

Signatures and documentation below are collected from the current source. Advanced objects are not newly declared stable by inclusion here.

Audience: advanced.

build_correction_parameters_dict ¶

build_correction_parameters_dict(*, h5_path: Path, raw_img_path: Path, raw_hdr_path: Path, base_folder: Path, use_ndvi_brdf_bins: bool = False, flight_stem: str | None = None, product_code: str | None = None, sample_slice: slice | tuple[int, int] | None = None, line_slice: slice | tuple[int, int] | None = None) -> dict

Compute the correction parameter payload without writing it to disk.

Audience: advanced.

build_and_write_correction_json ¶

build_and_write_correction_json(h5_path: Path, raw_img_path: Path, raw_hdr_path: Path, out_dir: Path, use_ndvi_brdf_bins: bool = False) -> Path

Persist BRDF/topographic correction parameters for a flightline.

Audience: advanced.

apply_brdf_topo_core ¶

apply_brdf_topo_core(*, raw_img_path: Path, raw_hdr_path: Path, params: dict, out_img_path: Path, out_hdr_path: Path, use_ndvi_brdf_bins: bool = False, topo_fit_mode: str | TopoFitMode = _DEFAULT_TOPO_FIT_MODE, interactive_mode: bool = True, log_every: int = 25) -> None

Run the BRDF+topographic correction using params into out_* paths.

Parameters:

Name	Type	Description	Default
`topo_fit_mode`	`('scene', 'tile')`	Controls how topographic correction is fit before application. `"scene"` fits the SCS+C regression once over the full flightline footprint (HyTools-style), then applies in memory-safe row strips. `"tile"` fits independently inside each 100x100 spatial tile.	`"scene"`

Audience: advanced.

apply_brdf_topo_correction ¶

apply_brdf_topo_correction(*, raw_img_path: Path, raw_hdr_path: Path, correction_json_path: Path, out_dir: Path, use_ndvi_brdf_bins: bool = False, topo_fit_mode: str | TopoFitMode = _DEFAULT_TOPO_FIT_MODE, interactive_mode: bool = True, log_every: int = 25) -> Tuple[Path, Path]

Apply BRDF + topographic correction using precomputed parameters.

Explicitly exported constants and type aliases¶

These values describe package metadata, schemas or configuration; they are not observations from a production dataset.

Name	Source expression
`TopoFitMode`	`Literal['scene', 'tile']`