rtm_wrapper.engines.sixs#

Engine for the 6S radiative transfer model.

Package Contents#

Classes#

PySixSEngine

Engine for running 6S using Py6S.

Functions#

pysixs_default_inputs(→ rtm_wrapper.simulation.Inputs)

Return input parameters that replicate Py6S's defaults.

pysixs_standard_inputs(→ rtm_wrapper.simulation.Inputs)

Return modified version of Py6S' default input parameters.
class PySixSEngine(wrapper: Py6S.SixS | None = None, *, outputs: collections.abc.Iterable[rtm_wrapper.engines.base.OutputName] | None = None)[source]#

Bases: rtm_wrapper.engines.base.RTMEngine

Engine for running 6S using Py6S.

Use with pysixs_default_inputs() as the Inputs to replicate the out-of-box behavior of Py6S.

Parameters:

  • wrapper (Py6S.SixS | None) –

  • outputs (collections.abc.Iterable[rtm_wrapper.engines.base.OutputName] | None) –

run_simulation(inputs: rtm_wrapper.simulation.Inputs) → rtm_wrapper.engines.base.EngineOutputs[source]#

Run this RTM module using the given inputs.

Parameters:

inputs (rtm_wrapper.simulation.Inputs) – Input parameter tree.

Return type:

rtm_wrapper.engines.base.EngineOutputs

pysixs_default_inputs() → rtm_wrapper.simulation.Inputs[source]#

Return input parameters that replicate Py6S’s defaults.

Return type:

rtm_wrapper.simulation.Inputs

pysixs_standard_inputs() → rtm_wrapper.simulation.Inputs[source]#

Return modified version of Py6S’ default input parameters.

Sets the default sensor altitude to satellite level.

Return type:

rtm_wrapper.simulation.Inputs