hyperproc.correct

Source-derived reference

Generated from the current hyperproc 0.1.2 checkout.

Implementation: hyperproc/correct/__init__.py. Signatures, defaults, docstrings, and expandable source are extracted statically; the module is not imported or executed. Names beginning with _ are implementation details, not a stable public API.

Use the function signature as the authority for individual parameter defaults and return annotations. Original docstrings sometimes group parameter names or wrap return descriptions across lines; these descriptions are preserved rather than inferred or rewritten.

Exported entry points

Importable name	Definition
hyperproc.correct.brdf	Module
hyperproc.correct.cfactor	Module
hyperproc.correct.coefficients	Module
hyperproc.correct.masks	Module
hyperproc.correct.mcd43	Module
hyperproc.correct.pipeline	Module
hyperproc.correct.topo	Module
hyperproc.correct.angles_of	hyperproc.correct.cfactor.angles_of
hyperproc.correct.band_map	hyperproc.correct.cfactor.band_map
hyperproc.correct.band_weights	hyperproc.correct.cfactor.band_weights
hyperproc.correct.c_factor	hyperproc.correct.cfactor.c_factor
hyperproc.correct.lonlat_of	hyperproc.correct.cfactor.lonlat_of
hyperproc.correct.model_agreement	hyperproc.correct.cfactor.model_agreement
hyperproc.correct.model_reflectance	hyperproc.correct.cfactor.model_reflectance
hyperproc.correct.nbar	hyperproc.correct.cfactor.nbar
hyperproc.correct.view_profile	hyperproc.correct.cfactor.view_profile
hyperproc.correct.BRDFCoefficients	hyperproc.correct.coefficients.BRDFCoefficients
hyperproc.correct.TopoCoefficients	hyperproc.correct.coefficients.TopoCoefficients
hyperproc.correct.load	hyperproc.correct.coefficients.load
hyperproc.correct.angular_diversity	hyperproc.correct.pipeline.angular_diversity
hyperproc.correct.apply	hyperproc.correct.pipeline.apply
hyperproc.correct.export	hyperproc.correct.pipeline.export
hyperproc.correct.find_overlapping_pair	hyperproc.correct.pipeline.find_overlapping_pair
hyperproc.correct.fit_brdf	hyperproc.correct.pipeline.fit_brdf
hyperproc.correct.fit_topo	hyperproc.correct.pipeline.fit_topo
hyperproc.correct.footprint_bounds	hyperproc.correct.pipeline.footprint_bounds
hyperproc.correct.footprint_overlap	hyperproc.correct.pipeline.footprint_overlap
hyperproc.correct.footprint_polygon	hyperproc.correct.pipeline.footprint_polygon
hyperproc.correct.is_airborne	hyperproc.correct.pipeline.is_airborne
hyperproc.correct.merge_samples	hyperproc.correct.pipeline.merge_samples
hyperproc.correct.mosaic_geotiffs	hyperproc.correct.pipeline.mosaic_geotiffs
hyperproc.correct.overlap_agreement	hyperproc.correct.pipeline.overlap_agreement
hyperproc.correct.overlap_agreement_tifs	hyperproc.correct.pipeline.overlap_agreement_tifs
hyperproc.correct.overlap_windows	hyperproc.correct.pipeline.overlap_windows
hyperproc.correct.per_block_effects	hyperproc.correct.pipeline.per_block_effects
hyperproc.correct.sample_image	hyperproc.correct.pipeline.sample_image
hyperproc.correct.seam_check	hyperproc.correct.pipeline.seam_check
hyperproc.correct.view_dependence	hyperproc.correct.pipeline.view_dependence
hyperproc.correct.GEOMETRIC_KERNELS	hyperproc.correct.kernels.GEOMETRIC_KERNELS
hyperproc.correct.VOLUME_KERNELS	hyperproc.correct.kernels.VOLUME_KERNELS
hyperproc.correct.geometric_kernel	hyperproc.correct.kernels.geometric_kernel
hyperproc.correct.kernel_pair	hyperproc.correct.kernels.kernel_pair
hyperproc.correct.phase_angle	hyperproc.correct.kernels.phase_angle
hyperproc.correct.reference_kernels	hyperproc.correct.kernels.reference_kernels
hyperproc.correct.volume_kernel	hyperproc.correct.kernels.volume_kernel

Docstring evidence boundary

Original docstrings may contain historical validation claims or simplified scientific explanations. Their presence is not independent verification. Consult the maintained workflow guides and validation page before reusing such claims.

Topographic and BRDF correction for the cubes the readers return.

The math lives in small, separately testable modules:

• :mod:hyperproc.correct.kernels - Ross and Li BRDF kernels.
• :mod:hyperproc.correct.topo - cosine, C, SCS and SCS+C corrections and the illumination-dependence diagnostic that decides whether to apply one.
• :mod:hyperproc.correct.brdf - FlexBRDF: per-NDVI-bin kernel fits pooled across a group of images, applied as a nadir normalisation.
• :mod:hyperproc.correct.mcd43 - MODIS MCD43A1 BRDF model parameters, fetched for a scene's footprint and date.
• :mod:hyperproc.correct.cfactor - the c-factor normalisation for satellite scenes, which borrow their BRDF shape from MODIS because one overpass cannot measure it.
• :mod:hyperproc.correct.masks - the pixel masks the fits are drawn from.
• :mod:hyperproc.correct.coefficients - wavelength-keyed coefficient files with fit diagnostics and provenance.
• :mod:hyperproc.correct.pipeline - sample -> fit -> apply -> export on real airborne cubes (NEON, AVIRIS), with the gates that decide whether a correction is warranted. A satellite scene has no angular spread to fit, so it goes through :mod:~hyperproc.correct.cfactor instead.

Everything here is written from the primary literature and checked against synthetic data with known answers (tests/test_correct_*.py) and against an independent implementation on real NEON flightlines.