- Home
- Documentation
- API reference
API reference¶
The reference covers every local Python module, including public interfaces, lower-level functions, classes, and implementation helpers. Prefer documented package exports for application code. Source-derived does not mean scientifically validated.
Current snapshot: hyperproc 0.1.2, 54 modules, 465 top-level functions/classes, and 68 public class methods/properties. Every build refreshes signatures, defaults, docstrings, source, and exported-name mappings.
Where to begin¶
| Task | Main namespace |
|---|---|
| Open, inspect, export, mask, or analyze | hyperproc |
| Find granules, check credentials, download, or draw a search map | hyperproc.archive |
| Airborne topographic/FlexBRDF or satellite NBAR | hyperproc.correct |
| Atmospheric retrieval orchestration | hyperproc.atmos |
| Spectral transforms and resampling | hyperproc.spectral |
Module index¶
Core¶
hyperprochyperproc._ncrchyperproc.alignhyperproc.featureshyperproc.geometryhyperproc.gridhyperproc.iohyperproc.qualityhyperproc.registryhyperproc.report
Archive¶
hyperproc.archivehyperproc.archive.apihyperproc.archive.cmrhyperproc.archive.collectionshyperproc.archive.dlrhyperproc.archive.interactivehyperproc.archive.neonhyperproc.archive.results
Readers¶
hyperproc.readershyperproc.readers._commonhyperproc.readers.avirishyperproc.readers.desishyperproc.readers.emithyperproc.readers.enmaphyperproc.readers.neonhyperproc.readers.pacehyperproc.readers.prismahyperproc.readers.tanager
Corrections¶
hyperproc.correcthyperproc.correct.brdfhyperproc.correct.cfactorhyperproc.correct.coefficientshyperproc.correct.kernelshyperproc.correct.maskshyperproc.correct.mcd43hyperproc.correct.pipelinehyperproc.correct.topo
Spectral¶
hyperproc.spectralhyperproc.spectral._smoothsplinehyperproc.spectral.bandshyperproc.spectral.continuumhyperproc.spectral.derivativeshyperproc.spectral.resamplinghyperproc.spectral.smoothinghyperproc.spectral.srf
Atmosphere¶
hyperproc.atmoshyperproc.atmos._runnerhyperproc.atmos.aerosolshyperproc.atmos.correcthyperproc.atmos.demhyperproc.atmos.engineshyperproc.atmos.inputshyperproc.atmos.processhyperproc.atmos.setup
Documentation gaps¶
Functions with no docstring are still listed with their signature and source. Their prose explanation is under construction; parameter meaning is not invented. Imported third-party APIs are not duplicated here.