- Home
- Documentation
- API reference
- Atmosphere
- hyperproc.atmos
hyperproc.atmos¶
Source-derived reference
Generated from the current hyperproc 0.1.2 checkout.
Implementation: hyperproc/atmos/__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.atmos.check |
hyperproc.atmos.setup.check |
hyperproc.atmos.setup |
hyperproc.atmos.setup.setup |
hyperproc.atmos.SENSORS |
hyperproc.atmos.inputs.SENSORS |
hyperproc.atmos.Inputs |
hyperproc.atmos.inputs.Inputs |
hyperproc.atmos.names_for |
hyperproc.atmos.inputs.names_for |
hyperproc.atmos.prepare_inputs |
hyperproc.atmos.inputs.prepare_inputs |
hyperproc.atmos.ATMOSPHERES |
hyperproc.atmos.correct.ATMOSPHERES |
hyperproc.atmos.ENGINES |
hyperproc.atmos.correct.ENGINES |
hyperproc.atmos.atmosphere_for |
hyperproc.atmos.correct.atmosphere_for |
hyperproc.atmos.build_command |
hyperproc.atmos.correct.build_command |
hyperproc.atmos.correct |
hyperproc.atmos.correct.correct |
hyperproc.atmos.read_outputs |
hyperproc.atmos.correct.read_outputs |
hyperproc.atmos.run_isofit |
hyperproc.atmos.correct.run_isofit |
hyperproc.atmos.process |
hyperproc.atmos.process.process |
hyperproc.atmos.to_map_grid |
hyperproc.atmos.process.to_map_grid |
hyperproc.atmos.dem |
Module |
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.
Atmospheric correction through ISOFIT.
hyperproc.atmos turns any hyperproc L1B radiance dataset into the inputs
ISOFIT needs, runs ISOFIT's apply_oe with a chosen look-up-table engine
("sRTMnet", "6s" or "LibRadTran") and reads the surface
reflectance back as a hyperproc dataset, so the result flows straight into
:mod:hyperproc.correct and :func:hyperproc.to_geotiff.
Step by step::
import hyperproc as hp
from hyperproc.atmos import check, prepare_inputs, build_command, correct, read_outputs
check() # ISOFIT, engines and assets in place?
ds = hp.open("EMIT_L1B_RAD_....nc", ortho=False)
inputs = prepare_inputs(ds, "work/emit") # _rdn/_loc/_obs under work/emit/input
build_command(inputs, workers=24) # the apply_oe command that will run
rfl = correct(ds, "work/emit", workers=24) # runs it, returns the L2A dataset
rfl6 = correct(ds, "work/emit_6s", engine="6s", aerosol_model="maritime") # same pipeline, 6S table
rfl = read_outputs("work/emit", template=ds) # later, without rerunning
process("EMIT_L1B_RAD_....nc", "products/") # all of the above + GLT ortho -> <stem>_ac.tif
ISOFIT is an optional dependency (pip install hyperproc[atmos]) and needs
radiative-transfer engines and data assets that no wheel can carry: run
hyperproc-atmos-setup (or :func:hyperproc.atmos.setup.setup) once per
machine, and :func:hyperproc.atmos.setup.check any time to see what is in
place.